nsz Git - libfirm/blob - ir/be/beabihelper.h

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief       Helper functions for handling ABI constraints in the code
  23  *              selection phase.
  24  * @author      Matthias Braun
  25  */
  26 #ifndef FIRM_BE_BEABI_HELPER_H
  27 #define FIRM_BE_BEABI_HELPER_H
  28
  29 #include "firm_types.h"
  30 #include "be_types.h"
  31 #include "bearch.h"
  32
  33 typedef struct beabi_helper_env_t beabi_helper_env_t;
  34 typedef struct be_stackorder_t    be_stackorder_t;
  35
  36 /**
  37  * Creates a helper object for the ABI constraint handling.
  38  */
  39 beabi_helper_env_t *be_abihelper_prepare(ir_graph *irg);
  40
  41 /**
  42  * Terminates a helper object for the ABI constraint handling.
  43  */
  44 void be_abihelper_finish(beabi_helper_env_t *env);
  45
  46 /**
  47  * Mark a registers value at the beginning of the function as significant.
  48  * This is necessary for things like:
  49  *  - Callee-Save registers (we need to restore that value at the end)
  50  *  - Parameters passed in registers
  51  *  - stack pointer, base pointer, ...
  52  * It is possible to specify additional irn flags (useful to mark a value
  53  * as ignore or produces_sp).
  54  */
  55 void be_prolog_add_reg(beabi_helper_env_t *env, const arch_register_t *reg,
  56                        arch_register_req_type_t flags);
  57
  58 /**
  59  * Creates a start node.
  60  * Must be called after all prolog_add_reg calls
  61  */
  62 ir_node *be_prolog_create_start(beabi_helper_env_t *env, dbg_info *dbgi,
  63                                 ir_node *block);
  64
  65 /**
  66  * Get "value" of a register.
  67  * This usually creates a Proj node for the start-node.
  68  * Or returns the value set by a abi_helper_set_reg_value call
  69  */
  70 ir_node *be_prolog_get_reg_value(beabi_helper_env_t *env,
  71                                  const arch_register_t *reg);
  72
  73 ir_node *be_prolog_get_memory(beabi_helper_env_t *env);
  74
  75 /**
  76  * Set current register value.
  77  */
  78 void be_prolog_set_reg_value(beabi_helper_env_t *env,
  79                              const arch_register_t *reg, ir_node *value);
  80
  81 void be_prolog_set_memory(beabi_helper_env_t *env, ir_node *value);
  82
  83 /**
  84  * Set value of register at the end of the function. Necessary for:
  85  *  - Callee-save registers
  86  *  - Return values in registers
  87  *  - stack pointer, base pointer
  88  */
  89 void be_epilog_add_reg(beabi_helper_env_t *env, const arch_register_t *reg,
  90                        arch_register_req_type_t flags, ir_node *value);
  91
  92 void be_epilog_set_reg_value(beabi_helper_env_t *env,
  93                              const arch_register_t *reg, ir_node *value);
  94
  95 ir_node *be_epilog_get_reg_value(beabi_helper_env_t *env,
  96                              const arch_register_t *reg);
  97
  98 void be_epilog_set_memory(beabi_helper_env_t *env, ir_node *value);
  99
 100 ir_node *be_epilog_get_memory(beabi_helper_env_t *env);
 101
 102 void be_epilog_begin(beabi_helper_env_t *env);
 103
 104 /**
 105  * Create return node and finishes epilog handling
 106  */
 107 ir_node *be_epilog_create_return(beabi_helper_env_t *env, dbg_info *dbgi,
 108                                  ir_node *block);
 109
 110 /**
 111  * Adds a X->Proj->Keep for each output value of X which has no Proj yet
 112  */
 113 void be_add_missing_keeps(ir_graph *irg);
 114
 115 /**
 116  * Make sure all outputs of a node are used, add keeps otherwise
 117  */
 118 void be_add_missing_keeps_node(ir_node *node);
 119
 120 /**
 121  * In the normal firm representation some nodes like pure calls, builtins
 122  * have no memory inputs+outputs. However in the backend these sometimes have to
 123  * access the stack to work and therefore suddenly need to be enqueued into the
 124  * memory edge again.
 125  * This API creates a possible order to enqueue them so we can be sure to create
 126  * a legal dependency graph when transforming them.
 127  */
 128 be_stackorder_t *be_collect_stacknodes(ir_graph *irg);
 129
 130 /**
 131  * return node that should produce the predecessor stack node in a block.
 132  * returns NULL if there's no predecessor in the current block.
 133  */
 134 ir_node *be_get_stack_pred(const be_stackorder_t *env, const ir_node *node);
 135
 136 /**
 137  * free memory associated with a stackorder structure
 138  */
 139 void be_free_stackorder(be_stackorder_t *env);
 140
 141 /**
 142  * In case where a parameter is transmitted via register but someone takes its
 143  * address a store to the frame which can be references is necessary.
 144  * This function can be used as a preprocessing phase before transformation to
 145  * do this. The assumption is that all parameter_entities which are passed
 146  * through the stack are already moved to the arg_type and all remaining
 147  * parameter_entities on the frame type need stores.
 148  */
 149 void be_add_parameter_entity_stores(ir_graph *irg);
 150
 151 #endif