1 /*-------------------------------------------------------------------------
3 pcoderegs.c - post code generation register optimizations
5 Written By - Scott Dattalo scott@dattalo.com
6 Ported To PIC16 By - m.dubuc@rogers.com
8 This program is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 2, or (at your option) any
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 -------------------------------------------------------------------------*/
27 The purpose of the code in this file is to optimize the register usage.
32 #include "common.h" // Include everything in the SDCC src directory
37 #include "pcoderegs.h"
38 #include "pcodeflow.h"
40 extern void pic16_pCodeInsertAfter(pCode *pc1, pCode *pc2);
41 extern pCode * pic16_findPrevInstruction(pCode *pci);
42 extern pBranch * pic16_pBranchAppend(pBranch *h, pBranch *n);
43 void pic16_unlinkpCode(pCode *pc);
44 extern int pic16_pCodeSearchCondition(pCode *pc, unsigned int cond);
46 static int total_registers_saved=0;
47 static int register_optimization=1;
49 /*-----------------------------------------------------------------*
50 * void AddRegToFlow(regs *reg, pCodeFlow *pcfl)
51 *-----------------------------------------------------------------*/
53 void AddRegToFlow(regs *reg, pCodeFlow *pcfl)
56 if(!reg || ! pcfl || !isPCFL(pcflow))
60 pcfl->registers = newSet();
66 /*-----------------------------------------------------------------*
68 *-----------------------------------------------------------------*/
70 static void dbg_regusage(set *fregs)
77 for (reg = setFirstItem(fregs) ; reg ;
78 reg = setNextItem(fregs)) {
80 if(elementsInSet(reg->reglives.usedpCodes)) {
82 fprintf (stderr, "%s addr=0x%03x rIdx=0x%03x",
87 pcfl = setFirstItem(reg->reglives.usedpFlows);
89 fprintf(stderr, "\n used in seq");
92 fprintf(stderr," 0x%03x",pcfl->seq);
93 pcfl = setNextItem(reg->reglives.usedpFlows);
96 pcfl = setFirstItem(reg->reglives.assignedpFlows);
98 fprintf(stderr, "\n assigned in seq");
101 fprintf(stderr," 0x%03x",pcfl->seq);
102 pcfl = setNextItem(reg->reglives.assignedpFlows);
105 pc = setFirstItem(reg->reglives.usedpCodes);
107 fprintf(stderr, "\n used in instructions ");
110 pcfl = PCODE(PCI(pc)->pcflow);
112 fprintf(stderr," 0x%03x:",pcfl->seq);
113 fprintf(stderr,"0x%03x",pc->seq);
115 pc = setNextItem(reg->reglives.usedpCodes);
118 fprintf(stderr, "\n");
124 /*-----------------------------------------------------------------*
126 *-----------------------------------------------------------------*/
128 static void dbg_dumpregusage(void)
131 fprintf(stderr,"*** Register Usage ***\n");
132 fprintf(stderr,"InternalRegs:\n");
133 dbg_regusage(pic16_dynInternalRegs);
134 fprintf(stderr,"AllocRegs:\n");
135 dbg_regusage(pic16_dynAllocRegs);
136 fprintf(stderr,"StackRegs:\n");
137 dbg_regusage(pic16_dynStackRegs);
138 fprintf(stderr,"DirectRegs:\n");
139 dbg_regusage(pic16_dynDirectRegs);
140 fprintf(stderr,"DirectBitRegs:\n");
141 dbg_regusage(pic16_dynDirectBitRegs);
142 fprintf(stderr,"ProcessorRegs:\n");
143 dbg_regusage(pic16_dynProcessorRegs);
148 /*-----------------------------------------------------------------*
149 * void pCodeRegMapLiveRangesInFlow(pCodeFlow *pcfl)
150 *-----------------------------------------------------------------*/
151 static void pCodeRegMapLiveRangesInFlow(pCodeFlow *pcfl)
163 pc = pic16_findNextInstruction(pcfl->pc.next);
165 while(pic16_isPCinFlow(pc,PCODE(pcfl))) {
168 reg = pic16_getRegFromInstruction(pc);
172 fprintf(stderr, "flow seq %d, inst seq %d %s ",PCODE(pcfl)->seq,pc->seq,reg->name);
173 fprintf(stderr, "addr = 0x%03x, type = %d rIdx=0x%03x\n",
174 reg->address,reg->type,reg->rIdx);
177 addSetIfnotP(& (PCFL(pcfl)->registers), reg);
179 if((PCC_REGISTER | PCC_LITERAL) & PCI(pc)->inCond)
180 addSetIfnotP(& (reg->reglives.usedpFlows), pcfl);
182 if(PCC_REGISTER & PCI(pc)->outCond)
183 addSetIfnotP(& (reg->reglives.assignedpFlows), pcfl);
185 addSetIfnotP(& (reg->reglives.usedpCodes), pc);
190 pc = pic16_findNextInstruction(pc->next);
196 /*-----------------------------------------------------------------*
197 * void pic16_pCodeRegMapLiveRanges(pBlock *pb)
198 *-----------------------------------------------------------------*/
199 void pic16_pCodeRegMapLiveRanges(pBlock *pb)
203 for( pcflow = pic16_findNextpCode(pb->pcHead, PC_FLOW);
205 pcflow = pic16_findNextpCode(pcflow->next, PC_FLOW) ) {
207 if(!isPCFL(pcflow)) {
208 fprintf(stderr, "pCodeRegMapLiveRanges - pcflow is not a flow object ");
211 pCodeRegMapLiveRangesInFlow(PCFL(pcflow));
215 for( pcflow = pic16_findNextpCode(pb->pcHead, PC_FLOW);
217 pcflow = pic16_findNextpCode(pcflow->next, PC_FLOW) ) {
219 regs *r = setFirstItem(PCFL(pcflow)->registers);
220 fprintf(stderr,"flow seq %d\n", pcflow->seq);
223 fprintf(stderr, " %s\n",r->name);
224 r = setNextItem(PCFL(pcflow)->registers);
231 // dbg_dumpregusage();
236 /*-----------------------------------------------------------------*
238 *-----------------------------------------------------------------*/
239 static void Remove1pcode(pCode *pc, regs *reg)
246 deleteSetItem (&(reg->reglives.usedpCodes),pc);
248 fprintf(stderr,"removing instruction:\n");
249 pc->print(stderr,pc);
252 pcn = pic16_findNextInstruction(pc->next);
255 PCI(pcn)->label = pic16_pBranchAppend(PCI(pcn)->label,PCI(pc)->label);
260 pcn = pic16_findNextInstruction(pc->next);
263 if(PCI(pcn)->cline) {
264 //fprintf(stderr, "source line has been optimized completely out\n");
265 //pc->print(stderr,pc);
267 PCI(pcn)->cline = PCI(pc)->cline;
276 /*-----------------------------------------------------------------*
277 * void RemoveRegsFromSet(set *regset)
279 *-----------------------------------------------------------------*/
280 static void RemoveRegsFromSet(set *regset)
287 regset = regset->next;
289 used = elementsInSet(reg->reglives.usedpCodes);
293 //fprintf(stderr," reg %s isfree=%d, wasused=%d\n",reg->name,reg->isFree,reg->wasUsed);
295 //fprintf(stderr," getting rid of reg %s\n",reg->name);
302 pc = setFirstItem(reg->reglives.usedpCodes);
304 if(reg->type == REG_SFR) {
305 //fprintf(stderr, "not removing SFR reg %s even though used only once\n",reg->name);
312 pCode *pcn = pic16_findNextInstruction(pc->next);
314 if(pcn && PCI(pcn)->label) {
315 //fprintf(stderr,"can't delete instruction with label...\n");
316 //pc->print(stderr,pc);
319 /* Move the label to the next instruction */
321 PCI(pcn)->label = PCI(pc)->label;
326 regs *r = pic16_getRegFromInstruction(pc);
327 fprintf(stderr, "WARNING, a skip instruction is being optimized out\n");
328 pc->print(stderr,pc);
329 fprintf(stderr,"reg %s, type =%d\n",r->name, r->type);
331 //fprintf(stderr," removing reg %s because it is used only once\n",reg->name);
332 Remove1pcode(pc, reg);
334 pic16_unlinkpCode(pc);
335 deleteSetItem (&(reg->reglives.usedpCodes),pc);
339 total_registers_saved++; // debugging stats.
346 /*-----------------------------------------------------------------*
347 * void pic16_RemoveUnusedRegisters(void)
349 *-----------------------------------------------------------------*/
350 void pic16_RemoveUnusedRegisters(void)
352 /* First, get rid of registers that are used only one time */
354 //RemoveRegsFromSet(pic16_dynInternalRegs);
355 RemoveRegsFromSet(pic16_dynAllocRegs);
356 RemoveRegsFromSet(pic16_dynStackRegs);
358 don't do DirectRegs yet - there's a problem with arrays
359 RemoveRegsFromSet(pic16_dynDirectRegs);
361 RemoveRegsFromSet(pic16_dynDirectBitRegs);
363 if(total_registers_saved) fprintf(stderr, " *** Saved %d registers ***\n", total_registers_saved);
367 /*-----------------------------------------------------------------*
369 *-----------------------------------------------------------------*/
370 static void Remove2pcodes(pCode *pcflow, pCode *pc1, pCode *pc2, regs *reg, int can_free)
376 Remove1pcode(pc1, reg);
379 Remove1pcode(pc2, reg);
380 deleteSetItem (&(PCFL(pcflow)->registers), reg);
389 pCodeRegMapLiveRangesInFlow(PCFL(pcflow));
392 /*-----------------------------------------------------------------*
394 *-----------------------------------------------------------------*/
395 static int regUsedinRange(pCode *pc1, pCode *pc2, regs *reg)
401 testreg = pic16_getRegFromInstruction(pc1);
402 if(testreg && (testreg->rIdx == reg->rIdx)) {
406 pc1 = pic16_findNextInstruction(pc1->next);
408 } while (pc1 && (pc1 != pc2) && (i++ < 100)) ;
411 fprintf(stderr, "warning, regUsedinRange searched through too many pcodes\n");
416 /*-----------------------------------------------------------------*
417 * void pCodeOptime2pCodes(pCode *pc1, pCode *pc2)
419 * ADHOC pattern checking
420 * Now look for specific sequences that are easy to optimize.
421 * Many of these sequences are characteristic of the compiler
422 * (i.e. it'd probably be a waste of time to apply these adhoc
423 * checks to hand written assembly.)
426 *-----------------------------------------------------------------*/
427 static int pCodeOptime2pCodes(pCode *pc1, pCode *pc2, pCode *pcfl_used, regs *reg, int can_free, int optimize_level)
432 int t = total_registers_saved;
434 if(pc2->seq < pc1->seq) {
440 fprintf(stderr,"pCodeOptime2pCodes\n");
441 pc1->print(stderr,pc1);
442 pc2->print(stderr,pc2);
444 if((PCI(pc1)->op == POC_CLRF) && (PCI(pc2)->op == POC_MOVFW) ){
458 //fprintf(stderr, " CLRF/MOVFW. instruction after MOVFW is:\n");
459 pct1 = pic16_findNextInstruction(pc2->next);
461 if(PCI(pct1)->op == POC_MOVWF) {
462 newpc = pic16_newpCode(POC_CLRF, PCI(pct1)->pcop);
463 pct1->destruct(pct1);
465 newpc = pic16_newpCode(POC_MOVLW, pic16_newpCodeOpLit(0));
468 pic16_pCodeInsertAfter(pc2, newpc);
469 PCI(newpc)->pcflow = PCFL(pcfl_used);
470 newpc->seq = pc2->seq;
472 Remove2pcodes(pcfl_used, pc1, pc2, reg, can_free);
473 total_registers_saved++; // debugging stats.
475 } else if((PCI(pc1)->op == POC_CLRF) && (PCI(pc2)->op == POC_IORFW) ){
476 //fprintf(stderr, " CLRF/IORFW.\n");
478 pct2 = pic16_findNextInstruction(pc2->next);
480 if(pic16_pCodeSearchCondition(pct2, PCC_Z) > 0) {
481 pct2 = pic16_newpCode(POC_IORLW, pic16_newpCodeOpLit(0));
482 pct2->seq = pc2->seq;
483 PCI(pct2)->pcflow = PCFL(pcfl_used);
484 pic16_pCodeInsertAfter(pc1,pct2);
486 Remove2pcodes(pcfl_used, pc1, pc2, reg, can_free);
487 total_registers_saved++; // debugging stats.
489 } else if(PCI(pc1)->op == POC_MOVWF) {
491 pct2 = pic16_findNextInstruction(pc2->next);
493 if(PCI(pc2)->op == POC_MOVFW) {
495 fprintf(stderr, " MOVWF/MOVFW. instruction after MOVFW is:\n");
496 pct2->print(stderr,pct2);
499 if(PCI(pct2)->op == POC_MOVWF) {
514 reg2 = pic16_getRegFromInstruction(pct2);
515 //if(reg2 && !regUsedinRange(pc1,pc2,reg2) && (reg2->type != REG_SFR)) {
516 if(reg2 && !regUsedinRange(pc1,pc2,reg2)) {
518 if(pic16_pCodeSearchCondition(pct2, PCC_Z) < 1) {
519 pCode *pct3 = pic16_findNextInstruction(pct2->next);
520 pct2->seq = pc1->seq;
521 pic16_unlinkpCode(pct2);
522 pic16_pCodeInsertAfter(pic16_findPrevInstruction(pc1->prev),pct2);
524 #define usesW(x) ((x) && (isPCI(x)) && ( (PCI(x)->inCond & PCC_W) != 0))
527 ; // Remove2pcodes(pcfl_used, pc1, NULL, reg, can_free);
529 Remove2pcodes(pcfl_used, pc1, pc2, reg, can_free);
531 total_registers_saved++; // debugging stats.
534 //fprintf(stderr,"didn't optimize because Z bit is used\n");
538 fprintf(stderr, " couldn't optimize\n");
540 fprintf(stderr, " %s is used in range\n",reg2->name);
542 fprintf(stderr, " reg2 is NULL\n");
547 pct1 = pic16_findPrevInstruction(pc1->prev);
548 if(pct1 && (PCI(pct1)->pcflow == PCI(pc1)->pcflow)) {
550 if ( (PCI(pct1)->op == POC_MOVFW) &&
551 (PCI(pc2)->op == POC_MOVFW)) {
553 reg1 = pic16_getRegFromInstruction(pct1);
554 if(reg1 && !regUsedinRange(pc1,pc2,reg1)) {
556 fprintf(stderr, " MOVF/MOVFW. \n");
557 fprintf(stderr, " ...optimizing\n");
575 Or, if we're not deleting the register then the "To" is:
584 pct2 = pic16_newpCode(PCI(pc2)->op, PCI(pct1)->pcop);
585 pic16_pCodeInsertAfter(pc2, pct2);
586 PCI(pct2)->pcflow = PCFL(pcfl_used);
587 pct2->seq = pc2->seq;
590 Remove2pcodes(pcfl_used, pc1, pc2, reg, can_free);
592 /* If we're not freeing the register then that means (probably)
593 * the register is needed somewhere else.*/
594 pic16_unlinkpCode(pc1);
595 pic16_pCodeInsertAfter(pct2, pc1);
597 Remove2pcodes(pcfl_used, pc2, NULL, reg, can_free);
600 Remove2pcodes(pcfl_used, pct1, NULL, reg1, 0);
601 total_registers_saved++; // debugging stats.
604 } else if ( (PCI(pct1)->op == POC_MOVWF) &&
605 (PCI(pc2)->op == POC_MOVFW)) {
606 //fprintf(stderr,"movwf MOVWF/MOVFW\n");
607 if(optimize_level > 1 && can_free) {
608 pct2 = pic16_newpCode(POC_MOVFW, PCI(pc1)->pcop);
609 pic16_pCodeInsertAfter(pc2, pct2);
610 Remove2pcodes(pcfl_used, pc1, pc2, reg, 1);
611 total_registers_saved++; // debugging stats.
620 return (total_registers_saved != t);
623 /*-----------------------------------------------------------------*
624 * void pCodeRegOptimeRegUsage(pBlock *pb)
625 *-----------------------------------------------------------------*/
626 static void OptimizeRegUsage(set *fregs, int optimize_multi_uses, int optimize_level)
630 pCode *pc1=NULL, *pc2=NULL;
634 pCode *pcfl_used, *pcfl_assigned;
636 /* Step through the set by directly accessing the 'next' pointer.
637 * We could also step through by using the set API, but the
638 * the (debug) calls to print instructions affect the state
639 * of the set pointers */
644 if(reg->type == REG_SFR) {
645 //fprintf(stderr,"skipping SFR: %s\n",reg->name);
649 pcfl_used = setFirstItem(reg->reglives.usedpFlows);
650 pcfl_assigned = setFirstItem(reg->reglives.assignedpFlows);
652 used = elementsInSet(reg->reglives.usedpCodes);
656 * In this section, all registers that are used in only in two
657 * instructions are examined. If possible, they're optimized out.
661 fprintf (stderr, "OptimizeRegUsage: %s addr=0x%03x rIdx=0x%03x type=%d used=%d\n",
664 reg->rIdx, reg->type, used);
666 pc1 = setFirstItem(reg->reglives.usedpCodes);
667 pc2 = setNextItem(reg->reglives.usedpCodes);
669 if(pcfl_used && pcfl_assigned) {
672 expected case - the register has been assigned a value and is
676 //fprintf(stderr," used only twice\n");
677 if(pcfl_used->seq == pcfl_assigned->seq) {
679 //fprintf(stderr, " and used in same flow\n");
681 pCodeOptime2pCodes(pc1, pc2, pcfl_used, reg, 1,optimize_level);
684 // fprintf(stderr, " and used in different flows\n");
688 } else if(pcfl_used) {
691 register has been used twice without ever being assigned */
692 //fprintf(stderr,"WARNING %s: reg %s used without being assigned\n",__FUNCTION__,reg->name);
695 //fprintf(stderr,"WARNING %s: reg %s assigned without being used\n",__FUNCTION__,reg->name);
696 Remove2pcodes(pcfl_assigned, pc1, pc2, reg, 1);
697 total_registers_saved++; // debugging stats.
701 /* register has been used either once, or more than twice */
703 if(used && !pcfl_used && pcfl_assigned) {
706 //fprintf(stderr,"WARNING %s: reg %s assigned without being used\n",__FUNCTION__,reg->name);
708 pc = setFirstItem(reg->reglives.usedpCodes);
711 pcfl_assigned = PCODE(PCI(pc)->pcflow);
712 Remove1pcode(pc, reg);
714 deleteSetItem (&(PCFL(pcfl_assigned)->registers), reg);
716 deleteSetItem (&(reg->reglives.usedpCodes),pc);
719 pc = setNextItem(reg->reglives.usedpCodes);
726 total_registers_saved++; // debugging stats.
727 } else if( (used > 2) && optimize_multi_uses) {
733 pCodeFlow *pcfl1=NULL, *pcfl2=NULL;
735 /* examine the number of times this register is used */
738 rset1 = reg->reglives.usedpCodes;
739 while(rset1 && searching) {
744 if(pc1 && isPCI(pc1) && ( (pcfl1 = PCI(pc1)->pcflow) != NULL) ) {
746 //while(rset2 && searching) {
750 if(pc2 && isPCI(pc2) && ( (pcfl2 = PCI(pc2)->pcflow) != NULL) ) {
753 if(pCodeOptime2pCodes(pc1, pc2, pcfl_used, reg, 0,optimize_level))
758 //rset2 = rset2->next;
770 /*-----------------------------------------------------------------*
771 * void pic16_pCodeRegOptimeRegUsage(pBlock *pb)
772 *-----------------------------------------------------------------*/
773 void pic16_pCodeRegOptimizeRegUsage(int level)
778 int t = total_registers_saved;
780 if(!register_optimization)
786 saved = total_registers_saved;
788 /* Identify registers used in one flow sequence */
789 OptimizeRegUsage(pic16_dynAllocRegs,level, (OPT_PASSES-passes));
790 OptimizeRegUsage(pic16_dynStackRegs,level, (OPT_PASSES-passes));
791 OptimizeRegUsage(pic16_dynDirectRegs,0, (OPT_PASSES-passes));
793 if(total_registers_saved != saved)
794 fprintf(stderr, " *** pass %d, Saved %d registers, total saved %d ***\n",
795 (1+OPT_PASSES-passes),total_registers_saved-saved,total_registers_saved);
799 } while( passes && ((total_registers_saved != saved) || (passes==OPT_PASSES-1)) );
801 if(total_registers_saved == t)
802 fprintf(stderr, "No registers saved on this pass\n");
806 fprintf(stderr,"dynamically allocated regs:\n");
807 dbg_regusage(pic16_dynAllocRegs);
808 fprintf(stderr,"stack regs:\n");
809 dbg_regusage(pic16_dynStackRegs);
810 fprintf(stderr,"direct regs:\n");
811 dbg_regusage(pic16_dynDirectRegs);
816 /*-----------------------------------------------------------------*
817 * void RegsUnMapLiveRanges(set *regset)
819 *-----------------------------------------------------------------*/
820 static void RegsSetUnMapLiveRanges(set *regset)
826 regset = regset->next;
829 deleteSet(®->reglives.usedpCodes);
830 deleteSet(®->reglives.usedpFlows);
831 deleteSet(®->reglives.assignedpFlows);
837 void pic16_RegsUnMapLiveRanges(void)
840 RegsSetUnMapLiveRanges(pic16_dynAllocRegs);
841 RegsSetUnMapLiveRanges(pic16_dynStackRegs);
842 RegsSetUnMapLiveRanges(pic16_dynDirectRegs);
843 RegsSetUnMapLiveRanges(pic16_dynProcessorRegs);
844 RegsSetUnMapLiveRanges(pic16_dynDirectBitRegs);
845 RegsSetUnMapLiveRanges(pic16_dynInternalRegs);