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