nsz Git - libfirm/blob - ir/ir/irarch.c

   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   Machine dependent Firm optimizations.
  23  * @date    28.9.2004
  24  * @author  Sebastian Hack, Michael Beck
  25  * @version $Id$
  26  *
  27  * Implements "Strenght Reduction of Multiplications by Integer Constants" by Youfeng Wu.
  28  * Implements Division and Modulo by Consts from "Hackers Delight",
  29  */
  30 #include "config.h"
  31
  32 #ifdef HAVE_STDLIB_H
  33 # include <stdlib.h>
  34 #endif
  35
  36 #include <assert.h>
  37
  38 #include "irnode_t.h"
  39 #include "irgraph_t.h"
  40 #include "irmode_t.h"
  41 #include "iropt_t.h"
  42 #include "ircons_t.h"
  43 #include "irgmod.h"
  44 #include "irvrfy.h"
  45 #include "tv_t.h"
  46 #include "dbginfo_t.h"
  47 #include "iropt_dbg.h"
  48 #include "irflag_t.h"
  49 #include "irhooks.h"
  50 #include "ircons.h"
  51 #include "irarch.h"
  52 #include "irflag.h"
  53 #include "error.h"
  54
  55 #undef DEB
  56
  57 #define MAX_BITSTR 64
  58
  59 /* when we need verifying */
  60 #ifdef NDEBUG
  61 # define IRN_VRFY_IRG(res, irg)
  62 #else
  63 # define IRN_VRFY_IRG(res, irg)  irn_vrfy_irg(res, irg)
  64 #endif
  65
  66 /** The params got from the factory in arch_dep_init(...). */
  67 static const ir_settings_arch_dep_t *params = NULL;
  68
  69 /** The bit mask, which optimizations to apply. */
  70 static arch_dep_opts_t opts;
  71
  72 void arch_dep_init(arch_dep_params_factory_t factory) {
  73         opts = arch_dep_none;
  74
  75         if (factory != NULL)
  76                 params = factory();
  77 }
  78
  79 void arch_dep_set_opts(arch_dep_opts_t the_opts) {
  80         opts = the_opts;
  81 }
  82
  83 /** check, whether a mode allows a Mulh instruction. */
  84 static int allow_Mulh(ir_mode *mode) {
  85         if (get_mode_size_bits(mode) > params->max_bits_for_mulh)
  86                 return 0;
  87         return (mode_is_signed(mode) && params->allow_mulhs) || (!mode_is_signed(mode) && params->allow_mulhu);
  88 }
  89
  90 /**
  91  * An instruction,
  92  */
  93 typedef struct instruction instruction;
  94 struct instruction {
  95         insn_kind   kind;        /**< the instruction kind */
  96         instruction *in[2];      /**< the ins */
  97         unsigned    shift_count; /**< shift count for LEA and SHIFT */
  98         ir_node     *irn;        /**< the generated node for this instruction if any. */
  99         int         costs;       /**< the costs for this instruction */
 100 };
 101
 102 /**
 103  * The environment for the strength reduction of multiplications.
 104  */
 105 typedef struct _mul_env {
 106         struct obstack obst;       /**< an obstack for local space. */
 107         ir_mode        *mode;      /**< the mode of the multiplication constant */
 108         unsigned       bits;       /**< number of bits in the mode */
 109         unsigned       max_S;      /**< the maximum LEA shift value. */
 110         instruction    *root;      /**< the root of the instruction tree */
 111         ir_node        *op;        /**< the operand that is multiplied */
 112         ir_node        *blk;       /**< the block where the new graph is built */
 113         dbg_info       *dbg;       /**< the debug info for the new graph. */
 114         ir_mode        *shf_mode;  /**< the (unsigned) mode for the shift constants */
 115         int            fail;       /**< set to 1 if the instruction sequence fails the constraints */
 116         int            n_shift;    /**< maximum number of allowed shift instructions */
 117
 118         evaluate_costs_func evaluate;  /**< the evaluate callback */
 119 } mul_env;
 120
 121 /**
 122  * Some kind of default evaluator. Return the cost of
 123  * instructions.
 124  */
 125 static int default_evaluate(insn_kind kind, tarval *tv) {
 126         (void) tv;
 127
 128         if (kind == MUL)
 129                 return 13;
 130         return 1;
 131 }
 132
 133 /**
 134  * emit a LEA (or an Add) instruction
 135  */
 136 static instruction *emit_LEA(mul_env *env, instruction *a, instruction *b, unsigned shift) {
 137         instruction *res = obstack_alloc(&env->obst, sizeof(*res));
 138         res->kind = shift > 0 ? LEA : ADD;
 139         res->in[0] = a;
 140         res->in[1] = b;
 141         res->shift_count = shift;
 142         res->irn = NULL;
 143         res->costs = -1;
 144         return res;
 145 }
 146
 147 /**
 148  * emit a SHIFT (or an Add or a Zero) instruction
 149  */
 150 static instruction *emit_SHIFT(mul_env *env, instruction *a, unsigned shift) {
 151         instruction *res = obstack_alloc(&env->obst, sizeof(*res));
 152         if (shift == env->bits) {
 153                 /* a 2^bits with bits resolution is a zero */
 154                 res->kind = ZERO;
 155                 res->in[0] = NULL;
 156                 res->in[1] = NULL;
 157                 res->shift_count = 0;
 158         } else if (shift != 1) {
 159                 res->kind = SHIFT;
 160                 res->in[0] = a;
 161                 res->in[1] = NULL;
 162                 res->shift_count = shift;
 163         } else {
 164                 res->kind = ADD;
 165                 res->in[0] = a;
 166                 res->in[1] = a;
 167                 res->shift_count = 0;
 168         }
 169         res->irn = NULL;
 170         res->costs = -1;
 171         return res;
 172 }
 173
 174 /**
 175  * emit a SUB instruction
 176  */
 177 static instruction *emit_SUB(mul_env *env, instruction *a, instruction *b) {
 178         instruction *res = obstack_alloc(&env->obst, sizeof(*res));
 179         res->kind = SUB;
 180         res->in[0] = a;
 181         res->in[1] = b;
 182         res->shift_count = 0;
 183         res->irn = NULL;
 184         res->costs = -1;
 185         return res;
 186 }
 187
 188 /**
 189  * emit the ROOT instruction
 190  */
 191 static instruction *emit_ROOT(mul_env *env, ir_node *root_op) {
 192         instruction *res = obstack_alloc(&env->obst, sizeof(*res));
 193         res->kind = ROOT;
 194         res->in[0] = NULL;
 195         res->in[1] = NULL;
 196         res->shift_count = 0;
 197         res->irn = root_op;
 198         res->costs = 0;
 199         return res;
 200 }
 201
 202
 203 /**
 204  * Returns the condensed representation of the tarval tv
 205  */
 206 static unsigned char *value_to_condensed(mul_env *env, tarval *tv, int *pr) {
 207         ir_mode *mode = get_tarval_mode(tv);
 208         int     bits = get_mode_size_bits(mode);
 209         char    *bitstr = get_tarval_bitpattern(tv);
 210         int     i, l, r;
 211         unsigned char *R = obstack_alloc(&env->obst, bits);
 212
 213         l = r = 0;
 214         for (i = 0; bitstr[i] != '\0'; ++i) {
 215                 if (bitstr[i] == '1') {
 216                         R[r] = i - l;
 217                         l = i;
 218                         ++r;
 219                 }
 220         }
 221         free(bitstr);
 222
 223         *pr = r;
 224         return R;
 225 }
 226
 227 /**
 228  * Calculate the gain when using the generalized complementary technique
 229  */
 230 static int calculate_gain(unsigned char *R, int r) {
 231         int max_gain = 0;
 232         int idx = -1, i;
 233         int gain;
 234
 235         /* the gain for r == 1 */
 236         gain = 2 - 3 - R[0];
 237         for (i = 2; i < r; ++i) {
 238                 /* calculate the gain for r from the gain for r-1 */
 239                 gain += 2 - R[i - 1];
 240
 241                 if (gain > max_gain) {
 242                         max_gain = gain;
 243                         idx = i;
 244                 }
 245         }
 246         return idx;
 247 }
 248
 249 /**
 250  * Calculates the condensed complement of a given (R,r) tuple
 251  */
 252 static unsigned char *complement_condensed(mul_env *env, unsigned char *R, int r, int gain, int *prs) {
 253         unsigned char *value = obstack_alloc(&env->obst, env->bits);
 254         int i, l, j;
 255         unsigned char c;
 256
 257         memset(value, 0, env->bits);
 258
 259         j = 0;
 260         for (i = 0; i < gain; ++i) {
 261                 j += R[i];
 262                 value[j] = 1;
 263         }
 264
 265         /* negate and propagate 1 */
 266         c = 1;
 267         for (i = 0; i <= j; ++i) {
 268                 unsigned char v = !value[i];
 269
 270                 value[i] = v ^ c;
 271                 c = v & c;
 272         }
 273
 274         /* condense it again */
 275         l = r = 0;
 276         R = value;
 277         for (i = 0; i <= j; ++i) {
 278                 if (value[i] == 1) {
 279                         R[r] = i - l;
 280                         l = i;
 281                         ++r;
 282                 }
 283         }
 284
 285         *prs = r;
 286         return R;
 287 }
 288
 289 /**
 290  * creates a tarval from a condensed representation.
 291  */
 292 static tarval *condensed_to_value(mul_env *env, unsigned char *R, int r) {
 293         tarval *res, *tv;
 294         int i, j;
 295
 296         j = 0;
 297         tv = get_mode_one(env->mode);
 298         res = NULL;
 299         for (i = 0; i < r; ++i) {
 300                 j = R[i];
 301                 if (j) {
 302                         tarval *t = new_tarval_from_long(j, mode_Iu);
 303                         tv = tarval_shl(tv, t);
 304                 }
 305                 res = res ? tarval_add(res, tv) : tv;
 306         }
 307         return res;
 308 }
 309
 310 /* forward */
 311 static instruction *basic_decompose_mul(mul_env *env, unsigned char *R, int r, tarval *N);
 312
 313 /*
 314  * handle simple cases with up-to 2 bits set
 315  */
 316 static instruction *decompose_simple_cases(mul_env *env, unsigned char *R, int r, tarval *N) {
 317         instruction *ins, *ins2;
 318
 319         (void) N;
 320         if (r == 1) {
 321                 return emit_SHIFT(env, env->root, R[0]);
 322         } else {
 323                 assert(r == 2);
 324
 325                 ins = env->root;
 326                 if (R[1] <= env->max_S) {
 327                         ins = emit_LEA(env, ins, ins, R[1]);
 328                         if (R[0] != 0) {
 329                                 ins = emit_SHIFT(env, ins, R[0]);
 330                         }
 331                         return ins;
 332                 }
 333                 if (R[0] != 0) {
 334                         ins = emit_SHIFT(env, ins, R[0]);
 335                 }
 336
 337                 ins2 = emit_SHIFT(env, env->root, R[0] + R[1]);
 338                 return emit_LEA(env, ins, ins2, 0);
 339         }
 340 }
 341
 342 /**
 343  * Main decompose driver.
 344  */
 345 static instruction *decompose_mul(mul_env *env, unsigned char *R, int r, tarval *N) {
 346         unsigned i;
 347         int gain;
 348
 349         if (r <= 2)
 350                 return decompose_simple_cases(env, R, r, N);
 351
 352         if (params->also_use_subs) {
 353                 gain = calculate_gain(R, r);
 354                 if (gain > 0) {
 355                         instruction *instr1, *instr2;
 356                         unsigned char *R1, *R2;
 357                         int r1, r2, i, k, j;
 358
 359                         R1 = complement_condensed(env, R, r, gain, &r1);
 360                         r2 = r - gain + 1;
 361                         R2 = obstack_alloc(&env->obst, r2);
 362
 363                         k = 1;
 364                         for (i = 0; i < gain; ++i) {
 365                                 k += R[i];
 366                         }
 367                         R2[0] = k;
 368                         R2[1] = R[gain] - 1;
 369                         j = 2;
 370                         if (R2[1] == 0) {
 371                                 /* Two identical bits: normalize */
 372                                 ++R2[0];
 373                                 --j;
 374                                 --r2;
 375                         }
 376                         for (i = gain + 1; i < r; ++i) {
 377                                 R2[j++] = R[i];
 378                         }
 379
 380                         instr1 = decompose_mul(env, R1, r1, NULL);
 381                         instr2 = decompose_mul(env, R2, r2, NULL);
 382                         return emit_SUB(env, instr2, instr1);
 383                 }
 384         }
 385
 386         if (N == NULL)
 387                 N = condensed_to_value(env, R, r);
 388
 389         for (i = env->max_S; i > 0; --i) {
 390                 tarval *div_res, *mod_res;
 391                 tarval *tv = new_tarval_from_long((1 << i) + 1, env->mode);
 392
 393                 div_res = tarval_divmod(N, tv, &mod_res);
 394                 if (mod_res == get_mode_null(env->mode)) {
 395                         unsigned char *Rs;
 396                         int rs;
 397
 398                         Rs = value_to_condensed(env, div_res, &rs);
 399                         if (rs < r) {
 400                                 instruction *N1 = decompose_mul(env, Rs, rs, div_res);
 401                                 return emit_LEA(env, N1, N1, i);
 402                         }
 403                 }
 404         }
 405         return basic_decompose_mul(env, R, r, N);
 406 }
 407
 408 #define IMAX(a,b) ((a) > (b) ? (a) : (b))
 409
 410 /**
 411  * basic decomposition routine
 412  */
 413 static instruction *basic_decompose_mul(mul_env *env, unsigned char *R, int r, tarval *N) {
 414         instruction *Ns;
 415         unsigned t;
 416
 417         if (R[0] == 0) {                                        /* Case 1 */
 418                 t = R[1] > IMAX(env->max_S, R[1]);
 419                 R[1] -= t;
 420                 Ns = decompose_mul(env, &R[1], r - 1, N);
 421                 return emit_LEA(env, env->root, Ns, t);
 422         } else if (R[0] <= env->max_S) {        /* Case 2 */
 423                 t = R[0];
 424                 R[1] += t;
 425                 Ns = decompose_mul(env, &R[1], r - 1, N);
 426                 return emit_LEA(env, Ns, env->root, t);
 427         } else {
 428                 t = R[0];
 429                 R[0] = 0;
 430                 Ns = decompose_mul(env, R, r, N);
 431                 return emit_SHIFT(env, Ns, t);
 432         }
 433 }
 434
 435 /**
 436  * recursive build the graph form the instructions.
 437  *
 438  * @param env   the environment
 439  * @param inst  the instruction
 440  */
 441 static ir_node *build_graph(mul_env *env, instruction *inst) {
 442         ir_node *l, *r, *c;
 443
 444         if (inst->irn)
 445                 return inst->irn;
 446
 447         switch (inst->kind) {
 448         case LEA:
 449                 l = build_graph(env, inst->in[0]);
 450                 r = build_graph(env, inst->in[1]);
 451                 c = new_r_Const(current_ir_graph, env->blk, env->shf_mode, new_tarval_from_long(inst->shift_count, env->shf_mode));
 452                 r = new_rd_Shl(env->dbg, current_ir_graph, env->blk, r, c, env->mode);
 453                 return inst->irn = new_rd_Add(env->dbg, current_ir_graph, env->blk, l, r, env->mode);
 454         case SHIFT:
 455                 l = build_graph(env, inst->in[0]);
 456                 c = new_r_Const(current_ir_graph, env->blk, env->shf_mode, new_tarval_from_long(inst->shift_count, env->shf_mode));
 457                 return inst->irn = new_rd_Shl(env->dbg, current_ir_graph, env->blk, l, c, env->mode);
 458         case SUB:
 459                 l = build_graph(env, inst->in[0]);
 460                 r = build_graph(env, inst->in[1]);
 461                 return inst->irn = new_rd_Sub(env->dbg, current_ir_graph, env->blk, l, r, env->mode);
 462         case ADD:
 463                 l = build_graph(env, inst->in[0]);
 464                 r = build_graph(env, inst->in[1]);
 465                 return inst->irn = new_rd_Add(env->dbg, current_ir_graph, env->blk, l, r, env->mode);
 466         case ZERO:
 467                 return inst->irn = new_r_Const(current_ir_graph, env->blk, env->mode, get_mode_null(env->mode));
 468         default:
 469                 panic("Unsupported instruction kind");
 470                 return NULL;
 471         }
 472 }
 473
 474 /**
 475  * Calculate the costs for the given instruction sequence.
 476  * Note that additional costs due to higher register pressure are NOT evaluated yet
 477  */
 478 static int evaluate_insn(mul_env *env, instruction *inst) {
 479         int costs;
 480
 481         if (inst->costs >= 0) {
 482                 /* was already evaluated */
 483                 return 0;
 484         }
 485
 486         switch (inst->kind) {
 487         case LEA:
 488         case SUB:
 489         case ADD:
 490                 costs  = evaluate_insn(env, inst->in[0]);
 491                 costs += evaluate_insn(env, inst->in[1]);
 492                 costs += env->evaluate(inst->kind, NULL);
 493                 inst->costs = costs;
 494                 return costs;
 495         case SHIFT:
 496                 if (inst->shift_count > params->highest_shift_amount)
 497                         env->fail = 1;
 498                 if (env->n_shift <= 0)
 499                         env->fail = 1;
 500                 else
 501                         --env->n_shift;
 502                 costs  = evaluate_insn(env, inst->in[0]);
 503                 costs += env->evaluate(inst->kind, NULL);
 504                 inst->costs = costs;
 505                 return costs;
 506         case ZERO:
 507                 inst->costs = costs = env->evaluate(inst->kind, NULL);
 508                 return costs;
 509         }
 510         panic("Unsupported instruction kind");
 511 }
 512
 513 /**
 514  * Evaluate the replacement instructions and build a new graph
 515  * if faster than the Mul.
 516  * Returns the root of the new graph then or irn otherwise.
 517  *
 518  * @param irn      the Mul operation
 519  * @param operand  the multiplication operand
 520  * @param tv       the multiplication constant
 521  *
 522  * @return the new graph
 523  */
 524 static ir_node *do_decomposition(ir_node *irn, ir_node *operand, tarval *tv) {
 525         mul_env       env;
 526         instruction   *inst;
 527         unsigned char *R;
 528         int           r;
 529         ir_node       *res = irn;
 530         int           mul_costs;
 531
 532         obstack_init(&env.obst);
 533         env.mode     = get_tarval_mode(tv);
 534         env.bits     = (unsigned)get_mode_size_bits(env.mode);
 535         env.max_S    = 3;
 536         env.root     = emit_ROOT(&env, operand);
 537         env.fail     = 0;
 538         env.n_shift  = params->maximum_shifts;
 539         env.evaluate = params->evaluate != NULL ? params->evaluate : default_evaluate;
 540
 541         R = value_to_condensed(&env, tv, &r);
 542         inst = decompose_mul(&env, R, r, tv);
 543
 544         /* the paper suggests 70% here */
 545         mul_costs = (env.evaluate(MUL, tv) * 7 + 5) / 10;
 546         if (evaluate_insn(&env, inst) <= mul_costs && !env.fail) {
 547                 env.op       = operand;
 548                 env.blk      = get_nodes_block(irn);
 549                 env.dbg      = get_irn_dbg_info(irn);
 550                 env.shf_mode = find_unsigned_mode(env.mode);
 551                 if (env.shf_mode == NULL)
 552                         env.shf_mode = mode_Iu;
 553
 554                 res = build_graph(&env, inst);
 555         }
 556         obstack_free(&env.obst, NULL);
 557         return res;
 558 }
 559
 560 /* Replace Muls with Shifts and Add/Subs. */
 561 ir_node *arch_dep_replace_mul_with_shifts(ir_node *irn) {
 562         ir_node *res = irn;
 563         ir_mode *mode = get_irn_mode(irn);
 564
 565         /* If the architecture dependent optimizations were not initialized
 566            or this optimization was not enabled. */
 567         if (params == NULL || (opts & arch_dep_mul_to_shift) == 0)
 568                 return irn;
 569
 570         set_arch_dep_running(1);
 571         {
 572                 if (is_Mul(irn) && mode_is_int(mode)) {
 573                         ir_node *left    = get_binop_left(irn);
 574                         ir_node *right   = get_binop_right(irn);
 575                         tarval *tv       = NULL;
 576                         ir_node *operand = NULL;
 577
 578                         /* Look, if one operand is a constant. */
 579                         if (is_Const(left)) {
 580                                 tv = get_Const_tarval(left);
 581                                 operand = right;
 582                         } else if (is_Const(right)) {
 583                                 tv = get_Const_tarval(right);
 584                                 operand = left;
 585                         }
 586
 587                         if (tv != NULL) {
 588                                 res = do_decomposition(irn, operand, tv);
 589
 590                                 if (res != irn) {
 591                                         hook_arch_dep_replace_mul_with_shifts(irn);
 592                                         exchange(irn, res);
 593                                 }
 594                         }
 595                 }
 596         }
 597         //set_arch_dep_running(0);
 598
 599         return res;
 600 }
 601
 602 /**
 603  * calculated the ld2 of a tarval if tarval is 2^n, else returns -1.
 604  */
 605 static int tv_ld2(tarval *tv, int bits) {
 606         int i, k = 0, num;
 607
 608         for (num = i = 0; i < bits; ++i) {
 609                 unsigned char v = get_tarval_sub_bits(tv, i);
 610
 611                 if (v) {
 612                         int j;
 613
 614                         for (j = 0; j < 8; ++j)
 615                                 if ((1 << j) & v) {
 616                                         ++num;
 617                                         k = 8 * i + j;
 618                                 }
 619                 }
 620         }
 621         if (num == 1)
 622                 return k;
 623         return -1;
 624 }
 625
 626
 627 /* for shorter lines */
 628 #define ABS(a)    tarval_abs(a)
 629 #define NEG(a)    tarval_neg(a)
 630 #define NOT(a)    tarval_not(a)
 631 #define SHL(a, b) tarval_shl(a, b)
 632 #define SHR(a, b) tarval_shr(a, b)
 633 #define ADD(a, b) tarval_add(a, b)
 634 #define SUB(a, b) tarval_sub(a, b, NULL)
 635 #define MUL(a, b) tarval_mul(a, b)
 636 #define DIV(a, b) tarval_div(a, b)
 637 #define MOD(a, b) tarval_mod(a, b)
 638 #define CMP(a, b) tarval_cmp(a, b)
 639 #define CNV(a, m) tarval_convert_to(a, m)
 640 #define ONE(m)    get_mode_one(m)
 641 #define ZERO(m)   get_mode_null(m)
 642
 643 /** The result of a the magic() function. */
 644 struct ms {
 645         tarval *M;        /**< magic number */
 646         int s;            /**< shift amount */
 647         int need_add;     /**< an additional add is needed */
 648         int need_sub;     /**< an additional sub is needed */
 649 };
 650
 651 /**
 652  * Signed division by constant d: calculate the Magic multiplier M and the shift amount s
 653  *
 654  * see Hacker's Delight: 10-6 Integer Division by Constants: Incorporation into a Compiler
 655  */
 656 static struct ms magic(tarval *d) {
 657         ir_mode *mode   = get_tarval_mode(d);
 658         ir_mode *u_mode = find_unsigned_mode(mode);
 659         int bits        = get_mode_size_bits(u_mode);
 660         int p;
 661         tarval *ad, *anc, *delta, *q1, *r1, *q2, *r2, *t;     /* unsigned */
 662         pn_Cmp d_cmp, M_cmp;
 663
 664         tarval *bits_minus_1, *two_bits_1;
 665
 666         struct ms mag;
 667
 668         tarval_int_overflow_mode_t rem = tarval_get_integer_overflow_mode();
 669
 670         /* we need overflow mode to work correctly */
 671         tarval_set_integer_overflow_mode(TV_OVERFLOW_WRAP);
 672
 673         /* 2^(bits-1) */
 674         bits_minus_1 = new_tarval_from_long(bits - 1, u_mode);
 675         two_bits_1   = SHL(get_mode_one(u_mode), bits_minus_1);
 676
 677         ad  = CNV(ABS(d), u_mode);
 678         t   = ADD(two_bits_1, SHR(CNV(d, u_mode), bits_minus_1));
 679         anc = SUB(SUB(t, ONE(u_mode)), MOD(t, ad));   /* Absolute value of nc */
 680         p   = bits - 1;                               /* Init: p */
 681         q1  = DIV(two_bits_1, anc);                   /* Init: q1 = 2^p/|nc| */
 682         r1  = SUB(two_bits_1, MUL(q1, anc));          /* Init: r1 = rem(2^p, |nc|) */
 683         q2  = DIV(two_bits_1, ad);                    /* Init: q2 = 2^p/|d| */
 684         r2  = SUB(two_bits_1, MUL(q2, ad));           /* Init: r2 = rem(2^p, |d|) */
 685
 686         do {
 687                 ++p;
 688                 q1 = ADD(q1, q1);                           /* Update q1 = 2^p/|nc| */
 689                 r1 = ADD(r1, r1);                           /* Update r1 = rem(2^p, |nc|) */
 690
 691                 if (CMP(r1, anc) & pn_Cmp_Ge) {
 692                         q1 = ADD(q1, ONE(u_mode));
 693                         r1 = SUB(r1, anc);
 694                 }
 695
 696                 q2 = ADD(q2, q2);                           /* Update q2 = 2^p/|d| */
 697                 r2 = ADD(r2, r2);                           /* Update r2 = rem(2^p, |d|) */
 698
 699                 if (CMP(r2, ad) & pn_Cmp_Ge) {
 700                         q2 = ADD(q2, ONE(u_mode));
 701                         r2 = SUB(r2, ad);
 702                 }
 703
 704                 delta = SUB(ad, r2);
 705         } while (CMP(q1, delta) & pn_Cmp_Lt || (CMP(q1, delta) & pn_Cmp_Eq && CMP(r1, ZERO(u_mode)) & pn_Cmp_Eq));
 706
 707         d_cmp = CMP(d, ZERO(mode));
 708
 709         if (d_cmp & pn_Cmp_Ge)
 710                 mag.M = ADD(CNV(q2, mode), ONE(mode));
 711         else
 712                 mag.M = SUB(ZERO(mode), ADD(CNV(q2, mode), ONE(mode)));
 713
 714         M_cmp = CMP(mag.M, ZERO(mode));
 715
 716         mag.s = p - bits;
 717
 718         /* need an add if d > 0 && M < 0 */
 719         mag.need_add = d_cmp & pn_Cmp_Gt && M_cmp & pn_Cmp_Lt;
 720
 721         /* need a sub if d < 0 && M > 0 */
 722         mag.need_sub = d_cmp & pn_Cmp_Lt && M_cmp & pn_Cmp_Gt;
 723
 724         tarval_set_integer_overflow_mode(rem);
 725
 726         return mag;
 727 }
 728
 729 /** The result of the magicu() function. */
 730 struct mu {
 731         tarval *M;        /**< magic add constant */
 732         int s;            /**< shift amount */
 733         int need_add;     /**< add indicator */
 734 };
 735
 736 /**
 737  * Unsigned division by constant d: calculate the Magic multiplier M and the shift amount s
 738  *
 739  * see Hacker's Delight: 10-10 Integer Division by Constants: Incorporation into a Compiler (Unsigned)
 740  */
 741 static struct mu magicu(tarval *d) {
 742         ir_mode *mode   = get_tarval_mode(d);
 743         int bits        = get_mode_size_bits(mode);
 744         int p;
 745         tarval *nc, *delta, *q1, *r1, *q2, *r2;
 746         tarval *bits_minus_1, *two_bits_1, *seven_ff;
 747
 748         struct mu magu;
 749
 750         tarval_int_overflow_mode_t rem = tarval_get_integer_overflow_mode();
 751
 752         /* we need overflow mode to work correctly */
 753         tarval_set_integer_overflow_mode(TV_OVERFLOW_WRAP);
 754
 755         bits_minus_1 = new_tarval_from_long(bits - 1, mode);
 756         two_bits_1   = SHL(get_mode_one(mode), bits_minus_1);
 757         seven_ff     = SUB(two_bits_1, ONE(mode));
 758
 759         magu.need_add = 0;                            /* initialize the add indicator */
 760         nc = SUB(NEG(ONE(mode)), MOD(NEG(d), d));
 761         p  = bits - 1;                                /* Init: p */
 762         q1 = DIV(two_bits_1, nc);                     /* Init: q1 = 2^p/nc */
 763         r1 = SUB(two_bits_1, MUL(q1, nc));            /* Init: r1 = rem(2^p, nc) */
 764         q2 = DIV(seven_ff, d);                        /* Init: q2 = (2^p - 1)/d */
 765         r2 = SUB(seven_ff, MUL(q2, d));               /* Init: r2 = rem(2^p - 1, d) */
 766
 767         do {
 768                 ++p;
 769                 if (CMP(r1, SUB(nc, r1)) & pn_Cmp_Ge) {
 770                         q1 = ADD(ADD(q1, q1), ONE(mode));
 771                         r1 = SUB(ADD(r1, r1), nc);
 772                 }
 773                 else {
 774                         q1 = ADD(q1, q1);
 775                         r1 = ADD(r1, r1);
 776                 }
 777
 778                 if (CMP(ADD(r2, ONE(mode)), SUB(d, r2)) & pn_Cmp_Ge) {
 779                         if (CMP(q2, seven_ff) & pn_Cmp_Ge)
 780                                 magu.need_add = 1;
 781
 782                         q2 = ADD(ADD(q2, q2), ONE(mode));
 783                         r2 = SUB(ADD(ADD(r2, r2), ONE(mode)), d);
 784                 }
 785                 else {
 786                         if (CMP(q2, two_bits_1) & pn_Cmp_Ge)
 787                                 magu.need_add = 1;
 788
 789                         q2 = ADD(q2, q2);
 790                         r2 = ADD(ADD(r2, r2), ONE(mode));
 791                 }
 792                 delta = SUB(SUB(d, ONE(mode)), r2);
 793         } while (p < 2*bits &&
 794                 (CMP(q1, delta) & pn_Cmp_Lt || (CMP(q1, delta) & pn_Cmp_Eq && CMP(r1, ZERO(mode)) & pn_Cmp_Eq)));
 795
 796         magu.M = ADD(q2, ONE(mode));                       /* Magic number */
 797         magu.s = p - bits;                                 /* and shift amount */
 798
 799         tarval_set_integer_overflow_mode(rem);
 800
 801         return magu;
 802 }
 803
 804 /**
 805  * Build the Mulh replacement code for n / tv.
 806  *
 807  * Note that 'div' might be a mod or DivMod operation as well
 808  */
 809 static ir_node *replace_div_by_mulh(ir_node *div, tarval *tv) {
 810         dbg_info *dbg  = get_irn_dbg_info(div);
 811         ir_node *n     = get_binop_left(div);
 812         ir_node *block = get_irn_n(div, -1);
 813         ir_mode *mode  = get_irn_mode(n);
 814         int bits       = get_mode_size_bits(mode);
 815         ir_node *q, *t, *c;
 816
 817         /* Beware: do not transform bad code */
 818         if (is_Bad(n) || is_Bad(block))
 819                 return div;
 820
 821         if (mode_is_signed(mode)) {
 822                 struct ms mag = magic(tv);
 823
 824                 /* generate the Mulh instruction */
 825                 c = new_r_Const(current_ir_graph, block, mode, mag.M);
 826                 q = new_rd_Mulh(dbg, current_ir_graph, block, n, c, mode);
 827
 828                 /* do we need an Add or Sub */
 829                 if (mag.need_add)
 830                         q = new_rd_Add(dbg, current_ir_graph, block, q, n, mode);
 831                 else if (mag.need_sub)
 832                         q = new_rd_Sub(dbg, current_ir_graph, block, q, n, mode);
 833
 834                 /* Do we need the shift */
 835                 if (mag.s > 0) {
 836                         c = new_r_Const_long(current_ir_graph, block, mode_Iu, mag.s);
 837                         q    = new_rd_Shrs(dbg, current_ir_graph, block, q, c, mode);
 838                 }
 839
 840                 /* final */
 841                 c = new_r_Const_long(current_ir_graph, block, mode_Iu, bits-1);
 842                 t = new_rd_Shr(dbg, current_ir_graph, block, q, c, mode);
 843
 844                 q = new_rd_Add(dbg, current_ir_graph, block, q, t, mode);
 845         } else {
 846                 struct mu mag = magicu(tv);
 847                 ir_node *c;
 848
 849                 /* generate the Mulh instruction */
 850                 c = new_r_Const(current_ir_graph, block, mode, mag.M);
 851                 q = new_rd_Mulh(dbg, current_ir_graph, block, n, c, mode);
 852
 853                 if (mag.need_add) {
 854                         if (mag.s > 0) {
 855                                 /* use the GM scheme */
 856                                 t = new_rd_Sub(dbg, current_ir_graph, block, n, q, mode);
 857
 858                                 c = new_r_Const(current_ir_graph, block, mode_Iu, get_mode_one(mode_Iu));
 859                                 t = new_rd_Shr(dbg, current_ir_graph, block, t, c, mode);
 860
 861                                 t = new_rd_Add(dbg, current_ir_graph, block, t, q, mode);
 862
 863                                 c = new_r_Const_long(current_ir_graph, block, mode_Iu, mag.s-1);
 864                                 q = new_rd_Shr(dbg, current_ir_graph, block, t, c, mode);
 865                         } else {
 866                                 /* use the default scheme */
 867                                 q = new_rd_Add(dbg, current_ir_graph, block, q, n, mode);
 868                         }
 869                 } else if (mag.s > 0) { /* default scheme, shift needed */
 870                         c = new_r_Const_long(current_ir_graph, block, mode_Iu, mag.s);
 871                         q = new_rd_Shr(dbg, current_ir_graph, block, q, c, mode);
 872                 }
 873         }
 874         return q;
 875 }
 876
 877 /* Replace Divs with Shifts and Add/Subs and Mulh. */
 878 ir_node *arch_dep_replace_div_by_const(ir_node *irn) {
 879         ir_node *res  = irn;
 880
 881         /* If the architecture dependent optimizations were not initialized
 882         or this optimization was not enabled. */
 883         if (params == NULL || (opts & arch_dep_div_by_const) == 0)
 884                 return irn;
 885
 886         if (is_Div(irn)) {
 887                 ir_node *c = get_Div_right(irn);
 888                 ir_node *block, *left;
 889                 ir_mode *mode;
 890                 tarval *tv, *ntv;
 891                 dbg_info *dbg;
 892                 int n, bits;
 893                 int k, n_flag;
 894
 895                 if (! is_Const(c))
 896                         return irn;
 897
 898                 tv = get_Const_tarval(c);
 899
 900                 /* check for division by zero */
 901                 if (tarval_is_null(tv))
 902                         return irn;
 903
 904                 left  = get_Div_left(irn);
 905                 mode  = get_irn_mode(left);
 906                 block = get_irn_n(irn, -1);
 907                 dbg   = get_irn_dbg_info(irn);
 908
 909                 bits = get_mode_size_bits(mode);
 910                 n    = (bits + 7) / 8;
 911
 912                 k = -1;
 913                 if (mode_is_signed(mode)) {
 914                         /* for signed divisions, the algorithm works for a / -2^k by negating the result */
 915                         ntv = tarval_neg(tv);
 916                         n_flag = 1;
 917                         k = tv_ld2(ntv, n);
 918                 }
 919
 920                 if (k < 0) {
 921                         n_flag = 0;
 922                         k = tv_ld2(tv, n);
 923                 }
 924
 925                 if (k >= 0) { /* division by 2^k or -2^k */
 926                         if (mode_is_signed(mode)) {
 927                                 ir_node *k_node;
 928                                 ir_node *curr = left;
 929
 930                                 /* create the correction code for signed values only if there might be a remainder */
 931                                 if (! is_Div_remainderless(irn)) {
 932                                         if (k != 1) {
 933                                                 k_node = new_r_Const_long(current_ir_graph, block, mode_Iu, k - 1);
 934                                                 curr   = new_rd_Shrs(dbg, current_ir_graph, block, left, k_node, mode);
 935                                         }
 936
 937                                         k_node = new_r_Const_long(current_ir_graph, block, mode_Iu, bits - k);
 938                                         curr   = new_rd_Shr(dbg, current_ir_graph, block, curr, k_node, mode);
 939
 940                                         curr   = new_rd_Add(dbg, current_ir_graph, block, left, curr, mode);
 941                                 } else {
 942                                         k_node = left;
 943                                 }
 944
 945                                 k_node = new_r_Const_long(current_ir_graph, block, mode_Iu, k);
 946                                 res    = new_rd_Shrs(dbg, current_ir_graph, block, curr, k_node, mode);
 947
 948                                 if (n_flag) { /* negate the result */
 949                                         ir_node *k_node;
 950
 951                                         k_node = new_r_Const(current_ir_graph, block, mode, get_mode_null(mode));
 952                                         res = new_rd_Sub(dbg, current_ir_graph, block, k_node, res, mode);
 953                                 }
 954                         } else {      /* unsigned case */
 955                                 ir_node *k_node;
 956
 957                                 k_node = new_r_Const_long(current_ir_graph, block, mode_Iu, k);
 958                                 res    = new_rd_Shr(dbg, current_ir_graph, block, left, k_node, mode);
 959                         }
 960                 } else {
 961                         /* other constant */
 962                         if (allow_Mulh(mode))
 963                                 res = replace_div_by_mulh(irn, tv);
 964                 }
 965         }
 966
 967         if (res != irn)
 968                 hook_arch_dep_replace_division_by_const(irn);
 969
 970         return res;
 971 }
 972
 973 /* Replace Mods with Shifts and Add/Subs and Mulh. */
 974 ir_node *arch_dep_replace_mod_by_const(ir_node *irn) {
 975         ir_node *res  = irn;
 976
 977         /* If the architecture dependent optimizations were not initialized
 978            or this optimization was not enabled. */
 979         if (params == NULL || (opts & arch_dep_mod_by_const) == 0)
 980                 return irn;
 981
 982         if (is_Mod(irn)) {
 983                 ir_node *c = get_Mod_right(irn);
 984                 ir_node *block, *left;
 985                 ir_mode *mode;
 986                 tarval *tv, *ntv;
 987                 dbg_info *dbg;
 988                 int n, bits;
 989                 int k;
 990
 991                 if (! is_Const(c))
 992                         return irn;
 993
 994                 tv = get_Const_tarval(c);
 995
 996                 /* check for division by zero */
 997                 if (tarval_is_null(tv))
 998                         return irn;
 999
1000                 left  = get_Mod_left(irn);
1001                 mode  = get_irn_mode(left);
1002                 block = get_irn_n(irn, -1);
1003                 dbg   = get_irn_dbg_info(irn);
1004                 bits = get_mode_size_bits(mode);
1005                 n    = (bits + 7) / 8;
1006
1007                 k = -1;
1008                 if (mode_is_signed(mode)) {
1009                         /* for signed divisions, the algorithm works for a / -2^k by negating the result */
1010                         ntv = tarval_neg(tv);
1011                         k = tv_ld2(ntv, n);
1012                 }
1013
1014                 if (k < 0) {
1015                         k = tv_ld2(tv, n);
1016                 }
1017
1018                 if (k >= 0) {
1019                         /* division by 2^k or -2^k:
1020                          * we use "modulus" here, so x % y == x % -y that's why is no difference between the case 2^k and -2^k
1021                          */
1022                         if (mode_is_signed(mode)) {
1023                                 ir_node *k_node;
1024                                 ir_node *curr = left;
1025
1026                                 if (k != 1) {
1027                                         k_node = new_r_Const_long(current_ir_graph, block, mode_Iu, k - 1);
1028                                         curr   = new_rd_Shrs(dbg, current_ir_graph, block, left, k_node, mode);
1029                                 }
1030
1031                                 k_node = new_r_Const_long(current_ir_graph, block, mode_Iu, bits - k);
1032                                 curr   = new_rd_Shr(dbg, current_ir_graph, block, curr, k_node, mode);
1033
1034                                 curr   = new_rd_Add(dbg, current_ir_graph, block, left, curr, mode);
1035
1036                                 k_node = new_r_Const_long(current_ir_graph, block, mode, (-1) << k);
1037                                 curr   = new_rd_And(dbg, current_ir_graph, block, curr, k_node, mode);
1038
1039                                 res    = new_rd_Sub(dbg, current_ir_graph, block, left, curr, mode);
1040                         } else {      /* unsigned case */
1041                                 ir_node *k_node;
1042
1043                                 k_node = new_r_Const_long(current_ir_graph, block, mode, (1 << k) - 1);
1044                                 res    = new_rd_And(dbg, current_ir_graph, block, left, k_node, mode);
1045                         }
1046                 } else {
1047                         /* other constant */
1048                         if (allow_Mulh(mode)) {
1049                                 res = replace_div_by_mulh(irn, tv);
1050
1051                                 res = new_rd_Mul(dbg, current_ir_graph, block, res, c, mode);
1052
1053                                 /* res = arch_dep_mul_to_shift(res); */
1054
1055                                 res = new_rd_Sub(dbg, current_ir_graph, block, left, res, mode);
1056                         }
1057                 }
1058         }
1059
1060         if (res != irn)
1061                 hook_arch_dep_replace_division_by_const(irn);
1062
1063         return res;
1064 }
1065
1066 /* Replace DivMods with Shifts and Add/Subs and Mulh. */
1067 void arch_dep_replace_divmod_by_const(ir_node **div, ir_node **mod, ir_node *irn) {
1068         *div = *mod = NULL;
1069
1070         /* If the architecture dependent optimizations were not initialized
1071            or this optimization was not enabled. */
1072         if (params == NULL ||
1073                 ((opts & (arch_dep_div_by_const|arch_dep_mod_by_const)) != (arch_dep_div_by_const|arch_dep_mod_by_const)))
1074                 return;
1075
1076         if (is_DivMod(irn)) {
1077                 ir_node *c = get_DivMod_right(irn);
1078                 ir_node *block, *left;
1079                 ir_mode *mode;
1080                 tarval *tv, *ntv;
1081                 dbg_info *dbg;
1082                 int n, bits;
1083                 int k, n_flag;
1084
1085                 if (! is_Const(c))
1086                         return;
1087
1088                 tv = get_Const_tarval(c);
1089
1090                 /* check for division by zero */
1091                 if (tarval_is_null(tv))
1092                         return;
1093
1094                 left  = get_DivMod_left(irn);
1095                 mode  = get_irn_mode(left);
1096                 block = get_irn_n(irn, -1);
1097                 dbg   = get_irn_dbg_info(irn);
1098
1099                 bits = get_mode_size_bits(mode);
1100                 n    = (bits + 7) / 8;
1101
1102                 k = -1;
1103                 if (mode_is_signed(mode)) {
1104                         /* for signed divisions, the algorithm works for a / -2^k by negating the result */
1105                         ntv = tarval_neg(tv);
1106                         n_flag = 1;
1107                         k = tv_ld2(ntv, n);
1108                 }
1109
1110                 if (k < 0) {
1111                         n_flag = 0;
1112                         k = tv_ld2(tv, n);
1113                 }
1114
1115                 if (k >= 0) { /* division by 2^k or -2^k */
1116                         if (mode_is_signed(mode)) {
1117                                 ir_node *k_node, *c_k;
1118                                 ir_node *curr = left;
1119
1120                                 if (k != 1) {
1121                                         k_node = new_r_Const_long(current_ir_graph, block, mode_Iu, k - 1);
1122                                         curr   = new_rd_Shrs(dbg, current_ir_graph, block, left, k_node, mode);
1123                                 }
1124
1125                                 k_node = new_r_Const_long(current_ir_graph, block, mode_Iu, bits - k);
1126                                 curr   = new_rd_Shr(dbg, current_ir_graph, block, curr, k_node, mode);
1127
1128                                 curr   = new_rd_Add(dbg, current_ir_graph, block, left, curr, mode);
1129
1130                                 c_k    = new_r_Const_long(current_ir_graph, block, mode_Iu, k);
1131
1132                                 *div   = new_rd_Shrs(dbg, current_ir_graph, block, curr, c_k, mode);
1133
1134                                 if (n_flag) { /* negate the div result */
1135                                         ir_node *k_node;
1136
1137                                         k_node = new_r_Const(current_ir_graph, block, mode, get_mode_null(mode));
1138                                         *div = new_rd_Sub(dbg, current_ir_graph, block, k_node, *div, mode);
1139                                 }
1140
1141                                 k_node = new_r_Const_long(current_ir_graph, block, mode, (-1) << k);
1142                                 curr   = new_rd_And(dbg, current_ir_graph, block, curr, k_node, mode);
1143
1144                                 *mod   = new_rd_Sub(dbg, current_ir_graph, block, left, curr, mode);
1145                         } else {      /* unsigned case */
1146                                 ir_node *k_node;
1147
1148                                 k_node = new_r_Const_long(current_ir_graph, block, mode_Iu, k);
1149                                 *div   = new_rd_Shr(dbg, current_ir_graph, block, left, k_node, mode);
1150
1151                                 k_node = new_r_Const_long(current_ir_graph, block, mode, (1 << k) - 1);
1152                                 *mod   = new_rd_And(dbg, current_ir_graph, block, left, k_node, mode);
1153                         }
1154                 } else {
1155                         /* other constant */
1156                         if (allow_Mulh(mode)) {
1157                                 ir_node *t;
1158
1159                                 *div = replace_div_by_mulh(irn, tv);
1160
1161                                 t    = new_rd_Mul(dbg, current_ir_graph, block, *div, c, mode);
1162
1163                                 /* t = arch_dep_mul_to_shift(t); */
1164
1165                                 *mod = new_rd_Sub(dbg, current_ir_graph, block, left, t, mode);
1166                         }
1167                 }
1168         }
1169
1170         if (*div)
1171                 hook_arch_dep_replace_division_by_const(irn);
1172 }
1173
1174
1175 static const ir_settings_arch_dep_t default_params = {
1176         1,  /* also use subs */
1177         4,  /* maximum shifts */
1178         31, /* maximum shift amount */
1179         default_evaluate,  /* default evaluator */
1180
1181         0,  /* allow Mulhs */
1182         0,  /* allow Mulus */
1183         32  /* Mulh allowed up to 32 bit */
1184 };
1185
1186 /* A default parameter factory for testing purposes. */
1187 const ir_settings_arch_dep_t *arch_dep_default_factory(void) {
1188         return &default_params;
1189 }