1 /*****************************************************************************/
5 /* Additional information about 6502 code */
9 /* (C) 2001-2002 Ullrich von Bassewitz */
11 /* D-70597 Stuttgart */
12 /* EMail: uz@cc65.org */
15 /* This software is provided 'as-is', without any expressed or implied */
16 /* warranty. In no event will the authors be held liable for any damages */
17 /* arising from the use of this software. */
19 /* Permission is granted to anyone to use this software for any purpose, */
20 /* including commercial applications, and to alter it and redistribute it */
21 /* freely, subject to the following restrictions: */
23 /* 1. The origin of this software must not be misrepresented; you must not */
24 /* claim that you wrote the original software. If you use this software */
25 /* in a product, an acknowledgment in the product documentation would be */
26 /* appreciated but is not required. */
27 /* 2. Altered source versions must be plainly marked as such, and must not */
28 /* be misrepresented as being the original software. */
29 /* 3. This notice may not be removed or altered from any source */
32 /*****************************************************************************/
54 /*****************************************************************************/
56 /*****************************************************************************/
60 /* Table with the compare suffixes */
61 static const char CmpSuffixTab [][4] = {
62 "eq", "ne", "gt", "ge", "lt", "le", "ugt", "uge", "ult", "ule"
65 /* Table listing the function names and code info values for known internally
66 * used functions. This table should get auto-generated in the future.
68 typedef struct FuncInfo FuncInfo;
70 const char* Name; /* Function name */
71 unsigned short Use; /* Register usage */
72 unsigned short Chg; /* Changed/destroyed registers */
75 static const FuncInfo FuncInfoTable[] = {
76 { "addeq0sp", REG_AX, REG_AXY },
77 { "addeqysp", REG_AXY, REG_AXY },
78 { "addysp", REG_Y, REG_NONE },
79 { "aslax1", REG_AX, REG_AX | REG_TMP1 },
80 { "aslax2", REG_AX, REG_AX | REG_TMP1 },
81 { "aslax3", REG_AX, REG_AX | REG_TMP1 },
82 { "aslax4", REG_AX, REG_AX | REG_TMP1 },
83 { "bnega", REG_A, REG_AX },
84 { "bnegax", REG_AX, REG_AX },
85 { "bnegeax", REG_EAX, REG_EAX },
86 { "booleq", REG_NONE, REG_AX },
87 { "boolge", REG_NONE, REG_AX },
88 { "boolgt", REG_NONE, REG_AX },
89 { "boolle", REG_NONE, REG_AX },
90 { "boollt", REG_NONE, REG_AX },
91 { "boolne", REG_NONE, REG_AX },
92 { "booluge", REG_NONE, REG_AX },
93 { "boolugt", REG_NONE, REG_AX },
94 { "boolule", REG_NONE, REG_AX },
95 { "boolult", REG_NONE, REG_AX },
96 { "complax", REG_AX, REG_AX },
97 { "decax1", REG_AX, REG_AX },
98 { "decax2", REG_AX, REG_AX },
99 { "decax3", REG_AX, REG_AX },
100 { "decax4", REG_AX, REG_AX },
101 { "decax5", REG_AX, REG_AX },
102 { "decax6", REG_AX, REG_AX },
103 { "decax7", REG_AX, REG_AX },
104 { "decax8", REG_AX, REG_AX },
105 { "decaxy", REG_AXY, REG_AX | REG_TMP1 },
106 { "deceaxy", REG_EAXY, REG_EAX },
107 { "decsp1", REG_NONE, REG_Y },
108 { "decsp2", REG_NONE, REG_A },
109 { "decsp3", REG_NONE, REG_A },
110 { "decsp4", REG_NONE, REG_A },
111 { "decsp5", REG_NONE, REG_A },
112 { "decsp6", REG_NONE, REG_A },
113 { "decsp7", REG_NONE, REG_A },
114 { "decsp8", REG_NONE, REG_A },
115 { "incax1", REG_AX, REG_AX },
116 { "incax2", REG_AX, REG_AX },
117 { "incsp1", REG_NONE, REG_NONE },
118 { "incsp2", REG_NONE, REG_Y },
119 { "incsp3", REG_NONE, REG_Y },
120 { "incsp4", REG_NONE, REG_Y },
121 { "incsp5", REG_NONE, REG_Y },
122 { "incsp6", REG_NONE, REG_Y },
123 { "incsp7", REG_NONE, REG_Y },
124 { "incsp8", REG_NONE, REG_Y },
125 { "laddeq", REG_EAXY|REG_PTR1_LO, REG_EAXY | REG_PTR1_HI },
126 { "laddeq0sp", REG_EAX, REG_EAXY },
127 { "laddeq1", REG_Y | REG_PTR1_LO, REG_EAXY | REG_PTR1_HI },
128 { "laddeqa", REG_AY | REG_PTR1_LO, REG_EAXY | REG_PTR1_HI },
129 { "laddeqysp", REG_EAXY, REG_EAXY },
130 { "ldaidx", REG_AXY, REG_AX | REG_PTR1 },
131 { "ldauidx", REG_AXY, REG_AX | REG_PTR1 },
132 { "ldax0sp", REG_NONE, REG_AXY },
133 { "ldaxi", REG_AX, REG_AXY | REG_PTR1 },
134 { "ldaxidx", REG_AXY, REG_AXY | REG_PTR1 },
135 { "ldaxysp", REG_Y, REG_AXY },
136 { "ldeax0sp", REG_NONE, REG_EAXY },
137 { "ldeaxi", REG_AX, REG_EAXY | REG_PTR1 },
138 { "ldeaxidx", REG_AXY, REG_EAXY | REG_PTR1 },
139 { "ldeaxysp", REG_Y, REG_EAXY },
140 { "leaasp", REG_A, REG_AX },
141 { "lsubeq", REG_EAXY|REG_PTR1_LO, REG_EAXY | REG_PTR1_HI },
142 { "lsubeq0sp", REG_EAX, REG_EAXY },
143 { "lsubeq1", REG_Y | REG_PTR1_LO, REG_EAXY | REG_PTR1_HI },
144 { "lsubeqa", REG_AY | REG_PTR1_LO, REG_EAXY | REG_PTR1_HI },
145 { "lsubeqysp", REG_EAXY, REG_EAXY },
146 { "negax", REG_AX, REG_AX },
147 { "push0", REG_NONE, REG_AXY },
148 { "push1", REG_NONE, REG_AXY },
149 { "push2", REG_NONE, REG_AXY },
150 { "push3", REG_NONE, REG_AXY },
151 { "push4", REG_NONE, REG_AXY },
152 { "push5", REG_NONE, REG_AXY },
153 { "push6", REG_NONE, REG_AXY },
154 { "push7", REG_NONE, REG_AXY },
155 { "pusha", REG_A, REG_Y },
156 { "pusha0", REG_A, REG_XY },
157 { "pusha0sp", REG_NONE, REG_AY },
158 { "pushax", REG_AX, REG_Y },
159 { "pushaysp", REG_Y, REG_AY },
160 { "pushc0", REG_NONE, REG_A | REG_Y },
161 { "pushc1", REG_NONE, REG_A | REG_Y },
162 { "pushc2", REG_NONE, REG_A | REG_Y },
163 { "pusheax", REG_EAX, REG_Y },
164 { "pushw", REG_AX, REG_AXY | REG_PTR1 },
165 { "pushw0sp", REG_NONE, REG_AXY },
166 { "pushwidx", REG_AXY, REG_AXY | REG_PTR1 },
167 { "pushwysp", REG_Y, REG_AXY },
168 { "regswap", REG_AXY, REG_AXY | REG_TMP1 },
169 { "regswap1", REG_XY, REG_A },
170 { "regswap2", REG_XY, REG_A | REG_Y },
171 { "shlax1", REG_AX, REG_AX | REG_TMP1 },
172 { "shlax2", REG_AX, REG_AX | REG_TMP1 },
173 { "shlax3", REG_AX, REG_AX | REG_TMP1 },
174 { "shlax4", REG_AX, REG_AX | REG_TMP1 },
175 { "shrax1", REG_AX, REG_AX | REG_TMP1 },
176 { "shrax2", REG_AX, REG_AX | REG_TMP1 },
177 { "shrax3", REG_AX, REG_AX | REG_TMP1 },
178 { "shrax4", REG_AX, REG_AX | REG_TMP1 },
179 { "shreax1", REG_EAX, REG_AX | REG_TMP1 },
180 { "shreax2", REG_EAX, REG_AX | REG_TMP1 },
181 { "shreax3", REG_EAX, REG_AX | REG_TMP1 },
182 { "shreax4", REG_EAX, REG_AX | REG_TMP1 },
183 { "staspidx", REG_A | REG_Y, REG_Y | REG_TMP1 | REG_PTR1 },
184 { "stax0sp", REG_AX, REG_Y },
185 { "staxysp", REG_AXY, REG_Y },
186 { "steax0sp", REG_EAX, REG_Y },
187 { "steaxysp", REG_EAXY, REG_Y },
188 { "subeq0sp", REG_AX, REG_AXY },
189 { "subeqysp", REG_AXY, REG_AXY },
190 { "tosadda0", REG_A, REG_AXY },
191 { "tosaddax", REG_AX, REG_AXY },
192 { "tosanda0", REG_A, REG_AXY },
193 { "tosandax", REG_AX, REG_AXY },
194 { "tosdiva0", REG_AY, REG_ALL },
195 { "tosdivax", REG_AXY, REG_ALL },
196 { "tosdiveax", REG_EAXY, REG_ALL },
197 { "toseqeax", REG_EAX, REG_AXY | REG_PTR1 },
198 { "tosgeeax", REG_EAX, REG_AXY | REG_PTR1 },
199 { "tosgteax", REG_EAX, REG_AXY | REG_PTR1 },
200 { "tosicmp", REG_AX, REG_AXY | REG_SREG },
201 { "toslcmp", REG_EAX, REG_A | REG_Y | REG_PTR1 },
202 { "tosleeax", REG_EAX, REG_AXY | REG_PTR1 },
203 { "toslteax", REG_EAX, REG_AXY | REG_PTR1 },
204 { "tosmula0", REG_AX, REG_ALL },
205 { "tosmulax", REG_AX, REG_ALL },
206 { "tosmuleax", REG_EAX, REG_ALL },
207 { "tosneeax", REG_EAX, REG_AXY | REG_PTR1 },
208 { "tosshreax", REG_EAX, REG_EAXY | REG_PTR1 | REG_PTR2 },
209 { "tossuba0", REG_A, REG_AXY },
210 { "tossubax", REG_AX, REG_AXY },
211 { "tossubeax", REG_EAX, REG_EAXY },
212 { "tosugeeax", REG_EAX, REG_AXY | REG_PTR1 },
213 { "tosugteax", REG_EAX, REG_AXY | REG_PTR1 },
214 { "tosuleeax", REG_EAX, REG_AXY | REG_PTR1 },
215 { "tosulteax", REG_EAX, REG_AXY | REG_PTR1 },
216 { "tosumula0", REG_AX, REG_ALL },
217 { "tosumulax", REG_AX, REG_ALL },
218 { "tosumuleax", REG_EAX, REG_ALL },
219 { "tsteax", REG_EAX, REG_Y },
220 { "utsteax", REG_EAX, REG_Y },
222 #define FuncInfoCount (sizeof(FuncInfoTable) / sizeof(FuncInfoTable[0]))
224 /* Table with names of zero page locations used by the compiler */
225 static const ZPInfo ZPInfoTable[] = {
226 { 0, "ptr1", REG_PTR1_LO, REG_PTR1 },
227 { 0, "ptr1+1", REG_PTR1_HI, REG_PTR1 },
228 { 0, "ptr2", REG_PTR2_LO, REG_PTR2 },
229 { 0, "ptr2+1", REG_PTR2_HI, REG_PTR2 },
230 { 4, "ptr3", REG_NONE, REG_NONE },
231 { 4, "ptr4", REG_NONE, REG_NONE },
232 { 7, "regbank", REG_NONE, REG_NONE },
233 { 0, "regsave", REG_SAVE_LO, REG_SAVE },
234 { 0, "regsave+1", REG_SAVE_HI, REG_SAVE },
235 { 0, "sp", REG_SP_LO, REG_SP },
236 { 0, "sp+1", REG_SP_HI, REG_SP },
237 { 0, "sreg", REG_SREG_LO, REG_SREG },
238 { 0, "sreg+1", REG_SREG_HI, REG_SREG },
239 { 0, "tmp1", REG_TMP1, REG_TMP1 },
240 { 0, "tmp2", REG_NONE, REG_NONE },
241 { 0, "tmp3", REG_NONE, REG_NONE },
242 { 0, "tmp4", REG_NONE, REG_NONE },
244 #define ZPInfoCount (sizeof(ZPInfoTable) / sizeof(ZPInfoTable[0]))
248 /*****************************************************************************/
250 /*****************************************************************************/
254 static int CompareFuncInfo (const void* Key, const void* Info)
255 /* Compare function for bsearch */
257 return strcmp (Key, ((const FuncInfo*) Info)->Name);
262 void GetFuncInfo (const char* Name, unsigned short* Use, unsigned short* Chg)
263 /* For the given function, lookup register information and store it into
264 * the given variables. If the function is unknown, assume it will use and
265 * load all registers.
268 /* If the function name starts with an underline, it is an external
269 * function. Search for it in the symbol table. If the function does
270 * not start with an underline, it may be a runtime support function.
271 * Search for it in the list of builtin functions.
273 if (Name[0] == '_') {
275 /* Search in the symbol table, skip the leading underscore */
276 SymEntry* E = FindGlobalSym (Name+1);
278 /* Did we find it in the top level table? */
279 if (E && IsTypeFunc (E->Type)) {
281 /* A function may use the A or A/X registers if it is a fastcall
282 * function. If it is not a fastcall function but a variadic one,
283 * it will use the Y register (the parameter size is passed here).
284 * In all other cases, no registers are used. However, we assume
285 * that any function will destroy all registers.
287 FuncDesc* D = E->V.F.Func;
288 if ((D->Flags & FD_FASTCALL) != 0 && D->ParamCount > 0) {
289 /* Will use registers depending on the last param */
290 unsigned LastParamSize = CheckedSizeOf (D->LastParam->Type);
291 if (LastParamSize == 1) {
293 } else if (LastParamSize == 2) {
298 } else if ((D->Flags & FD_VARIADIC) != 0) {
301 /* Will not use any registers */
305 /* Will destroy all registers */
312 } else if (IsDigit (Name[0]) || Name[0] == '$') {
314 /* A call to a numeric address. Assume that anything gets used and
315 * destroyed. This is not a real problem, since numeric addresses
316 * are used mostly in inline assembly anyway.
324 /* Search for the function in the list of builtin functions */
325 const FuncInfo* Info = bsearch (Name, FuncInfoTable, FuncInfoCount,
326 sizeof(FuncInfo), CompareFuncInfo);
328 /* Do we know the function? */
330 /* Use the information we have */
337 /* Function not found - assume that the primary register is input, and all
338 * registers are changed
346 static int CompareZPInfo (const void* Name, const void* Info)
347 /* Compare function for bsearch */
349 /* Cast the pointers to the correct data type */
350 const char* N = (const char*) Name;
351 const ZPInfo* E = (const ZPInfo*) Info;
353 /* Do the compare. Be careful because of the length (Info may contain
354 * more than just the zeropage name).
357 /* Do a full compare */
358 return strcmp (N, E->Name);
360 /* Only compare the first part */
361 int Res = strncmp (N, E->Name, E->Len);
362 if (Res == 0 && (N[E->Len] != '\0' && N[E->Len] != '+')) {
363 /* Name is actually longer than Info->Name */
372 const ZPInfo* GetZPInfo (const char* Name)
373 /* If the given name is a zero page symbol, return a pointer to the info
374 * struct for this symbol, otherwise return NULL.
377 /* Search for the zp location in the list */
378 return bsearch (Name, ZPInfoTable, ZPInfoCount,
379 sizeof(ZPInfo), CompareZPInfo);
384 static unsigned GetRegInfo2 (CodeSeg* S,
391 /* Recursively called subfunction for GetRegInfo. */
393 /* Follow the instruction flow recording register usage. */
398 /* Check if we have already visited the current code entry. If so,
401 if (CE_HasMark (E)) {
405 /* Mark this entry as already visited */
407 CollAppend (Visited, E);
409 /* Evaluate the used registers */
411 if (E->OPC == OP65_RTS ||
412 ((E->Info & OF_BRA) != 0 && E->JumpTo == 0)) {
413 /* This instruction will leave the function */
417 /* We are not interested in the use of any register that has been
421 /* Remember the remaining registers */
425 /* Evaluate the changed registers */
426 if ((R = E->Chg) != REG_NONE) {
427 /* We are not interested in the use of any register that has been
431 /* Remember the remaining registers */
435 /* If we know about all registers now, bail out */
436 if (((Used | Unused) & Wanted) == Wanted) {
440 /* If the instruction is an RTS or RTI, we're done */
441 if ((E->Info & OF_RET) != 0) {
445 /* If we have an unconditional branch, follow this branch if possible,
446 * otherwise we're done.
448 if ((E->Info & OF_UBRA) != 0) {
450 /* Does this jump have a valid target? */
453 /* Unconditional jump */
454 E = E->JumpTo->Owner;
455 Index = -1; /* Invalidate */
458 /* Jump outside means we're done */
462 /* In case of conditional branches, follow the branch if possible and
463 * follow the normal flow (branch not taken) afterwards. If we cannot
464 * follow the branch, we're done.
466 } else if ((E->Info & OF_CBRA) != 0) {
470 /* Recursively determine register usage at the branch target */
474 U1 = GetRegInfo2 (S, E->JumpTo->Owner, -1, Visited, Used, Unused, Wanted);
476 /* All registers used, no need for second call */
480 Index = CS_GetEntryIndex (S, E);
482 if ((E = CS_GetEntry (S, ++Index)) == 0) {
483 Internal ("GetRegInfo2: No next entry!");
485 U2 = GetRegInfo2 (S, E, Index, Visited, Used, Unused, Wanted);
486 return U1 | U2; /* Used in any of the branches */
489 /* Jump to global symbol */
495 /* Just go to the next instruction */
497 Index = CS_GetEntryIndex (S, E);
499 E = CS_GetEntry (S, ++Index);
502 Internal ("GetRegInfo2: No next entry!");
509 /* Return to the caller the complement of all unused registers */
515 static unsigned GetRegInfo1 (CodeSeg* S,
522 /* Recursively called subfunction for GetRegInfo. */
524 /* Remember the current count of the line collection */
525 unsigned Count = CollCount (Visited);
527 /* Call the worker routine */
528 unsigned R = GetRegInfo2 (S, E, Index, Visited, Used, Unused, Wanted);
530 /* Restore the old count, unmarking all new entries */
531 unsigned NewCount = CollCount (Visited);
532 while (NewCount-- > Count) {
533 CodeEntry* E = CollAt (Visited, NewCount);
535 CollDelete (Visited, NewCount);
538 /* Return the registers used */
544 unsigned GetRegInfo (struct CodeSeg* S, unsigned Index, unsigned Wanted)
545 /* Determine register usage information for the instructions starting at the
550 Collection Visited; /* Visited entries */
553 /* Get the code entry for the given index */
554 if (Index >= CS_GetEntryCount (S)) {
555 /* There is no such code entry */
558 E = CS_GetEntry (S, Index);
560 /* Initialize the data structure used to collection information */
561 InitCollection (&Visited);
563 /* Call the recursive subfunction */
564 R = GetRegInfo1 (S, E, Index, &Visited, REG_NONE, REG_NONE, Wanted);
566 /* Delete the line collection */
567 DoneCollection (&Visited);
569 /* Return the registers used */
575 int RegAUsed (struct CodeSeg* S, unsigned Index)
576 /* Check if the value in A is used. */
578 return (GetRegInfo (S, Index, REG_A) & REG_A) != 0;
583 int RegXUsed (struct CodeSeg* S, unsigned Index)
584 /* Check if the value in X is used. */
586 return (GetRegInfo (S, Index, REG_X) & REG_X) != 0;
591 int RegYUsed (struct CodeSeg* S, unsigned Index)
592 /* Check if the value in Y is used. */
594 return (GetRegInfo (S, Index, REG_Y) & REG_Y) != 0;
599 int RegAXUsed (struct CodeSeg* S, unsigned Index)
600 /* Check if the value in A or(!) the value in X are used. */
602 return (GetRegInfo (S, Index, REG_AX) & REG_AX) != 0;
607 int RegEAXUsed (struct CodeSeg* S, unsigned Index)
608 /* Check if any of the four bytes in EAX are used. */
610 return (GetRegInfo (S, Index, REG_EAX) & REG_EAX) != 0;
615 unsigned GetKnownReg (unsigned Use, const RegContents* RC)
616 /* Return the register or zero page location from the set in Use, thats
617 * contents are known. If Use does not contain any register, or if the
618 * register in question does not have a known value, return REG_NONE.
621 if ((Use & REG_A) != 0) {
622 return (RC == 0 || RC->RegA >= 0)? REG_A : REG_NONE;
623 } else if ((Use & REG_X) != 0) {
624 return (RC == 0 || RC->RegX >= 0)? REG_X : REG_NONE;
625 } else if ((Use & REG_Y) != 0) {
626 return (RC == 0 || RC->RegY >= 0)? REG_Y : REG_NONE;
627 } else if ((Use & REG_TMP1) != 0) {
628 return (RC == 0 || RC->Tmp1 >= 0)? REG_TMP1 : REG_NONE;
629 } else if ((Use & REG_PTR1_LO) != 0) {
630 return (RC == 0 || RC->Ptr1Lo >= 0)? REG_PTR1_LO : REG_NONE;
631 } else if ((Use & REG_PTR1_HI) != 0) {
632 return (RC == 0 || RC->Ptr1Hi >= 0)? REG_PTR1_HI : REG_NONE;
633 } else if ((Use & REG_SREG_LO) != 0) {
634 return (RC == 0 || RC->SRegLo >= 0)? REG_SREG_LO : REG_NONE;
635 } else if ((Use & REG_SREG_HI) != 0) {
636 return (RC == 0 || RC->SRegHi >= 0)? REG_SREG_HI : REG_NONE;
644 static cmp_t FindCmpCond (const char* Code, unsigned CodeLen)
645 /* Search for a compare condition by the given code using the given length */
650 for (I = 0; I < sizeof (CmpSuffixTab) / sizeof (CmpSuffixTab [0]); ++I) {
651 if (strncmp (Code, CmpSuffixTab [I], CodeLen) == 0) {
663 cmp_t FindBoolCmpCond (const char* Name)
664 /* Check if the given string is the name of one of the boolean transformer
665 * subroutine, and if so, return the condition that is evaluated by this
666 * routine. Return CMP_INV if the condition is not recognised.
669 /* Check for the correct subroutine name */
670 if (strncmp (Name, "bool", 4) == 0) {
671 /* Name is ok, search for the code in the table */
672 return FindCmpCond (Name+4, strlen(Name)-4);
681 cmp_t FindTosCmpCond (const char* Name)
682 /* Check if this is a call to one of the TOS compare functions (tosgtax).
683 * Return the condition code or CMP_INV on failure.
686 unsigned Len = strlen (Name);
688 /* Check for the correct subroutine name */
689 if (strncmp (Name, "tos", 3) == 0 && strcmp (Name+Len-2, "ax") == 0) {
690 /* Name is ok, search for the code in the table */
691 return FindCmpCond (Name+3, Len-3-2);