nsz Git - libfirm/blob - include/libfirm/lowering.h

   1 /*
   2  * Copyright (C) 1995-2007 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   Lowering of high level constructs.
  23  * @author  Michael Beck
  24  * @version $Id$
  25  */
  26 #ifndef FIRM_LOWERING_H
  27 #define FIRM_LOWERING_H
  28
  29 /**
  30  * A type telling where to add hidden parameters.
  31  */
  32 typedef enum add_hidden_params {
  33   ADD_HIDDEN_ALWAYS_IN_FRONT = 0,   /**< always add hidden parameters in front (default). */
  34   ADD_HIDDEN_ALWAYS_LAST     = 1,   /**< always add hidden parameters last, did not work for variadic functions. */
  35   ADD_HIDDEN_SMART           = 2    /**< add hidden parameters last for non-variadic and first for variadic functions. */
  36 } add_hidden;
  37
  38 /**
  39  * Additional flags for the lowering.
  40  */
  41 enum lowering_flags {
  42   LF_NONE              = 0, /**< no additional flags */
  43   LF_COMPOUND_PARAM    = 1, /**< lower calls with compound parameters */
  44   LF_COMPOUND_RETURN   = 2, /**< lower calls with compound returns */
  45   LF_RETURN_HIDDEN     = 4, /**< return the hidden address instead of void */
  46   LF_SMALL_CMP_IN_REGS = 8  /**< return small compound values in registers */
  47 };
  48
  49 /** Maximum number of registers that can be used to return compound values. */
  50 #define MAX_REGISTER_RET_VAL 2
  51
  52 /**
  53  * A struct containing all control parameters for
  54  * lower_compound_ret_calls().
  55  */
  56 typedef struct {
  57   int        def_ptr_alignment;   /**< Default alignment for data pointer. */
  58   unsigned   flags;               /**< A bitmask of enum lowering_flags. */
  59   add_hidden hidden_params;       /**< Where to add hidden parameters. */
  60
  61   /**
  62    * A function returning a pointer type for a given type.
  63    * If this pointer is NULL, a new pointer type is always created.
  64    */
  65   ir_type *(*find_pointer_type)(ir_type *e_type, ir_mode *mode, int alignment);
  66
  67   /**
  68    * If the LF_SMALL_CMP_IN_REGS flag is set, this function will be called
  69    * to decide, whether a compound value should be returned in registers.
  70    * This function must return the number of used registers and fill in the modes
  71    * of the registers to use. Up to MAX_REGISTER_RET_VAL registers can be used.
  72    */
  73   int (*ret_compound_in_regs)(ir_type *compound_tp, ir_mode **modes);
  74 } lower_params_t;
  75
  76 /**
  77  * Lower calls with compound parameter and return types.
  78  * This function does the following transformations:
  79  *
  80  * If LF_COMPOUND_PARAM is set:
  81  *
  82  * - Copy compound parameters to a new location on the callers
  83  *   stack and transmit the address of this new location
  84  *
  85  * If LF_COMPOUND_RETURN is set:
  86  *
  87  * - Adds a new (hidden) pointer parameter for
  88  *   any return compound type. The return type is replaced by void
  89  *   or if LOWERING_FLAGS_RETURN_HIDDEN is set by the address.
  90  *
  91  * - Use of the hidden parameters in the function code.
  92  *
  93  * - Change all calls to functions with compound return
  94  *   by providing space for the hidden parameter on the callers
  95  *   stack.
  96  *
  97  * - Replace a possible block copy after the function call.
  98  *
  99  * General:
 100  *
 101  * - Changes the types of methods and calls to the lowered ones
 102  *
 103  * - lower all method types of existing entities
 104  *
 105  * In pseudo-code, the following transformation is done:
 106  *
 107    @code
 108    struct x ret = func(a, b);
 109    @endcode
 110  *
 111  * is translated into
 112    @code
 113    struct x ret;
 114    func(&ret, a, b);
 115    @endcode
 116  *
 117  * If the function returns only one possible result, the copy-on-return
 118  * optimization is done, ie.
 119    @code
 120    struct x func(a) {
 121      struct x ret;
 122      ret.a = a;
 123      return ret;
 124    }
 125    @endcode
 126  *
 127  * is transformed into
 128  *
 129    @code
 130    void func(struct x *ret, a) {
 131      ret->a = a;
 132    }
 133    @endcode
 134  *
 135  * @param params  A structure containing the control parameter for this
 136  *                transformation.
 137  *
 138  * During the transformation, pointer types must be created or reused.
 139  * The caller can provide params->find_pointer_type for this task to
 140  * reduce the number of created pointer types.
 141  * If params->find_pointer_type is NULL, new pointer types
 142  * are always created automatically.
 143  */
 144 void lower_calls_with_compounds(const lower_params_t *params);
 145
 146 /**
 147  * A callback type for creating an intrinsic entity for a given opcode.
 148  *
 149  * @param method   the method type of the emulation function entity
 150  * @param op       the emulated ir_op
 151  * @param imode    the input mode of the emulated opcode
 152  * @param omode    the output mode of the emulated opcode
 153  * @param context  the context parameter
 154  */
 155 typedef ir_entity *(create_intrinsic_fkt)(ir_type *method, const ir_op *op,
 156                                           const ir_mode *imode, const ir_mode *omode,
 157                                           void *context);
 158
 159 /**
 160  * The lowering parameter description.
 161  */
 162 typedef struct _lwrdw_param_t {
 163         int enable;                   /**< if true lowering is enabled */
 164         int little_endian;            /**< if true should be lowered for little endian, else big endian */
 165         ir_mode *high_signed;         /**< the double word signed mode to be lowered, typically Ls */
 166         ir_mode *high_unsigned;       /**< the double word unsigned mode to be lowered, typically Lu */
 167         ir_mode *low_signed;          /**< the word signed mode to be used, typically Is */
 168         ir_mode *low_unsigned;        /**< the word unsigned mode to be used, typically Iu */
 169
 170         /** callback that creates the intrinsic entity */
 171         create_intrinsic_fkt *create_intrinsic;
 172         void *ctx;                    /**< context parameter for the creator function */
 173 } lwrdw_param_t;
 174
 175 /**
 176  * Lower all double word operations.
 177  */
 178 void lower_dw_ops(const lwrdw_param_t *param);
 179
 180 /**
 181  * Default implementation. Context is unused.
 182  */
 183 ir_entity *def_create_intrinsic_fkt(ir_type *method, const ir_op *op,
 184                                     const ir_mode *imode, const ir_mode *omode,
 185                                     void *context);
 186
 187 /**
 188  * Replaces SymConsts by a real constant if possible.
 189  * Replace Sel nodes by address computation.  Also resolves array access.
 190  * Handle Bitfields by added And/Or calculations.
 191  *
 192  * @Note: There is NO lowering ob objects oriented types. This is highly compiler
 193  *        and ABI specific and should be placed directly in the compiler.
 194  */
 195 void lower_highlevel(void);
 196
 197 /**
 198  * An intrinsic mapper function.
 199  *
 200  * @param node   the IR-node that will be mapped
 201  * @param ctx    a context
 202  *
 203  * @return  non-zero if the call was mapped
 204  */
 205 typedef int (*i_mapper_func)(ir_node *node, void *ctx);
 206
 207 enum ikind {
 208         INTRINSIC_CALL  = 0,  /**< the record represents an intrinsic call */
 209         INTRINSIC_INSTR       /**< the record represents an intrinsic instruction */
 210 };
 211
 212 /**
 213  * An intrinsic call record.
 214  */
 215 typedef struct _i_call_record {
 216         enum ikind    kind;       /**< must be INTRINSIC_CALL */
 217         ir_entity     *i_ent;     /**< the entity representing an intrinsic call */
 218         i_mapper_func i_mapper;   /**< the mapper function to call */
 219         void          *ctx;       /**< mapper context */
 220         void          *link;      /**< used in the construction algorithm, must be NULL */
 221 } i_call_record;
 222
 223 /**
 224  * An intrinsic instruction record.
 225  */
 226 typedef struct _i_instr_record {
 227         enum ikind    kind;       /**< must be INTRINSIC_INSTR */
 228         ir_op         *op;        /**< the opcode that must be mapped. */
 229         i_mapper_func i_mapper;   /**< the mapper function to call */
 230         void          *ctx;       /**< mapper context */
 231         void          *link;      /**< used in the construction algorithm, must be NULL */
 232 } i_instr_record;
 233
 234 /**
 235  * An intrinsic record.
 236  */
 237 typedef union _i_record {
 238         i_call_record  i_call;
 239         i_instr_record i_instr;
 240 } i_record;
 241
 242 /**
 243  * Go through all graphs and map calls to intrinsic functions and instructions.
 244  *
 245  * Every call or instruction is reported to its mapper function,
 246  * which is responsible for rebuilding the graph.
 247  *
 248  * current_ir_graph is always set.
 249  *
 250  * @param list    an array of intrinsic map records
 251  * @param length  the length of the array
 252  *
 253  * @return number of found intrinsics.
 254  */
 255 unsigned lower_intrinsics(i_record *list, int length);
 256
 257 /**
 258  * A mapper for the integer absolute value: inttype abs(inttype v).
 259  * Replaces the call by a Abs node.
 260  *
 261  * @return always 1
 262  */
 263 int i_mapper_Abs(ir_node *call, void *ctx);
 264
 265 /**
 266  * A mapper for the alloca() function: pointer alloca(inttype size)
 267  * Replaces the call by a Alloca(stack_alloc) node.
 268  *
 269  * @return always 1
 270  */
 271 int i_mapper_Alloca(ir_node *call, void *ctx);
 272
 273 /**
 274  * A runtime routine description.
 275  */
 276 typedef struct _runtime_rt {
 277         ir_entity *ent;            /**< The entity representing the runtime routine. */
 278         ir_mode   *mode;           /**< The operation mode of the mapped instruction. */
 279         ir_mode   *res_mode;       /**< The result mode of the mapped instruction or NULL. */
 280         long      mem_proj_nr;     /**< if >= 0, create a memory ProjM() */
 281         long      regular_proj_nr; /**< if >= 0, create a regular ProjX() */
 282         long      exc_proj_nr;     /**< if >= 0, create a exception ProjX() */
 283         long      exc_mem_proj_nr; /**< if >= 0, create a exception memory ProjM() */
 284         long      res_proj_nr;     /**< if >= 0, first result projection number */
 285 } runtime_rt;
 286
 287 /**
 288  * A mapper for mapping unsupported instructions to runtime calls.
 289  * Maps a op(arg_0, ..., arg_n) into a call to a runtime function
 290  * rt(arg_0, ..., arg_n).
 291  *
 292  * The mapping is only done, if the modes of all arguments matches the
 293  * modes of rt's argument.
 294  * Further, if op has a memory input, the generated Call uses it, else
 295  * it gets a NoMem.
 296  * The pinned state of the Call will be set to the pinned state of op.
 297  *
 298  * Note that i_mapper_RuntimeCall() must be used with a i_instr_record.
 299  *
 300  * @return 1 if an op was mapped, 0 else
 301  *
 302  * Some examples:
 303  *
 304  * - Maps signed Div nodes to calls to rt_Div():
 305    @code
 306   runtime_rt rt_Div = {
 307     ent("int rt_Div(int, int)"),
 308     mode_T,
 309     mode_Is,
 310     pn_Div_M,
 311     pn_Div_X_regular,
 312     pn_Div_X_except,
 313     pn_Div_M,
 314     pn_Div_res
 315   };
 316   i_instr_record map_Div = {
 317     INTRINSIC_INSTR,
 318     op_Div,
 319     i_mapper_RuntimeCall,
 320     &rt_Div,
 321     NULL
 322   };
 323   @endcode
 324  *
 325  * - Maps ConvD(F) to calls to rt_Float2Div():
 326   @code
 327   runtime_rt rt_Float2Double = {
 328     ent("double rt_Float2Div(float)"),
 329     get_type_mode("double"),
 330     NULL,
 331     -1,
 332     -1,
 333     -1,
 334     -1,
 335     -1
 336   };
 337   i_instr_record map_Float2Double = {
 338     INTRINSIC_INSTR,
 339     op_Conv,
 340     i_mapper_RuntimeCall,
 341     &rt_Float2Double,
 342     NULL
 343   };
 344   @endcode
 345  */
 346 int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt);
 347
 348 #endif /* FIRM_LOWERING_H */