nsz Git - libfirm/blob - include/libfirm/lowering.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   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  *  * Lower CopyB nodes of size smaller that max_size into Loads/Stores
 149  */
 150 void lower_CopyB(ir_graph *irg, unsigned max_size, unsigned native_mode_bytes);
 151
 152 /**
 153  * Lowers all Switches (Cond nodes with non-boolean mode) depending on spare_size.
 154  * They will either remain the same or be converted into if-cascades.
 155  *
 156  * @param irg        The ir graph to be lowered.
 157  * @param spare_size Allowed spare size for table switches in machine words.
 158  *                   (Default in edgfe: 128)
 159  */
 160 void lower_switch(ir_graph *irg, unsigned spare_size);
 161
 162 /**
 163  * A callback type for creating an intrinsic entity for a given opcode.
 164  *
 165  * @param method   the method type of the emulation function entity
 166  * @param op       the emulated ir_op
 167  * @param imode    the input mode of the emulated opcode
 168  * @param omode    the output mode of the emulated opcode
 169  * @param context  the context parameter
 170  */
 171 typedef ir_entity *(create_intrinsic_fkt)(ir_type *method, const ir_op *op,
 172                                           const ir_mode *imode, const ir_mode *omode,
 173                                           void *context);
 174
 175 /**
 176  * The lowering parameter description.
 177  */
 178 typedef struct _lwrdw_param_t {
 179         int enable;                   /**< if true lowering is enabled */
 180         int little_endian;            /**< if true should be lowered for little endian, else big endian */
 181         ir_mode *high_signed;         /**< the double word signed mode to be lowered, typically Ls */
 182         ir_mode *high_unsigned;       /**< the double word unsigned mode to be lowered, typically Lu */
 183         ir_mode *low_signed;          /**< the word signed mode to be used, typically Is */
 184         ir_mode *low_unsigned;        /**< the word unsigned mode to be used, typically Iu */
 185
 186         /** callback that creates the intrinsic entity */
 187         create_intrinsic_fkt *create_intrinsic;
 188         void *ctx;                    /**< context parameter for the creator function */
 189 } lwrdw_param_t;
 190
 191 /**
 192  * Lower all double word operations.
 193  */
 194 void lower_dw_ops(const lwrdw_param_t *param);
 195
 196 /**
 197  * Default implementation. Context is unused.
 198  */
 199 ir_entity *def_create_intrinsic_fkt(ir_type *method, const ir_op *op,
 200                                     const ir_mode *imode, const ir_mode *omode,
 201                                     void *context);
 202
 203 /**
 204  * Replaces SymConsts by a real constant if possible.
 205  * Replace Sel nodes by address computation.  Also resolves array access.
 206  * Handle bit fields by added And/Or calculations.
 207  *
 208  * @param irg  the graph to lower
 209  *
 210  * @note: There is NO lowering ob objects oriented types. This is highly compiler
 211  *        and ABI specific and should be placed directly in the compiler.
 212  */
 213 void lower_highlevel_graph(ir_graph *irg, int lower_bitfields);
 214
 215 /**
 216  * Replaces SymConsts by a real constant if possible.
 217  * Replace Sel nodes by address computation.  Also resolves array access.
 218  * Handle bit fields by added And/Or calculations.
 219  * Lowers all graphs.
 220  *
 221  * @Note: There is NO lowering ob objects oriented types. This is highly compiler
 222  *        and ABI specific and should be placed directly in the compiler.
 223  */
 224 void lower_highlevel(int lower_bitfields);
 225
 226 /**
 227  * does the same as lower_highlevel for all nodes on the const code irg
 228  */
 229 void lower_const_code(void);
 230
 231 typedef struct lower_mode_b_config_t {
 232         /* mode that is used to transport 0/1 values */
 233         ir_mode *lowered_mode;
 234         /* preferred mode for the "set" operations (a psi that produces a 0 or 1) */
 235         ir_mode *lowered_set_mode;
 236         /* wether direct Cond -> Cmps should also be lowered */
 237         int lower_direct_cmp;
 238 } lower_mode_b_config_t;
 239
 240 /**
 241  * Lowers mode_b operations to integer arithmetic. After the lowering the only
 242  * operations with mode_b are the Projs of Cmps; the only nodes with mode_b
 243  * inputs are Cond and Psi nodes.
 244  *
 245  * Example: Psi(a < 0, 1, 0) => a >> 31
 246  *
 247  * @param irg            the firm graph to lower
 248  * @param config         configuration for mode_b lowerer
 249  */
 250 void ir_lower_mode_b(ir_graph *irg, const lower_mode_b_config_t *config);
 251
 252 /**
 253  * An intrinsic mapper function.
 254  *
 255  * @param node   the IR-node that will be mapped
 256  * @param ctx    a context
 257  *
 258  * @return  non-zero if the call was mapped
 259  */
 260 typedef int (*i_mapper_func)(ir_node *node, void *ctx);
 261
 262 enum ikind {
 263         INTRINSIC_CALL  = 0,  /**< the record represents an intrinsic call */
 264         INTRINSIC_INSTR       /**< the record represents an intrinsic instruction */
 265 };
 266
 267 /**
 268  * An intrinsic call record.
 269  */
 270 typedef struct _i_call_record {
 271         enum ikind    kind;       /**< must be INTRINSIC_CALL */
 272         ir_entity     *i_ent;     /**< the entity representing an intrinsic call */
 273         i_mapper_func i_mapper;   /**< the mapper function to call */
 274         void          *ctx;       /**< mapper context */
 275         void          *link;      /**< used in the construction algorithm, must be NULL */
 276 } i_call_record;
 277
 278 /**
 279  * An intrinsic instruction record.
 280  */
 281 typedef struct _i_instr_record {
 282         enum ikind    kind;       /**< must be INTRINSIC_INSTR */
 283         ir_op         *op;        /**< the opcode that must be mapped. */
 284         i_mapper_func i_mapper;   /**< the mapper function to call */
 285         void          *ctx;       /**< mapper context */
 286         void          *link;      /**< used in the construction algorithm, must be NULL */
 287 } i_instr_record;
 288
 289 /**
 290  * An intrinsic record.
 291  */
 292 typedef union _i_record {
 293         i_call_record  i_call;
 294         i_instr_record i_instr;
 295 } i_record;
 296
 297 /**
 298  * Go through all graphs and map calls to intrinsic functions and instructions.
 299  *
 300  * Every call or instruction is reported to its mapper function,
 301  * which is responsible for rebuilding the graph.
 302  *
 303  * current_ir_graph is always set.
 304  *
 305  * @param list             an array of intrinsic map records
 306  * @param length           the length of the array
 307  * @param part_block_used  set to true if part_block() must be using during lowering
 308  *
 309  * @return number of found intrinsics.
 310  */
 311 unsigned lower_intrinsics(i_record *list, int length, int part_block_used);
 312
 313 /**
 314  * A mapper for the integer/float absolute value: type abs(type v).
 315  * Replaces the call by a Abs node.
 316  *
 317  * @return always 1
 318  */
 319 int i_mapper_abs(ir_node *call, void *ctx);
 320
 321 /**
 322  * A mapper for the floating point sqrt(v): floattype sqrt(floattype v);
 323  *
 324  * @return 0 if the sqrt call was removed, 0 else.
 325  */
 326 int i_mapper_sqrt(ir_node *call, void *ctx);
 327
 328 /**
 329  * A mapper for the floating point cbrt(v): floattype sqrt(floattype v);
 330  *
 331  * @return 0 if the cbrt call was removed, 0 else.
 332  */
 333 int i_mapper_cbrt(ir_node *call, void *ctx);
 334
 335 /**
 336  * A mapper for the floating point pow(a, b): floattype pow(floattype a, floattype b);
 337  *
 338  * @return 0 if the pow call was removed, 0 else.
 339  */
 340 int i_mapper_pow(ir_node *call, void *ctx);
 341
 342 /**
 343  * A mapper for the floating point exp(a): floattype exp(floattype a);
 344  *
 345  * @return 0 if the exp call was removed, 0 else.
 346  */
 347 int i_mapper_exp(ir_node *call, void *ctx);
 348
 349 #define i_mapper_exp2   i_mapper_exp
 350 #define i_mapper_exp10  i_mapper_exp
 351
 352 /**
 353  * A mapper for the floating point log(a): floattype log(floattype a);
 354  *
 355  * @return 0 if the log call was removed, 0 else.
 356  */
 357 int i_mapper_log(ir_node *call, void *ctx);
 358
 359 #define i_mapper_log2   i_mapper_log
 360 #define i_mapper_log10  i_mapper_log
 361
 362 /**
 363  * A mapper for the floating point sin(a): floattype sin(floattype a);
 364  *
 365  * @return 0 if the sin call was removed, 0 else.
 366  */
 367 int i_mapper_sin(ir_node *call, void *ctx);
 368
 369 /**
 370  * A mapper for the floating point sin(a): floattype cos(floattype a);
 371  *
 372  * @return 0 if the cos call was removed, 0 else.
 373  */
 374 int i_mapper_cos(ir_node *call, void *ctx);
 375
 376 /**
 377  * A mapper for the floating point tan(a): floattype tan(floattype a);
 378  *
 379  * @return 0 if the tan call was removed, 0 else.
 380  */
 381 int i_mapper_tan(ir_node *call, void *ctx);
 382
 383 /**
 384  * A mapper for the floating point asin(a): floattype asin(floattype a);
 385  *
 386  * @return 0 if the asin call was removed, 0 else.
 387  */
 388 int i_mapper_asin(ir_node *call, void *ctx);
 389
 390 /**
 391  * A mapper for the floating point acos(a): floattype acos(floattype a);
 392  *
 393  * @return 0 if the tan call was removed, 0 else.
 394  */
 395 int i_mapper_acos(ir_node *call, void *ctx);
 396
 397 /**
 398  * A mapper for the floating point atan(a): floattype atan(floattype a);
 399  *
 400  * @return 0 if the atan call was removed, 0 else.
 401  */
 402 int i_mapper_atan(ir_node *call, void *ctx);
 403
 404 /**
 405  * A mapper for the floating point sinh(a): floattype sinh(floattype a);
 406  *
 407  * @return 0 if the sinh call was removed, 0 else.
 408  */
 409 int i_mapper_sinh(ir_node *call, void *ctx);
 410
 411 /**
 412  * A mapper for the floating point cosh(a): floattype cosh(floattype a);
 413  *
 414  * @return 0 if the cosh call was removed, 0 else.
 415  */
 416 int i_mapper_cosh(ir_node *call, void *ctx);
 417
 418 /**
 419  * A mapper for the floating point tanh(a): floattype tanh(floattype a);
 420  *
 421  * @return 0 if the tanh call was removed, 0 else.
 422  */
 423 int i_mapper_tanh(ir_node *call, void *ctx);
 424
 425 /**
 426  * A mapper for the strcmp-Function: inttype strcmp(char pointer a, char pointer b);
 427  *
 428  * @return 0 if the strcmp call was removed, 0 else.
 429  */
 430 int i_mapper_strcmp(ir_node *call, void *ctx);
 431
 432 /**
 433  * A mapper for the strncmp-Function: inttype strncmp(char pointer a, char pointer b, inttype len);
 434  *
 435  * @return 0 if the strncmp call was removed, 0 else.
 436  */
 437 int i_mapper_strncmp(ir_node *call, void *ctx);
 438
 439 /**
 440  * A mapper for the strlen-Function: inttype strlen(char pointer a);
 441  *
 442  * @return 0 if the strlen call was removed, 0 else.
 443  */
 444 int i_mapper_strlen(ir_node *call, void *ctx);
 445
 446 /**
 447  * A mapper for the memcpy-Function: void pointer memcpy(void pointer d, void pointer s, inttype c);
 448  *
 449  * @return 0 if the memcpy call was removed, 0 else.
 450  */
 451 int i_mapper_memcpy(ir_node *call, void *ctx);
 452
 453 /**
 454  * A mapper for the memset-Function: void pointer memset(void pointer d, inttype C, inttype len);
 455  *
 456  * @return 0 if the memset call was removed, 0 else.
 457  */
 458 int i_mapper_memset(ir_node *call, void *ctx);
 459
 460 /**
 461  * A mapper for the alloca() function: pointer alloca(inttype size)
 462  * Replaces the call by a Alloca(stack_alloc) node.
 463  *
 464  * @return always 1
 465  */
 466 int i_mapper_alloca(ir_node *call, void *ctx);
 467
 468 /**
 469  * A runtime routine description.
 470  */
 471 typedef struct _runtime_rt {
 472         ir_entity *ent;            /**< The entity representing the runtime routine. */
 473         ir_mode   *mode;           /**< The operation mode of the mapped instruction. */
 474         ir_mode   *res_mode;       /**< The result mode of the mapped instruction or NULL. */
 475         long      mem_proj_nr;     /**< if >= 0, create a memory ProjM() */
 476         long      regular_proj_nr; /**< if >= 0, create a regular ProjX() */
 477         long      exc_proj_nr;     /**< if >= 0, create a exception ProjX() */
 478         long      exc_mem_proj_nr; /**< if >= 0, create a exception memory ProjM() */
 479         long      res_proj_nr;     /**< if >= 0, first result projection number */
 480 } runtime_rt;
 481
 482 /**
 483  * A mapper for mapping unsupported instructions to runtime calls.
 484  * Maps a op(arg_0, ..., arg_n) into a call to a runtime function
 485  * rt(arg_0, ..., arg_n).
 486  *
 487  * The mapping is only done, if the modes of all arguments matches the
 488  * modes of rt's argument.
 489  * Further, if op has a memory input, the generated Call uses it, else
 490  * it gets a NoMem.
 491  * The pinned state of the Call will be set to the pinned state of op.
 492  *
 493  * Note that i_mapper_RuntimeCall() must be used with a i_instr_record.
 494  *
 495  * @return 1 if an op was mapped, 0 else
 496  *
 497  * Some examples:
 498  *
 499  * - Maps signed Div nodes to calls to rt_Div():
 500    @code
 501   runtime_rt rt_Div = {
 502     ent("int rt_Div(int, int)"),
 503     mode_T,
 504     mode_Is,
 505     pn_Div_M,
 506     pn_Div_X_regular,
 507     pn_Div_X_except,
 508     pn_Div_M,
 509     pn_Div_res
 510   };
 511   i_instr_record map_Div = {
 512     INTRINSIC_INSTR,
 513     op_Div,
 514     i_mapper_RuntimeCall,
 515     &rt_Div,
 516     NULL
 517   };
 518   @endcode
 519  *
 520  * - Maps ConvD(F) to calls to rt_Float2Div():
 521   @code
 522   runtime_rt rt_Float2Double = {
 523     ent("double rt_Float2Div(float)"),
 524     get_type_mode("double"),
 525     NULL,
 526     -1,
 527     -1,
 528     -1,
 529     -1,
 530     -1
 531   };
 532   i_instr_record map_Float2Double = {
 533     INTRINSIC_INSTR,
 534     op_Conv,
 535     i_mapper_RuntimeCall,
 536     &rt_Float2Double,
 537     NULL
 538   };
 539   @endcode
 540  */
 541 int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt);
 542
 543 #endif /* FIRM_LOWERING_H */