git.gag.com Git - fw/sdcc/blob - src/SDCCloop.c

   1 /*-------------------------------------------------------------------------
   2
   3   SDCCloop.c - source file for loop detection & optimizations
   4
   5              Written By -  Sandeep Dutta . sandeep.dutta@usa.net (1998)
   6
   7    This program is free software; you can redistribute it and/or modify it
   8    under the terms of the GNU General Public License as published by the
   9    Free Software Foundation; either version 2, or (at your option) any
  10    later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  20
  21    In other words, you are welcome to use, share and improve this program.
  22    You are forbidden to forbid anyone else to use, share and improve
  23    what you give them.   Help stamp out software-hoarding!
  24 -------------------------------------------------------------------------*/
  25
  26 #include "common.h"
  27 #include "newalloc.h"
  28
  29 DEFSETFUNC (isDefAlive);
  30
  31 STACK_DCL (regionStack, eBBlock *, MAX_NEST_LEVEL * 10);
  32
  33 /*-----------------------------------------------------------------*/
  34 /* newInduction - creates a new induction variable                 */
  35 /*-----------------------------------------------------------------*/
  36 induction *
  37 newInduction (operand * sym, unsigned int op,
  38               long constVal, iCode * ic, operand * asym)
  39 {
  40   induction *ip;
  41
  42   ip = Safe_alloc ( sizeof (induction));
  43
  44   ip->sym = sym;
  45   ip->asym = asym;
  46   ip->op = op;
  47   ip->cval = constVal;
  48   ip->ic = ic;
  49 //updateSpillLocation(ic,1);
  50   return ip;
  51 }
  52
  53 /*-----------------------------------------------------------------*/
  54 /* newRegion - allocate & returns a loop structure                 */
  55 /*-----------------------------------------------------------------*/
  56 region *
  57 newRegion ()
  58 {
  59   region *lp;
  60
  61   lp = Safe_alloc ( sizeof (region));
  62
  63   return lp;
  64 }
  65
  66
  67 /*-----------------------------------------------------------------*/
  68 /* pinduction - prints induction                                   */
  69 /*-----------------------------------------------------------------*/
  70 DEFSETFUNC (pinduction)
  71 {
  72   induction *ip = item;
  73   iCodeTable *icTab;
  74
  75   fprintf (stdout, "\t");
  76   printOperand (ip->sym, stdout);
  77   icTab = getTableEntry (ip->ic->op);
  78   icTab->iCodePrint (stdout, ip->ic, icTab->printName);
  79   fprintf (stdout, " %04d\n", (int) ip->cval);
  80   return 0;
  81 }
  82
  83 /*-----------------------------------------------------------------*/
  84 /* pregion - prints loop information                                */
  85 /*-----------------------------------------------------------------*/
  86 DEFSETFUNC (pregion)
  87 {
  88   region *lp = item;
  89
  90   printf ("================\n");
  91   printf (" loop with entry -- > ");
  92   printEntryLabel (lp->entry, ap);
  93   printf ("\n");
  94   printf (" loop body --> ");
  95   applyToSet (lp->regBlocks, printEntryLabel);
  96   printf ("\n");
  97   printf (" loop exits --> ");
  98   applyToSet (lp->exits, printEntryLabel);
  99   printf ("\n");
 100   return 0;
 101 }
 102
 103 /*-----------------------------------------------------------------*/
 104 /* backEdges - returns a list of back edges                        */
 105 /*-----------------------------------------------------------------*/
 106 DEFSETFUNC (backEdges)
 107 {
 108   edge *ep = item;
 109   V_ARG (set **, bEdges);
 110
 111   /* if this is a back edge ; to determine this we check */
 112   /* to see if the 'to' is in the dominator list of the  */
 113   /* 'from' if yes then this is a back edge              */
 114   if (bitVectBitValue (ep->from->domVect, ep->to->bbnum))
 115     {
 116       addSetHead (bEdges, ep);
 117       return 1;
 118     }
 119
 120   return 0;
 121 }
 122
 123 /*-----------------------------------------------------------------*/
 124 /* intersectLoopSucc - returns intersection of loop Successors     */
 125 /*-----------------------------------------------------------------*/
 126 static bitVect *
 127 intersectLoopSucc (set * lexits, eBBlock ** ebbs)
 128 {
 129   bitVect *succVect = NULL;
 130   eBBlock *exit = setFirstItem (lexits);
 131
 132   if (!exit)
 133     return NULL;
 134
 135   succVect = bitVectCopy (exit->succVect);
 136
 137   for (exit = setNextItem (lexits); exit;
 138        exit = setNextItem (lexits))
 139     {
 140       succVect = bitVectIntersect (succVect,
 141                                    exit->succVect);
 142     }
 143
 144   return succVect;
 145 }
 146
 147
 148 /*-----------------------------------------------------------------*/
 149 /* loopInsert will insert a block into the loop set                */
 150 /*-----------------------------------------------------------------*/
 151 static void
 152 loopInsert (set ** regionSet, eBBlock * block)
 153 {
 154   if (!isinSet (*regionSet, block))
 155     {
 156       addSetHead (regionSet, block);
 157       STACK_PUSH (regionStack, block);
 158     }
 159 }
 160
 161 /*-----------------------------------------------------------------*/
 162 /* insertIntoLoop - insert item into loop                          */
 163 /*-----------------------------------------------------------------*/
 164 DEFSETFUNC (insertIntoLoop)
 165 {
 166   eBBlock *ebp = item;
 167   V_ARG (set **, regionSet);
 168
 169   loopInsert (regionSet, ebp);
 170   return 0;
 171 }
 172
 173 /*-----------------------------------------------------------------*/
 174 /* isNotInBlocks - will return 1 if not is blocks                  */
 175 /*-----------------------------------------------------------------*/
 176 DEFSETFUNC (isNotInBlocks)
 177 {
 178   eBBlock *ebp = item;
 179   V_ARG (set *, blocks);
 180
 181   if (!isinSet (blocks, ebp))
 182     return 1;
 183
 184   return 0;
 185 }
 186
 187 /*-----------------------------------------------------------------*/
 188 /* hasIncomingDefs - has definitions coming into the loop. i.e.    */
 189 /* check to see if the preheaders outDefs has any definitions      */
 190 /*-----------------------------------------------------------------*/
 191 int
 192 hasIncomingDefs (region * lreg, operand * op)
 193 {
 194   eBBlock *preHdr = lreg->entry->preHeader;
 195
 196   if (preHdr && bitVectBitsInCommon (preHdr->outDefs, OP_DEFS (op)))
 197     return 1;
 198   return 0;
 199 }
 200
 201 /*-----------------------------------------------------------------*/
 202 /* findLoopEndSeq - will return the sequence number of the last    */
 203 /* iCode with the maximum dfNumber in the region                   */
 204 /*-----------------------------------------------------------------*/
 205 int
 206 findLoopEndSeq (region * lreg)
 207 {
 208   eBBlock *block;
 209   eBBlock *lblock;
 210
 211   for (block = lblock = setFirstItem (lreg->regBlocks); block;
 212        block = setNextItem (lreg->regBlocks))
 213     {
 214       if (block != lblock && block->lSeq > lblock->lSeq)
 215         lblock = block;
 216     }
 217
 218   return lblock->lSeq;
 219 }
 220
 221 /*-----------------------------------------------------------------*/
 222 /* addToExitsMarkDepth - will add the the exitSet all blocks that  */
 223 /* have exits, will also update the depth field in the blocks      */
 224 /*-----------------------------------------------------------------*/
 225 DEFSETFUNC (addToExitsMarkDepth)
 226 {
 227   eBBlock *ebp = item;
 228   V_ARG (set *, loopBlocks);
 229   V_ARG (set **, exits);
 230   V_ARG (int, depth);
 231   V_ARG (region *, lr);
 232
 233   /* mark the loop depth of this block */
 234   //if (!ebp->depth)
 235   if (ebp->depth<depth)
 236     ebp->depth = depth;
 237
 238   /* NOTE: here we will update only the inner most loop
 239      that it is a part of */
 240   if (!ebp->partOfLoop)
 241     ebp->partOfLoop = lr;
 242
 243   /* if any of the successors go out of the loop then */
 244   /* we add this one to the exits */
 245   if (applyToSet (ebp->succList, isNotInBlocks, loopBlocks))
 246     {
 247       addSetHead (exits, ebp);
 248       return 1;
 249     }
 250
 251   return 0;
 252 }
 253
 254 /*-----------------------------------------------------------------*/
 255 /* createLoop - will create a set of region                        */
 256 /*-----------------------------------------------------------------*/
 257 DEFSETFUNC (createLoop)
 258 {
 259   edge *ep = item;
 260   V_ARG (set **, allRegion);
 261   region *aloop = newRegion ();
 262   eBBlock *block;
 263
 264   /* make sure regionStack is empty */
 265   while (!STACK_EMPTY (regionStack))
 266     STACK_POP (regionStack);
 267
 268   /* add the entryBlock */
 269   addSet (&aloop->regBlocks, ep->to);
 270   loopInsert (&aloop->regBlocks, ep->from);
 271
 272   while (!STACK_EMPTY (regionStack))
 273     {
 274       block = STACK_POP (regionStack);
 275       /* if block != entry */
 276       if (block != ep->to)
 277         applyToSet (block->predList, insertIntoLoop, &aloop->regBlocks);
 278     }
 279
 280   aloop->entry = ep->to;
 281
 282   /* now add it to the set */
 283   addSetHead (allRegion, aloop);
 284   return 0;
 285 }
 286
 287 /*-----------------------------------------------------------------*/
 288 /* dominatedBy - will return 1 if item is dominated by block       */
 289 /*-----------------------------------------------------------------*/
 290 DEFSETFUNC (dominatedBy)
 291 {
 292   eBBlock *ebp = item;
 293   V_ARG (eBBlock *, block);
 294
 295   return bitVectBitValue (ebp->domVect, block->bbnum);
 296 }
 297
 298 /*-----------------------------------------------------------------*/
 299 /* addDefInExprs - adds an expression into the inexpressions       */
 300 /*-----------------------------------------------------------------*/
 301 DEFSETFUNC (addDefInExprs)
 302 {
 303   eBBlock *ebp = item;
 304   V_ARG (cseDef *, cdp);
 305   V_ARG (eBBlock **, ebbs);
 306   V_ARG (int, count);
 307
 308   addSetHead (&ebp->inExprs, cdp);
 309   cseBBlock (ebp, optimize.global_cse, ebbs, count);
 310   return 0;
 311 }
 312
 313 /*-----------------------------------------------------------------*/
 314 /* assignmentsToSym - for a set of blocks determine # time assigned */
 315 /*-----------------------------------------------------------------*/
 316 int
 317 assignmentsToSym (set * sset, operand * sym)
 318 {
 319   eBBlock *ebp;
 320   int assigns = 0;
 321   set *blocks = setFromSet (sset);
 322
 323   for (ebp = setFirstItem (blocks); ebp;
 324        ebp = setNextItem (blocks))
 325     {
 326
 327       /* get all the definitions for this symbol
 328          in this block */
 329       bitVect *defs = bitVectIntersect (ebp->ldefs, OP_DEFS (sym));
 330       assigns += bitVectnBitsOn (defs);
 331       setToNull ((void *) &defs);
 332
 333     }
 334
 335   return assigns;
 336 }
 337
 338
 339 /*-----------------------------------------------------------------*/
 340 /* isOperandInvariant - determines if an operand is an invariant   */
 341 /*-----------------------------------------------------------------*/
 342 int
 343 isOperandInvariant (operand * op, region * theLoop, set * lInvars)
 344 {
 345   int opin = 0;
 346   /* operand is an invariant if it is a                */
 347   /*       a. constants .                              */
 348   /*       b. that have defintions reaching loop entry */
 349   /*       c. that are already defined as invariant    */
 350   /*       d. has no assignments in the loop           */
 351   if (op)
 352     {
 353       if (IS_OP_LITERAL (op))
 354         opin = 1;
 355       else if (IS_SYMOP (op) &&
 356                OP_SYMBOL (op)->addrtaken)
 357         opin = 0;
 358       else if (ifDefSymIs (theLoop->entry->inExprs, op))
 359         opin = 1;
 360       else if (ifDefSymIs (lInvars, op))
 361         opin = 1;
 362       else if (IS_SYMOP (op) &&
 363                !IS_OP_GLOBAL (op) &&
 364                !IS_OP_VOLATILE (op) &&
 365                assignmentsToSym (theLoop->regBlocks, op) == 0)
 366         opin = 1;
 367     }
 368   else
 369     opin++;
 370
 371   return opin;
 372 }
 373
 374 /*-----------------------------------------------------------------*/
 375 /* pointerAssigned - will return 1 if pointer set found            */
 376 /*-----------------------------------------------------------------*/
 377 DEFSETFUNC (pointerAssigned)
 378 {
 379   eBBlock *ebp = item;
 380   V_ARG (operand *, op);
 381
 382   if (ebp->hasFcall)
 383     return 1;
 384
 385   if (bitVectBitValue (ebp->ptrsSet, op->key))
 386     return 1;
 387
 388   /* Unfortunately, one of the other pointer set operations  */
 389   /* may be using an alias of this operand, and the above    */
 390   /* test would miss it. To be thorough, some aliasing       */
 391   /* analysis should be done here. In the meantime, be       */
 392   /* conservative and assume any other pointer set operation */
 393   /* is dangerous                                            */
 394   if (!bitVectIsZero (ebp->ptrsSet))
 395     return 1;
 396
 397   return 0;
 398 }
 399
 400 /*-----------------------------------------------------------------*/
 401 /* hasNonPtrUse - returns true if operand has non pointer usage    */
 402 /*-----------------------------------------------------------------*/
 403 DEFSETFUNC (hasNonPtrUse)
 404 {
 405   eBBlock *ebp = item;
 406   V_ARG (operand *, op);
 407   iCode *ic = usedInRemaining (op, ebp->sch);
 408
 409   if (ic && !POINTER_SET (ic) && !POINTER_GET (ic))
 410     return 1;
 411
 412   return 0;
 413
 414 }
 415
 416 /*-----------------------------------------------------------------*/
 417 /* loopInvariants - takes loop invariants out of region            */
 418 /*-----------------------------------------------------------------*/
 419 int
 420 loopInvariants (region * theLoop, eBBlock ** ebbs, int count)
 421 {
 422   eBBlock *lBlock;
 423   set *lInvars = NULL;
 424
 425   int change = 0;
 426   int fCallsInBlock;
 427
 428   /* if the preHeader does not exist then do nothing */
 429   /* or no exits then do nothing ( have to think about this situation */
 430   if (theLoop->entry->preHeader == NULL ||
 431       theLoop->exits == NULL)
 432     return 0;
 433
 434   /* we will do the elimination for those blocks       */
 435   /* in the loop that dominate all exits from the loop */
 436   for (lBlock = setFirstItem (theLoop->regBlocks); lBlock;
 437        lBlock = setNextItem (theLoop->regBlocks))
 438     {
 439
 440       iCode *ic;
 441       int domsAllExits;
 442       int i;
 443
 444       /* mark the dominates all exits flag */
 445       domsAllExits = (applyToSet (theLoop->exits, dominatedBy, lBlock) ==
 446                       elementsInSet (theLoop->exits));
 447
 448       /* find out if we have a function call in this block */
 449       for (ic = lBlock->sch, fCallsInBlock=0; ic; ic = ic->next) {
 450         if (SKIP_IC(ic)) {
 451           fCallsInBlock++;
 452         }
 453       }
 454
 455       /* now we go thru the instructions of this block and */
 456       /* collect those instructions with invariant operands */
 457       for (ic = lBlock->sch; ic; ic = ic->next)
 458         {
 459
 460           int lin, rin;
 461           cseDef *ivar;
 462
 463           /* TODO this is only needed if the call is between
 464              here and the definition, but I am too lazy to do that now */
 465
 466           /* if there are function calls in this block */
 467           if (fCallsInBlock) {
 468
 469             /* if this is a pointer get */
 470             if (POINTER_GET(ic)) {
 471               continue;
 472             }
 473
 474             /* if this is an assignment from a global */
 475             if (ic->op=='=' && isOperandGlobal(IC_RIGHT(ic))) {
 476               continue;
 477             }
 478           }
 479
 480           if (SKIP_IC (ic) || POINTER_SET (ic) || ic->op == IFX)
 481             continue;
 482
 483           /* iTemp assignment from a literal may be invariant, but it
 484              will needlessly increase register pressure if the
 485              iCode(s) that use this iTemp are not also invariant */
 486           if (ic->op=='=' && IS_ITEMP (IC_RESULT (ic))
 487               && IS_OP_LITERAL (IC_RIGHT (ic)))
 488             continue;
 489
 490           /* if result is volatile then skip */
 491           if (IC_RESULT (ic) &&
 492               (isOperandVolatile (IC_RESULT (ic), TRUE) ||
 493                IS_OP_PARM (IC_RESULT (ic))))
 494             continue;
 495
 496           /* if result depends on a volatile then skip */
 497           if ((IC_LEFT(ic) && isOperandVolatile(IC_LEFT(ic), TRUE)) ||
 498               (IC_RIGHT(ic) && isOperandVolatile(IC_RIGHT(ic), TRUE)))
 499             continue;
 500
 501           lin = rin = 0;
 502
 503           /* special case */
 504           /* if address of then it is an invariant */
 505           if (ic->op == ADDRESS_OF &&
 506               IS_SYMOP (IC_LEFT (ic)) &&
 507               IS_AGGREGATE (operandType (IC_LEFT (ic))))
 508             lin++;
 509           else {
 510             /* check if left operand is an invariant */
 511             if ((lin = isOperandInvariant (IC_LEFT (ic), theLoop, lInvars)))
 512               /* if this is a pointer get then make sure
 513                  that the pointer set does not exist in
 514                  any of the blocks */
 515               if (POINTER_GET (ic) &&
 516                   (applyToSet (theLoop->regBlocks,
 517                                pointerAssigned, IC_LEFT (ic))))
 518                 lin = 0;
 519           }
 520
 521           /* do the same for right */
 522           rin = isOperandInvariant (IC_RIGHT (ic), theLoop, lInvars);
 523
 524           /* if this is a POINTER_GET then special case, make sure all
 525              usages within the loop are POINTER_GET any other usage
 526              would mean that this is not an invariant , since the pointer
 527              could then be passed as a parameter */
 528           if (POINTER_GET (ic) &&
 529               applyToSet (theLoop->regBlocks, hasNonPtrUse, IC_LEFT (ic)))
 530             continue;
 531
 532
 533           /* if both the left & right are invariants : then check that */
 534           /* this definition exists in the out definition of all the   */
 535           /* blocks, this will ensure that this is not assigned any    */
 536           /* other value in the loop, and not used in this block       */
 537           /* prior to this definition which means only this definition */
 538           /* is used in this loop                                      */
 539           if (lin && rin && IC_RESULT (ic))
 540             {
 541               eBBlock *sBlock;
 542               set *lSet = setFromSet (theLoop->regBlocks);
 543
 544               /* if this block does not dominate all exits */
 545               /* make sure this defintion is not used anywhere else */
 546               if (!domsAllExits)
 547                 {
 548
 549                   if (isOperandGlobal (IC_RESULT (ic)))
 550                     continue;
 551                   /* for successors for all exits */
 552                   for (sBlock = setFirstItem (theLoop->exits); sBlock;
 553                        sBlock = setNextItem (theLoop->exits))
 554                     {
 555
 556                       for (i = 0; i < count; ebbs[i++]->visited = 0);
 557                       lBlock->visited = 1;
 558                       if (applyToSet (sBlock->succList, isDefAlive, ic))
 559                         break;
 560                     }
 561
 562                   /* we have found usage */
 563                   if (sBlock)
 564                     continue;
 565                 }
 566
 567               /* now make sure this is the only definition */
 568               for (sBlock = setFirstItem (lSet); sBlock;
 569                    sBlock = setNextItem (lSet))
 570                 {
 571                   /* if this is the block make sure the definition */
 572                   /* reaches the end of the block */
 573                   if (sBlock == lBlock)
 574                     {
 575                       if (!ifDiCodeIs (sBlock->outExprs, ic))
 576                         break;
 577                     }
 578                   else if (bitVectBitsInCommon (sBlock->defSet, OP_DEFS (IC_RESULT (ic))))
 579                     break;
 580
 581                   if (IC_RESULT(ic))
 582                     {
 583                       iCode *ic2;
 584                       /* check that this definition is not assigned */
 585                       /* any other value in this block */
 586                       for (ic2 = sBlock->sch; ic2; ic2 = ic2->next)
 587                         {
 588                           if ((ic != ic2) && (isOperandEqual(IC_RESULT(ic), IC_RESULT(ic2))))
 589                             break;
 590                         }
 591                       if (ic2) /* found another definition */
 592                         break;
 593                     }
 594                 }
 595
 596               if (sBlock)
 597                 continue;       /* another definition present in the block */
 598
 599               /* now check if it exists in the in of this block */
 600               /* if not then it was killed before this instruction */
 601               if (!bitVectBitValue (lBlock->inDefs, ic->key))
 602                 continue;
 603
 604               /* now we know it is a true invariant */
 605               /* remove it from the insts chain & put */
 606               /* in the invariant set                */
 607
 608               OP_SYMBOL (IC_RESULT (ic))->isinvariant = 1;
 609               SPIL_LOC (IC_RESULT (ic)) = NULL;
 610               remiCodeFromeBBlock (lBlock, ic);
 611
 612               /* maintain the data flow */
 613               /* this means removing from definition from the */
 614               /* defset of this block and adding it to the    */
 615               /* inexpressions of all blocks within the loop  */
 616               bitVectUnSetBit (lBlock->defSet, ic->key);
 617               bitVectUnSetBit (lBlock->ldefs, ic->key);
 618               ivar = newCseDef (IC_RESULT (ic), ic);
 619               applyToSet (theLoop->regBlocks, addDefInExprs, ivar, ebbs, count);
 620               addSet (&lInvars, ivar);
 621             }
 622         }
 623     }                           /* for all loop blocks */
 624
 625   /* if we have some invariants then */
 626   if (lInvars)
 627     {
 628       eBBlock *preHdr = theLoop->entry->preHeader;
 629       iCode *icFirst = NULL, *icLast = NULL;
 630       cseDef *cdp;
 631
 632       /* create an iCode chain from it */
 633       for (cdp = setFirstItem (lInvars); cdp; cdp = setNextItem (lInvars))
 634         {
 635
 636           /* maintain data flow .. add it to the */
 637           /* ldefs defSet & outExprs of the preheader  */
 638           preHdr->defSet = bitVectSetBit (preHdr->defSet, cdp->diCode->key);
 639           preHdr->ldefs = bitVectSetBit (preHdr->ldefs, cdp->diCode->key);
 640           cdp->diCode->lineno = preHdr->ech->lineno;
 641           addSetHead (&preHdr->outExprs, cdp);
 642
 643
 644           if (!icFirst)
 645             icFirst = cdp->diCode;
 646           if (icLast)
 647             {
 648               icLast->next = cdp->diCode;
 649               cdp->diCode->prev = icLast;
 650               icLast = cdp->diCode;
 651             }
 652           else
 653             icLast = cdp->diCode;
 654           change++;
 655         }
 656
 657       /* add the instruction chain to the end of the
 658          preheader for this loop, preheaders will always
 659          have atleast a label */
 660       preHdr->ech->next = icFirst;
 661       icFirst->prev = preHdr->ech;
 662       preHdr->ech = icLast;
 663       icLast->next = NULL;
 664
 665     }
 666   return change;
 667 }
 668
 669 /*-----------------------------------------------------------------*/
 670 /* addressTaken - returns true if the symbol is found in the addrof */
 671 /*-----------------------------------------------------------------*/
 672 int
 673 addressTaken (set * sset, operand * sym)
 674 {
 675   set *loop;
 676   eBBlock *ebp;
 677   set *loop2;
 678
 679   for (loop = sset; loop; loop = loop->next)
 680     {
 681       ebp = loop->item;
 682       loop2 = ebp->addrOf;
 683       while (loop2)
 684         {
 685           if (isOperandEqual ((operand *) loop2->item, sym))
 686             return 1;
 687           loop2 = loop2->next;
 688         }
 689     }
 690
 691   return 0;
 692 }
 693
 694
 695 /*-----------------------------------------------------------------*/
 696 /* findInduction :- returns 1 & the item if the induction is found */
 697 /*-----------------------------------------------------------------*/
 698 DEFSETFUNC (findInduction)
 699 {
 700   induction *ip = item;
 701   V_ARG (operand *, sym);
 702   V_ARG (induction **, ipp);
 703
 704   if (isOperandEqual (ip->sym, sym))
 705     {
 706       *ipp = ip;
 707       return 1;
 708     }
 709
 710   return 0;
 711 }
 712
 713 /*-----------------------------------------------------------------*/
 714 /* findDefInRegion - finds the definition within the region        */
 715 /*-----------------------------------------------------------------*/
 716 iCode *
 717 findDefInRegion (set * regBlocks, operand * defOp, eBBlock ** owner)
 718 {
 719   eBBlock *lBlock;
 720
 721   /* for all blocks in the region */
 722   for (lBlock = setFirstItem (regBlocks); lBlock;
 723        lBlock = setNextItem (regBlocks))
 724     {
 725
 726       /* if a definition for this exists */
 727       if (bitVectBitsInCommon (lBlock->defSet, OP_DEFS (defOp)))
 728         {
 729           iCode *ic;
 730
 731           /* go thru the instruction chain to find it */
 732           for (ic = lBlock->sch; ic; ic = ic->next)
 733             if (bitVectBitValue (OP_DEFS (defOp), ic->key))
 734               {
 735                 if (owner)
 736                   *owner = lBlock;
 737                 return ic;
 738               }
 739         }
 740     }
 741
 742   return NULL;
 743 }
 744
 745 /*-----------------------------------------------------------------*/
 746 /* basicInduction - finds the basic induction variables in a loop  */
 747 /*-----------------------------------------------------------------*/
 748 set *
 749 basicInduction (region * loopReg, eBBlock ** ebbs, int count)
 750 {
 751   eBBlock *lBlock;
 752   set *indVars = NULL;
 753
 754   /* i.e. all assignments of the form a := a +/- const */
 755   /* for all blocks within the loop do */
 756   for (lBlock = setFirstItem (loopReg->regBlocks); lBlock;
 757        lBlock = setNextItem (loopReg->regBlocks))
 758     {
 759
 760       iCode *ic, *dic;
 761
 762       /* for all instructions in the blocks do */
 763       for (ic = lBlock->sch; ic; ic = ic->next)
 764         {
 765
 766           operand *aSym;
 767           unsigned long litValue;
 768           induction *ip;
 769           iCode *indIc;
 770           eBBlock *owner = NULL;
 771           int nexits;
 772
 773           /* look for assignments of the form */
 774           /*   symbolVar := iTempNN */
 775           if (ic->op != '=')
 776             continue;
 777
 778           if (!IS_TRUE_SYMOP (IC_RESULT (ic)) &&
 779               !OP_SYMBOL (IC_RESULT (ic))->isreqv)
 780             continue;
 781
 782           if (isOperandGlobal (IC_RESULT (ic)))
 783             continue;
 784
 785           if (!IS_ITEMP (IC_RIGHT (ic)))
 786             continue;
 787
 788           /* if it has multiple assignments within the loop then skip */
 789           if (assignmentsToSym (loopReg->regBlocks, IC_RESULT (ic)) > 1)
 790             continue;
 791
 792           /* if the address of this was taken inside the loop then continue */
 793           if (addressTaken (loopReg->regBlocks, IC_RESULT (ic)))
 794             continue;
 795
 796           /* find the definition for the result in the block */
 797           if (!(dic = findDefInRegion (setFromSet (loopReg->regBlocks),
 798                                        IC_RIGHT (ic), &owner)))
 799             continue;
 800
 801           /* if not +/- continue */
 802           if (dic->op != '+' && dic->op != '-')
 803             continue;
 804
 805           /* make sure definition is of the form  a +/- c */
 806           if (!IS_OP_LITERAL (IC_LEFT (dic)) && !IS_OP_LITERAL (IC_RIGHT (dic)))
 807             continue;
 808
 809           aSym = (IS_OP_LITERAL (IC_RIGHT (dic)) ?
 810               (litValue = (unsigned long) operandLitValue (IC_RIGHT (dic)), IC_LEFT (dic)) :
 811               (litValue = (unsigned long) operandLitValue (IC_LEFT (dic)), IC_RIGHT (dic)));
 812
 813           if (!isOperandEqual (IC_RESULT (ic), aSym) &&
 814               !isOperandEqual (IC_RIGHT (ic), aSym))
 815             {
 816               iCode *ddic;
 817               /* find the definition for this and check */
 818               if (!(ddic = findDefInRegion (setFromSet (loopReg->regBlocks),
 819                                             aSym, &owner)))
 820                 continue;
 821
 822               if (ddic->op != '=')
 823                 continue;
 824
 825               if (!isOperandEqual (IC_RESULT (ddic), aSym) ||
 826                   !isOperandEqual (IC_RIGHT (ddic), IC_RESULT (ic)))
 827                 continue;
 828             }
 829
 830           /* if the right hand side has more than one usage then
 831              don't make it an induction (will have to think some more) */
 832           if (bitVectnBitsOn (OP_USES (IC_RIGHT (ic))) > 1)
 833             continue;
 834
 835           /* if the definition is volatile then it cannot be
 836              an induction object */
 837           if (isOperandVolatile (IC_RIGHT (ic), FALSE) ||
 838               isOperandVolatile (IC_RESULT (ic), FALSE))
 839             continue;
 840
 841           /* whew !! that was a lot of work to find the definition */
 842           /* create an induction object */
 843           indIc = newiCode ('=', NULL, IC_RESULT (ic));
 844           indIc->lineno = ic->lineno;
 845           IC_RESULT (indIc) = operandFromOperand (IC_RIGHT (ic));
 846           IC_RESULT (indIc)->isaddr = 0;
 847           OP_SYMBOL (IC_RESULT (indIc))->isind = 1;
 848           ip = newInduction (IC_RIGHT (ic), dic->op, litValue, indIc, NULL);
 849
 850           /* replace the inducted variable by the iTemp */
 851           replaceSymBySym (loopReg->regBlocks, IC_RESULT (ic), IC_RIGHT (ic));
 852
 853           /* if it has only one exit then remove it from here
 854              and put it in the exit block */
 855           nexits = elementsInSet (loopReg->exits);
 856           if (nexits == 1)
 857             {
 858               eBBlock *exit = setFirstItem (loopReg->exits);
 859               /* if it is the same block then there is no
 860                  need to move it about */
 861               if (exit != lBlock)
 862                 {
 863                   iCode *saveic = ic->prev;
 864                   /* remove it */
 865                   remiCodeFromeBBlock (lBlock, ic);
 866                   /* clear the definition */
 867                   bitVectUnSetBit (lBlock->defSet, ic->key);
 868                   /* add it to the exit */
 869                   addiCodeToeBBlock (exit, ic, NULL);
 870                   /* set the definition bit */
 871                   exit->defSet = bitVectSetBit (exit->defSet, ic->key);
 872                   ic = saveic;
 873                 }
 874             }
 875
 876           /* if the number of exits is greater than one then
 877              we use another trick ; we will create an intersection
 878              of succesors of the exits, then take those that are not
 879              part of the loop and have dfNumber greater loop entry
 880              and insert a new definition in them */
 881           if (nexits > 1)
 882             {
 883
 884               bitVect *loopSuccs = intersectLoopSucc (loopReg->exits, ebbs);
 885
 886               /* loopSuccs now contains intersection
 887                  of all the loops successors */
 888               if (loopSuccs)
 889                 {
 890                   int i;
 891                   for (i = 0; i < loopSuccs->size; i++)
 892                     {
 893                       if (bitVectBitValue (loopSuccs, i))
 894                         {
 895
 896                           eBBlock *eblock = NULL;
 897                           int j;
 898
 899                           /* Need to search for bbnum == i since ebbs is  */
 900                           /* sorted by dfnum; a direct index won't do.  */
 901                           for (j=0; j<count; j++)
 902                             if (ebbs[j]->bbnum == i)
 903                               {
 904                                 eblock = ebbs[j];
 905                                 break;
 906                               }
 907                           assert(eblock);
 908
 909                           /* if the successor does not belong to the loop
 910                              and will be executed after the loop : then
 911                              add a definition to the block */
 912                           if (!isinSet (loopReg->regBlocks, eblock) &&
 913                               eblock->dfnum > loopReg->entry->dfnum)
 914                             {
 915                               /* create the definition */
 916                               iCode *newic = newiCode ('=', NULL,
 917                                         operandFromOperand (IC_RIGHT (ic)));
 918                               IC_RESULT (newic) = operandFromOperand (IC_RESULT (ic));
 919                               OP_DEFS(IC_RESULT (newic))=
 920                                 bitVectSetBit (OP_DEFS (IC_RESULT (newic)), newic->key);
 921                               OP_USES(IC_RIGHT (newic))=
 922                                 bitVectSetBit (OP_USES (IC_RIGHT (newic)), newic->key);
 923                               /* and add it */
 924                               if (eblock->sch && eblock->sch->op == LABEL)
 925                                 addiCodeToeBBlock (eblock, newic, eblock->sch->next);
 926                               else
 927                                 addiCodeToeBBlock (eblock, newic, eblock->sch);
 928                               /* set the definition bit */
 929                               eblock->defSet = bitVectSetBit (eblock->defSet, ic->key);
 930                             }
 931                         }
 932                     }
 933                 }
 934             }
 935
 936           addSet (&indVars, ip);
 937         }
 938
 939     }                           /* end of all blocks for basic induction variables */
 940
 941   return indVars;
 942 }
 943
 944 /*-----------------------------------------------------------------*/
 945 /* loopInduction - remove induction variables from a loop          */
 946 /*-----------------------------------------------------------------*/
 947 int
 948 loopInduction (region * loopReg, eBBlock ** ebbs, int count)
 949 {
 950   int change = 0;
 951   eBBlock *lBlock, *lastBlock = NULL;
 952   set *indVars = NULL;
 953   set *basicInd = NULL;
 954
 955   if (loopReg->entry->preHeader == NULL)
 956     return 0;
 957
 958   /* we first determine the basic Induction variables */
 959   basicInd = setFromSet (indVars = basicInduction (loopReg, ebbs, count));
 960
 961   /* find other induction variables : by other we mean definitions of */
 962   /* the form x := y (* | / ) <constant> .. we will move  this one to */
 963   /* beginning of the loop and reduce strength i.e. replace with +/-  */
 964   /* these expensive expressions: OH! and y must be induction too     */
 965   for (lBlock = setFirstItem (loopReg->regBlocks), lastBlock = lBlock;
 966        lBlock && indVars;
 967        lBlock = setNextItem (loopReg->regBlocks))
 968     {
 969
 970       iCode *ic, *indIc;
 971       induction *ip;
 972
 973       /* last block is the one with the highest block
 974          number */
 975       if (lastBlock->bbnum < lBlock->bbnum)
 976         lastBlock = lBlock;
 977
 978       for (ic = lBlock->sch; ic; ic = ic->next)
 979         {
 980           operand *aSym;
 981           unsigned long litVal;
 982           int lr = 0;
 983
 984           /* consider only * & / */
 985           if (ic->op != '*' && ic->op != '/')
 986             continue;
 987
 988           /* if the result has more definitions then */
 989           if (assignmentsToSym (loopReg->regBlocks, IC_RESULT (ic)) > 1)
 990             continue;
 991
 992           /* check if the operands are what we want */
 993           /* i.e. one of them an symbol the other a literal */
 994           if (!((IS_SYMOP (IC_LEFT (ic)) && IS_OP_LITERAL (IC_RIGHT (ic))) ||
 995                 (IS_OP_LITERAL (IC_LEFT (ic)) && IS_SYMOP (IC_RIGHT (ic)))))
 996             continue;
 997
 998           aSym = (IS_SYMOP (IC_LEFT (ic)) ?
 999           (lr = 1, litVal = (unsigned long) operandLitValue (IC_RIGHT (ic)), IC_LEFT (ic)) :
1000                   (litVal = (unsigned long) operandLitValue (IC_LEFT (ic)), IC_RIGHT (ic)));
1001
1002           ip = NULL;
1003           /* check if this is an induction variable */
1004           if (!applyToSetFTrue (basicInd, findInduction, aSym, &ip))
1005             continue;
1006
1007           /* ask port for size not worth if native instruction
1008              exist for multiply & divide */
1009           if (getSize (operandType (IC_LEFT (ic))) <= (unsigned long) port->support.muldiv ||
1010           getSize (operandType (IC_RIGHT (ic))) <= (unsigned long) port->support.muldiv)
1011             continue;
1012
1013           /* if this is a division then the remainder should be zero
1014              for it to be inducted */
1015           if (ic->op == '/' && (ip->cval % litVal))
1016             continue;
1017
1018           /* create the iCode to be placed in the loop header */
1019           /* and create the induction object */
1020
1021           /* create an instruction */
1022           /* this will be put on the loop header */
1023           indIc = newiCode (ic->op,
1024                             operandFromOperand (aSym),
1025                             operandFromLit (litVal));
1026           indIc->lineno = ic->lineno;
1027           IC_RESULT (indIc) = operandFromOperand (IC_RESULT (ic));
1028           OP_SYMBOL (IC_RESULT (indIc))->isind = 1;
1029
1030           /* keep track of the inductions */
1031           litVal = (ic->op == '*' ? (litVal * ip->cval) :
1032                     (ip->cval / litVal));
1033
1034           addSet (&indVars,
1035                 newInduction (IC_RESULT (ic), ip->op, litVal, indIc, NULL));
1036
1037           /* now change this instruction */
1038           ic->op = ip->op;
1039           if (lr)
1040             {
1041               IC_LEFT (ic) = operandFromOperand (IC_RESULT (ic));
1042               IC_RIGHT (ic) = operandFromLit (litVal);
1043             }
1044           else
1045             {
1046               IC_RIGHT (ic) = operandFromOperand (IC_RESULT (ic));
1047               IC_LEFT (ic) = operandFromLit (litVal);
1048             }
1049
1050           /* we need somemore initialisation code */
1051           /* we subtract the litVal from itself if increment */
1052           if (ic->op == '+')
1053             {
1054               indIc = newiCode ('-',
1055                                 operandFromOperand (IC_RESULT (ic)),
1056                                 operandFromLit (litVal));
1057               indIc->lineno = ic->lineno;
1058               IC_RESULT (indIc) = operandFromOperand (IC_RESULT (ic));
1059
1060               addSet (&indVars,
1061                 newInduction (IC_RESULT (ic), ip->op, litVal, indIc, NULL));
1062             }
1063         }
1064     }
1065
1066   /* if we have some induction variables then */
1067   if (indVars)
1068     {
1069       eBBlock *preHdr = loopReg->entry->preHeader;
1070       iCode *icFirst = NULL, *icLast = NULL;
1071       induction *ip;
1072       bitVect *indVect = NULL;
1073
1074       /* create an iCode chain from it */
1075       for (ip = setFirstItem (indVars);
1076            ip;
1077            ip = setNextItem (indVars))
1078         {
1079
1080           indVect = bitVectSetBit (indVect, ip->ic->key);
1081           ip->ic->lineno = preHdr->ech->lineno;
1082           if (!icFirst)
1083             icFirst = ip->ic;
1084           if (icLast)
1085             {
1086               icLast->next = ip->ic;
1087               ip->ic->prev = icLast;
1088               icLast = ip->ic;
1089             }
1090           else
1091             icLast = ip->ic;
1092           change++;
1093         }
1094
1095       /* add the instruction chain to the end of the */
1096       /* preheader for this loop                     */
1097       preHdr->ech->next = icFirst;
1098       icFirst->prev = preHdr->ech;
1099       preHdr->ech = icLast;
1100       icLast->next = NULL;
1101
1102       /* add the induction variable vector to the last
1103          block in the loop */
1104       lastBlock->isLastInLoop = 1;
1105       lastBlock->linds = bitVectUnion(lastBlock->linds,indVect);
1106     }
1107
1108   setToNull ((void *) &indVars);
1109   return change;
1110 }
1111
1112 /*-----------------------------------------------------------------*/
1113 /* mergeRegions - will merge region with same entry point           */
1114 /*-----------------------------------------------------------------*/
1115 DEFSETFUNC (mergeRegions)
1116 {
1117   region *theLoop = item;
1118   V_ARG (set *, allRegion);
1119   region *lp;
1120
1121   /* if this has already been merged then do nothing */
1122   if (theLoop->merged)
1123     return 0;
1124
1125   /* go thru all the region and check if any of them have the */
1126   /* entryPoint as the Loop                                  */
1127   for (lp = setFirstItem (allRegion); lp; lp = setNextItem (allRegion))
1128     {
1129
1130       if (lp == theLoop)
1131         continue;
1132
1133       if (lp->entry == theLoop->entry)
1134         {
1135           theLoop->regBlocks = unionSets (theLoop->regBlocks,
1136                                           lp->regBlocks, THROW_DEST);
1137           lp->merged = 1;
1138         }
1139     }
1140
1141   return 1;
1142 }
1143
1144 /*-----------------------------------------------------------------*/
1145 /* ifMerged - return 1 if the merge flag is 1                      */
1146 /*-----------------------------------------------------------------*/
1147 DEFSETFUNC (ifMerged)
1148 {
1149   region *lp = item;
1150
1151   return lp->merged;
1152 }
1153
1154 /*-----------------------------------------------------------------*/
1155 /* mergeInnerLoops - will merge into body when entry is present    */
1156 /*-----------------------------------------------------------------*/
1157 DEFSETFUNC (mergeInnerLoops)
1158 {
1159   region *theLoop = item;
1160   V_ARG (set *, allRegion);
1161   V_ARG (int *, maxDepth);
1162   region *lp;
1163
1164   /* check if the entry point is present in the body of any */
1165   /* loop then put the body of this loop into the outer loop */
1166   for (lp = setFirstItem (allRegion); lp; lp = setNextItem (allRegion))
1167     {
1168
1169       if (lp == theLoop)
1170         continue;
1171
1172       if (isinSet (lp->regBlocks, theLoop->entry))
1173         {
1174           lp->containsLoops += theLoop->containsLoops + 1;
1175           if (lp->containsLoops > (*maxDepth))
1176             *maxDepth = lp->containsLoops;
1177
1178           lp->regBlocks = unionSets (lp->regBlocks,
1179                                      theLoop->regBlocks, THROW_DEST);
1180         }
1181     }
1182
1183   return 1;
1184 }
1185
1186
1187 /*-----------------------------------------------------------------*/
1188 /* createLoopRegions - will detect and create a set of natural loops */
1189 /*-----------------------------------------------------------------*/
1190 hTab *
1191 createLoopRegions (eBBlock ** ebbs, int count)
1192 {
1193   set *allRegion = NULL;        /* set of all loops */
1194   hTab *orderedLoops = NULL;
1195   set *bEdges = NULL;
1196   int maxDepth = 0;
1197   region *lp;
1198
1199   /* get all the back edges in the graph */
1200   if (!applyToSet (graphEdges, backEdges, &bEdges))
1201     return 0;                   /* found no loops */
1202
1203   /* for each of these back edges get the blocks that */
1204   /* constitute the loops                             */
1205   applyToSet (bEdges, createLoop, &allRegion);
1206
1207   /* now we will create regions from these loops               */
1208   /* loops with the same entry points are considered to be the */
1209   /* same loop & they are merged. If the entry point of a loop */
1210   /* is found in the body of another loop then , all the blocks */
1211   /* in that loop are added to the loops containing the header */
1212   applyToSet (allRegion, mergeRegions, allRegion);
1213
1214   /* delete those already merged */
1215   deleteItemIf (&allRegion, ifMerged);
1216
1217   applyToSet (allRegion, mergeInnerLoops, allRegion, &maxDepth);
1218   maxDepth++;
1219
1220   /* now create all the exits .. also */
1221   /* create an ordered set of loops   */
1222   /* i.e. we process loops in the inner to outer order */
1223   for (lp = setFirstItem (allRegion); lp; lp = setNextItem (allRegion))
1224     {
1225       applyToSet (lp->regBlocks, addToExitsMarkDepth,
1226                   lp->regBlocks, &lp->exits,
1227                   (maxDepth - lp->containsLoops), lp);
1228
1229       hTabAddItem (&orderedLoops, lp->containsLoops, lp);
1230
1231     }
1232   return orderedLoops;
1233 }
1234
1235 /*-----------------------------------------------------------------*/
1236 /* loopOptimizations - identify region & remove invariants & ind   */
1237 /*-----------------------------------------------------------------*/
1238 int
1239 loopOptimizations (hTab * orderedLoops, eBBlock ** ebbs, int count)
1240 {
1241   region *lp;
1242   int change = 0;
1243   int k;
1244
1245   /* if no loop optimizations requested */
1246   if (!optimize.loopInvariant &&
1247       !optimize.loopInduction)
1248     return 0;
1249
1250   /* now we process the loops inner to outer order */
1251   /* this is essential to maintain data flow information */
1252   /* the other choice is an ugly iteration for the depth */
1253   /* of the loops would hate that */
1254   for (lp = hTabFirstItem (orderedLoops, &k); lp;
1255        lp = hTabNextItem (orderedLoops, &k))
1256     {
1257
1258       if (optimize.loopInvariant)
1259         change += loopInvariants (lp, ebbs, count);
1260
1261       if (optimize.loopInduction)
1262         change += loopInduction (lp, ebbs, count);
1263     }
1264
1265   return change;
1266 }