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 #include "firm_types.h"
  30 /**
  31  * A type telling where to add hidden parameters.
  32  */
  33 typedef enum add_hidden_params {
  34         ADD_HIDDEN_ALWAYS_IN_FRONT = 0,   /**< always add hidden parameters in front (default). */
  35         ADD_HIDDEN_ALWAYS_LAST     = 1,   /**< always add hidden parameters last, did not work for variadic functions. */
  36         ADD_HIDDEN_SMART           = 2    /**< add hidden parameters last for non-variadic and first for variadic functions. */
  37 } add_hidden;
  38
  39 /**
  40  * Additional flags for the lowering.
  41  */
  42 enum lowering_flags {
  43         LF_NONE              = 0, /**< no additional flags */
  44         LF_COMPOUND_PARAM    = 1, /**< lower calls with compound parameters */
  45         LF_COMPOUND_RETURN   = 2, /**< lower calls with compound returns */
  46         LF_RETURN_HIDDEN     = 4, /**< return the hidden address instead of void */
  47         LF_SMALL_CMP_IN_REGS = 8  /**< return small compound values in registers */
  48 };
  49
  50 /** Maximum number of registers that can be used to return compound values. */
  51 #define MAX_REGISTER_RET_VAL 2
  52
  53 /**
  54  * A struct containing all control parameters for
  55  * lower_compound_ret_calls().
  56  */
  57 typedef struct {
  58         int        def_ptr_alignment;   /**< Default alignment for data pointer. */
  59         unsigned   flags;               /**< A bitmask of enum lowering_flags. */
  60         add_hidden hidden_params;       /**< Where to add hidden parameters. */
  61
  62         /**
  63          * A function returning a pointer type for a given type.
  64          * If this pointer is NULL, a new pointer type is always created.
  65          */
  66         ir_type *(*find_pointer_type)(ir_type *e_type, ir_mode *mode, int alignment);
  67
  68         /**
  69          * If the LF_SMALL_CMP_IN_REGS flag is set, this function will be called
  70          * to decide, whether a compound value should be returned in registers.
  71          * This function must return the number of used registers and fill in the modes
  72          * of the registers to use. Up to MAX_REGISTER_RET_VAL registers can be used.
  73          */
  74         int (*ret_compound_in_regs)(ir_type *compound_tp, ir_mode **modes);
  75 } lower_params_t;
  76
  77 /**
  78  * Lower calls with compound parameter and return types.
  79  * This function does the following transformations:
  80  *
  81  * If LF_COMPOUND_PARAM is set:
  82  *
  83  * - Copy compound parameters to a new location on the callers
  84  *   stack and transmit the address of this new location
  85  *
  86  * If LF_COMPOUND_RETURN is set:
  87  *
  88  * - Adds a new (hidden) pointer parameter for
  89  *   any return compound type. The return type is replaced by void
  90  *   or if LOWERING_FLAGS_RETURN_HIDDEN is set by the address.
  91  *
  92  * - Use of the hidden parameters in the function code.
  93  *
  94  * - Change all calls to functions with compound return
  95  *   by providing space for the hidden parameter on the callers
  96  *   stack.
  97  *
  98  * - Replace a possible block copy after the function call.
  99  *
 100  * General:
 101  *
 102  * - Changes the types of methods and calls to the lowered ones
 103  *
 104  * - lower all method types of existing entities
 105  *
 106  * In pseudo-code, the following transformation is done:
 107  *
 108    @code
 109    struct x ret = func(a, b);
 110    @endcode
 111  *
 112  * is translated into
 113    @code
 114    struct x ret;
 115    func(&ret, a, b);
 116    @endcode
 117  *
 118  * If the function returns only one possible result, the copy-on-return
 119  * optimization is done, ie.
 120    @code
 121    struct x func(a) {
 122      struct x ret;
 123      ret.a = a;
 124      return ret;
 125    }
 126    @endcode
 127  *
 128  * is transformed into
 129  *
 130    @code
 131    void func(struct x *ret, a) {
 132      ret->a = a;
 133    }
 134    @endcode
 135  *
 136  * @param params  A structure containing the control parameter for this
 137  *                transformation.
 138  *
 139  * During the transformation, pointer types must be created or reused.
 140  * The caller can provide params->find_pointer_type for this task to
 141  * reduce the number of created pointer types.
 142  * If params->find_pointer_type is NULL, new pointer types
 143  * are always created automatically.
 144  */
 145 void lower_calls_with_compounds(const lower_params_t *params);
 146
 147 /**
 148  * A callback type for creating an intrinsic entity for a given opcode.
 149  *
 150  * @param method   the method type of the emulation function entity
 151  * @param op       the emulated ir_op
 152  * @param imode    the input mode of the emulated opcode
 153  * @param omode    the output mode of the emulated opcode
 154  * @param context  the context parameter
 155  */
 156 typedef ir_entity *(create_intrinsic_fkt)(ir_type *method, const ir_op *op,
 157                                           const ir_mode *imode, const ir_mode *omode,
 158                                           void *context);
 159
 160 /**
 161  * The lowering parameter description.
 162  */
 163 typedef struct _lwrdw_param_t {
 164         int enable;                   /**< if true lowering is enabled */
 165         int little_endian;            /**< if true should be lowered for little endian, else big endian */
 166         ir_mode *high_signed;         /**< the double word signed mode to be lowered, typically Ls */
 167         ir_mode *high_unsigned;       /**< the double word unsigned mode to be lowered, typically Lu */
 168         ir_mode *low_signed;          /**< the word signed mode to be used, typically Is */
 169         ir_mode *low_unsigned;        /**< the word unsigned mode to be used, typically Iu */
 170
 171         /** callback that creates the intrinsic entity */
 172         create_intrinsic_fkt *create_intrinsic;
 173         void *ctx;                    /**< context parameter for the creator function */
 174 } lwrdw_param_t;
 175
 176 /**
 177  * Lower all double word operations.
 178  */
 179 void lower_dw_ops(const lwrdw_param_t *param);
 180
 181 /**
 182  * Default implementation. Context is unused.
 183  */
 184 ir_entity *def_create_intrinsic_fkt(ir_type *method, const ir_op *op,
 185                                     const ir_mode *imode, const ir_mode *omode,
 186                                     void *context);
 187
 188 /**
 189  * Replaces SymConsts by a real constant if possible.
 190  * Replace Sel nodes by address computation.  Also resolves array access.
 191  * Handle bit fields by added And/Or calculations.
 192  *
 193  * @Note: There is NO lowering ob objects oriented types. This is highly compiler
 194  *        and ABI specific and should be placed directly in the compiler.
 195  */
 196 void lower_highlevel(void);
 197
 198 typedef struct lower_mode_b_config_t {
 199         /* mode that is used to transport 0/1 values */
 200         ir_mode *lowered_mode;
 201         /* preferred mode for the "set" operations (a psi that produces a 0 or 1) */
 202         ir_mode *lowered_set_mode;
 203         /* wether direct Cond -> Cmps should also be lowered */
 204         int lower_direct_cmp;
 205 } lower_mode_b_config_t;
 206
 207 /**
 208  * Lowers mode_b operations to integer arithmetic. After the lowering the only
 209  * operations with mode_b are the Projs of Cmps; the only nodes with mode_b
 210  * inputs are Cond and Psi nodes.
 211  *
 212  * Example: Psi(a < 0, 1, 0) => a >> 31
 213  *
 214  * @param irg            the firm graph to lower
 215  * @param config         configuration for mode_b lowerer
 216  */
 217 void ir_lower_mode_b(ir_graph *irg, const lower_mode_b_config_t *config);
 218
 219 /**
 220  * An intrinsic mapper function.
 221  *
 222  * @param node   the IR-node that will be mapped
 223  * @param ctx    a context
 224  *
 225  * @return  non-zero if the call was mapped
 226  */
 227 typedef int (*i_mapper_func)(ir_node *node, void *ctx);
 228
 229 enum ikind {
 230         INTRINSIC_CALL  = 0,  /**< the record represents an intrinsic call */
 231         INTRINSIC_INSTR       /**< the record represents an intrinsic instruction */
 232 };
 233
 234 /**
 235  * An intrinsic call record.
 236  */
 237 typedef struct _i_call_record {
 238         enum ikind    kind;       /**< must be INTRINSIC_CALL */
 239         ir_entity     *i_ent;     /**< the entity representing an intrinsic call */
 240         i_mapper_func i_mapper;   /**< the mapper function to call */
 241         void          *ctx;       /**< mapper context */
 242         void          *link;      /**< used in the construction algorithm, must be NULL */
 243 } i_call_record;
 244
 245 /**
 246  * An intrinsic instruction record.
 247  */
 248 typedef struct _i_instr_record {
 249         enum ikind    kind;       /**< must be INTRINSIC_INSTR */
 250         ir_op         *op;        /**< the opcode that must be mapped. */
 251         i_mapper_func i_mapper;   /**< the mapper function to call */
 252         void          *ctx;       /**< mapper context */
 253         void          *link;      /**< used in the construction algorithm, must be NULL */
 254 } i_instr_record;
 255
 256 /**
 257  * An intrinsic record.
 258  */
 259 typedef union _i_record {
 260         i_call_record  i_call;
 261         i_instr_record i_instr;
 262 } i_record;
 263
 264 /**
 265  * Go through all graphs and map calls to intrinsic functions and instructions.
 266  *
 267  * Every call or instruction is reported to its mapper function,
 268  * which is responsible for rebuilding the graph.
 269  *
 270  * current_ir_graph is always set.
 271  *
 272  * @param list             an array of intrinsic map records
 273  * @param length           the length of the array
 274  * @param part_block_used  set to true if part_block() must be using during lowering
 275  *
 276  * @return number of found intrinsics.
 277  */
 278 unsigned lower_intrinsics(i_record *list, int length, int part_block_used);
 279
 280 /**
 281  * A mapper for the integer/float absolute value: type abs(type v).
 282  * Replaces the call by a Abs node.
 283  *
 284  * @return always 1
 285  */
 286 int i_mapper_abs(ir_node *call, void *ctx);
 287
 288 /**
 289  * A mapper for the floating point sqrt(v): floattype sqrt(floattype v);
 290  *
 291  * @return 0 if the sqrt call was removed, 0 else.
 292  */
 293 int i_mapper_sqrt(ir_node *call, void *ctx);
 294
 295 /**
 296  * A mapper for the floating point cbrt(v): floattype sqrt(floattype v);
 297  *
 298  * @return 0 if the cbrt call was removed, 0 else.
 299  */
 300 int i_mapper_cbrt(ir_node *call, void *ctx);
 301
 302 /**
 303  * A mapper for the floating point pow(a, b): floattype pow(floattype a, floattype b);
 304  *
 305  * @return 0 if the pow call was removed, 0 else.
 306  */
 307 int i_mapper_pow(ir_node *call, void *ctx);
 308
 309 /**
 310  * A mapper for the floating point exp(a): floattype exp(floattype a);
 311  *
 312  * @return 0 if the exp call was removed, 0 else.
 313  */
 314 int i_mapper_exp(ir_node *call, void *ctx);
 315
 316 #define i_mapper_exp2   i_mapper_exp
 317 #define i_mapper_exp10  i_mapper_exp
 318
 319 /**
 320  * A mapper for the floating point log(a): floattype log(floattype a);
 321  *
 322  * @return 0 if the log call was removed, 0 else.
 323  */
 324 int i_mapper_log(ir_node *call, void *ctx);
 325
 326 #define i_mapper_log2   i_mapper_log
 327 #define i_mapper_log10  i_mapper_log
 328
 329 /**
 330  * A mapper for the floating point sin(a): floattype sin(floattype a);
 331  *
 332  * @return 0 if the sin call was removed, 0 else.
 333  */
 334 int i_mapper_sin(ir_node *call, void *ctx);
 335
 336 /**
 337  * A mapper for the floating point sin(a): floattype cos(floattype a);
 338  *
 339  * @return 0 if the cos call was removed, 0 else.
 340  */
 341 int i_mapper_cos(ir_node *call, void *ctx);
 342
 343 /**
 344  * A mapper for the floating point tan(a): floattype tan(floattype a);
 345  *
 346  * @return 0 if the tan call was removed, 0 else.
 347  */
 348 int i_mapper_tan(ir_node *call, void *ctx);
 349
 350 /**
 351  * A mapper for the floating point asin(a): floattype asin(floattype a);
 352  *
 353  * @return 0 if the asin call was removed, 0 else.
 354  */
 355 int i_mapper_asin(ir_node *call, void *ctx);
 356
 357 /**
 358  * A mapper for the floating point acos(a): floattype acos(floattype a);
 359  *
 360  * @return 0 if the tan call was removed, 0 else.
 361  */
 362 int i_mapper_acos(ir_node *call, void *ctx);
 363
 364 /**
 365  * A mapper for the floating point atan(a): floattype atan(floattype a);
 366  *
 367  * @return 0 if the atan call was removed, 0 else.
 368  */
 369 int i_mapper_atan(ir_node *call, void *ctx);
 370
 371 /**
 372  * A mapper for the floating point sinh(a): floattype sinh(floattype a);
 373  *
 374  * @return 0 if the sinh call was removed, 0 else.
 375  */
 376 int i_mapper_sinh(ir_node *call, void *ctx);
 377
 378 /**
 379  * A mapper for the floating point cosh(a): floattype cosh(floattype a);
 380  *
 381  * @return 0 if the cosh call was removed, 0 else.
 382  */
 383 int i_mapper_cosh(ir_node *call, void *ctx);
 384
 385 /**
 386  * A mapper for the floating point tanh(a): floattype tanh(floattype a);
 387  *
 388  * @return 0 if the tanh call was removed, 0 else.
 389  */
 390 int i_mapper_tanh(ir_node *call, void *ctx);
 391
 392 /**
 393  * A mapper for the strcmp-Function: inttype strcmp(char pointer a, char pointer b);
 394  *
 395  * @return 0 if the strcmp call was removed, 0 else.
 396  */
 397 int i_mapper_strcmp(ir_node *call, void *ctx);
 398
 399 /**
 400  * A mapper for the strcmp-Function: inttype strncmp(char pointer a, char pointer b, inttype len);
 401  *
 402  * @return 0 if the strncmp call was removed, 0 else.
 403  */
 404 int i_mapper_strncmp(ir_node *call, void *ctx);
 405
 406 /**
 407  * A mapper for the memcpy-Function: void pointer memcpy(void pointer d, void pointer s, inttype c);
 408  *
 409  * @return 0 if the memcpy call was removed, 0 else.
 410  */
 411 int i_mapper_memcpy(ir_node *call, void *ctx);
 412
 413 /**
 414  * A mapper for the memset-Function: void pointer memset(void pointer d, inttype C, inttype len);
 415  *
 416  * @return 0 if the memset call was removed, 0 else.
 417  */
 418 int i_mapper_memset(ir_node *call, void *ctx);
 419
 420 /**
 421  * A mapper for the alloca() function: pointer alloca(inttype size)
 422  * Replaces the call by a Alloca(stack_alloc) node.
 423  *
 424  * @return always 1
 425  */
 426 int i_mapper_alloca(ir_node *call, void *ctx);
 427
 428 /**
 429  * A runtime routine description.
 430  */
 431 typedef struct _runtime_rt {
 432         ir_entity *ent;            /**< The entity representing the runtime routine. */
 433         ir_mode   *mode;           /**< The operation mode of the mapped instruction. */
 434         ir_mode   *res_mode;       /**< The result mode of the mapped instruction or NULL. */
 435         long      mem_proj_nr;     /**< if >= 0, create a memory ProjM() */
 436         long      regular_proj_nr; /**< if >= 0, create a regular ProjX() */
 437         long      exc_proj_nr;     /**< if >= 0, create a exception ProjX() */
 438         long      exc_mem_proj_nr; /**< if >= 0, create a exception memory ProjM() */
 439         long      res_proj_nr;     /**< if >= 0, first result projection number */
 440 } runtime_rt;
 441
 442 /**
 443  * A mapper for mapping unsupported instructions to runtime calls.
 444  * Maps a op(arg_0, ..., arg_n) into a call to a runtime function
 445  * rt(arg_0, ..., arg_n).
 446  *
 447  * The mapping is only done, if the modes of all arguments matches the
 448  * modes of rt's argument.
 449  * Further, if op has a memory input, the generated Call uses it, else
 450  * it gets a NoMem.
 451  * The pinned state of the Call will be set to the pinned state of op.
 452  *
 453  * Note that i_mapper_RuntimeCall() must be used with a i_instr_record.
 454  *
 455  * @return 1 if an op was mapped, 0 else
 456  *
 457  * Some examples:
 458  *
 459  * - Maps signed Div nodes to calls to rt_Div():
 460    @code
 461   runtime_rt rt_Div = {
 462     ent("int rt_Div(int, int)"),
 463     mode_T,
 464     mode_Is,
 465     pn_Div_M,
 466     pn_Div_X_regular,
 467     pn_Div_X_except,
 468     pn_Div_M,
 469     pn_Div_res
 470   };
 471   i_instr_record map_Div = {
 472     INTRINSIC_INSTR,
 473     op_Div,
 474     i_mapper_RuntimeCall,
 475     &rt_Div,
 476     NULL
 477   };
 478   @endcode
 479  *
 480  * - Maps ConvD(F) to calls to rt_Float2Div():
 481   @code
 482   runtime_rt rt_Float2Double = {
 483     ent("double rt_Float2Div(float)"),
 484     get_type_mode("double"),
 485     NULL,
 486     -1,
 487     -1,
 488     -1,
 489     -1,
 490     -1
 491   };
 492   i_instr_record map_Float2Double = {
 493     INTRINSIC_INSTR,
 494     op_Conv,
 495     i_mapper_RuntimeCall,
 496     &rt_Float2Double,
 497     NULL
 498   };
 499   @endcode
 500  */
 501 int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt);
 502
 503 #endif /* FIRM_LOWERING_H */