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

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