1 /*****************************************************************************/
5 /* Code segment entry */
9 /* (C) 2001-2002 Ullrich von Bassewitz */
11 /* D-70597 Stuttgart */
12 /* EMail: uz@musoftware.de */
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 /*****************************************************************************/
42 #include "debugflag.h"
56 /*****************************************************************************/
58 /*****************************************************************************/
63 static char EmptyArg[] = "";
67 /*****************************************************************************/
68 /* Helper functions */
69 /*****************************************************************************/
73 static void FreeArg (char* Arg)
74 /* Free a code entry argument */
76 if (Arg != EmptyArg) {
83 static char* GetArgCopy (const char* Arg)
84 /* Create an argument copy for assignment */
86 if (Arg && Arg[0] != '\0') {
90 /* Use the empty argument string */
97 static int NumArg (const char* Arg, unsigned long* Num)
98 /* If the given argument is numerical, convert it and return true. Otherwise
99 * set Num to zero and return false.
105 /* Determine the base */
110 } else if (*Arg == '%') {
115 /* Convert the value. strtol is not exactly what we want here, but it's
116 * cheap and may be replaced by something fancier later.
118 Val = strtoul (Arg, &End, Base);
120 /* Check if the conversion was successful */
123 /* Could not convert */
138 static void SetUseChgInfo (CodeEntry* E, const OPCDesc* D)
139 /* Set the Use and Chg in E */
143 /* If this is a subroutine call, or a jump to an external function,
144 * lookup the information about this function and use it. The jump itself
145 * does not change any registers, so we don't need to use the data from D.
147 if ((E->Info & (OF_BRA | OF_CALL)) != 0 && E->JumpTo == 0) {
148 /* A subroutine call or jump to external symbol (function exit) */
149 GetFuncInfo (E->Arg, &E->Use, &E->Chg);
151 /* Some other instruction. Use the values from the opcode description
152 * plus addressing mode info.
154 E->Use = D->Use | GetAMUseInfo (E->AM);
157 /* Check for special zero page registers used */
161 if (E->OPC == OP65_ASL || E->OPC == OP65_DEC ||
162 E->OPC == OP65_INC || E->OPC == OP65_LSR ||
163 E->OPC == OP65_ROL || E->OPC == OP65_ROR) {
164 /* A is changed by these insns */
171 /* Be conservative: */
175 Info = GetZPInfo (E->Arg);
176 if (Info && Info->ByteUse != REG_NONE) {
177 if (E->OPC == OP65_ASL || E->OPC == OP65_DEC ||
178 E->OPC == OP65_INC || E->OPC == OP65_LSR ||
179 E->OPC == OP65_ROL || E->OPC == OP65_ROR ||
180 E->OPC == OP65_TRB || E->OPC == OP65_TSB) {
181 /* The zp loc is both, input and output */
182 E->Chg |= Info->ByteUse;
183 E->Use |= Info->ByteUse;
184 } else if ((E->Info & OF_STORE) != 0) {
186 E->Chg |= Info->ByteUse;
189 E->Use |= Info->ByteUse;
197 Info = GetZPInfo (E->Arg);
198 if (Info && Info->ByteUse != REG_NONE) {
199 /* These addressing modes will never change the zp loc */
200 E->Use |= Info->WordUse;
205 /* Keep gcc silent */
213 /*****************************************************************************/
215 /*****************************************************************************/
219 const char* MakeHexArg (unsigned Num)
220 /* Convert Num into a string in the form $XY, suitable for passing it as an
221 * argument to NewCodeEntry, and return a pointer to the string.
222 * BEWARE: The function returns a pointer to a static buffer, so the value is
223 * gone if you call it twice (and apart from that it's not thread and signal
228 xsprintf (Buf, sizeof (Buf), "$%02X", (unsigned char) Num);
234 CodeEntry* NewCodeEntry (opc_t OPC, am_t AM, const char* Arg,
235 CodeLabel* JumpTo, LineInfo* LI)
236 /* Create a new code entry, initialize and return it */
238 /* Get the opcode description */
239 const OPCDesc* D = GetOPCDesc (OPC);
241 /* Allocate memory */
242 CodeEntry* E = xmalloc (sizeof (CodeEntry));
244 /* Initialize the fields */
247 E->Arg = GetArgCopy (Arg);
248 E->Flags = NumArg (E->Arg, &E->Num)? CEF_NUMARG : 0;
250 E->Size = GetInsnSize (E->OPC, E->AM);
252 E->LI = UseLineInfo (LI);
254 SetUseChgInfo (E, D);
255 InitCollection (&E->Labels);
257 /* If we have a label given, add this entry to the label */
259 CollAppend (&JumpTo->JumpFrom, E);
262 /* Return the initialized struct */
268 void FreeCodeEntry (CodeEntry* E)
269 /* Free the given code entry */
271 /* Free the string argument if we have one */
274 /* Cleanup the collection */
275 DoneCollection (&E->Labels);
277 /* Release the line info */
278 ReleaseLineInfo (E->LI);
280 /* Delete the register info */
289 void CE_ReplaceOPC (CodeEntry* E, opc_t OPC)
290 /* Replace the opcode of the instruction. This will also replace related info,
291 * Size, Use and Chg, but it will NOT update any arguments or labels.
294 /* Get the opcode descriptor */
295 const OPCDesc* D = GetOPCDesc (OPC);
297 /* Replace the opcode */
300 E->Size = GetInsnSize (E->OPC, E->AM);
301 SetUseChgInfo (E, D);
306 int CodeEntriesAreEqual (const CodeEntry* E1, const CodeEntry* E2)
307 /* Check if both code entries are equal */
309 return E1->OPC == E2->OPC && E1->AM == E2->AM && strcmp (E1->Arg, E2->Arg) == 0;
314 void CE_AttachLabel (CodeEntry* E, CodeLabel* L)
315 /* Attach the label to the entry */
317 /* Add it to the entries label list */
318 CollAppend (&E->Labels, L);
320 /* Tell the label about it's owner */
326 void CE_MoveLabel (CodeLabel* L, CodeEntry* E)
327 /* Move the code label L from it's former owner to the code entry E. */
329 /* Delete the label from the owner */
330 CollDeleteItem (&L->Owner->Labels, L);
332 /* Set the new owner */
333 CollAppend (&E->Labels, L);
339 void CE_SetNumArg (CodeEntry* E, long Num)
340 /* Set a new numeric argument for the given code entry that must already
341 * have a numeric argument.
346 /* Check that the entry has a numerical argument */
347 CHECK (E->Flags & CEF_NUMARG);
349 /* Make the new argument string */
352 xsprintf (Buf, sizeof (Buf), "$%02X", (unsigned) Num);
353 } else if (E->Size == 3) {
355 xsprintf (Buf, sizeof (Buf), "$%04X", (unsigned) Num);
357 Internal ("Invalid instruction size in CE_SetNumArg");
360 /* Free the old argument */
363 /* Assign the new one */
364 E->Arg = GetArgCopy (Buf);
366 /* Use the new numerical value */
372 int CE_KnownImm (const CodeEntry* E)
373 /* Return true if the argument of E is a known immediate value */
375 return (E->AM == AM65_IMM && (E->Flags & CEF_NUMARG) != 0);
380 int CE_UseLoadFlags (const CodeEntry* E)
381 /* Return true if the instruction uses any flags that are set by a load of
382 * a register (N and Z).
385 /* A branch will use the flags */
386 if (E->Info & OF_FBRA) {
390 /* Call of a boolean transformer routine will also use the flags */
391 if (E->OPC == OP65_JSR) {
392 /* Get the condition that is evaluated and check it */
393 switch (FindBoolCmpCond (E->Arg)) {
402 /* Will use the N or Z flags */
406 case CMP_UGE: /* Uses only carry */
407 case CMP_ULT: /* Dito */
408 default: /* No bool transformer subroutine */
419 void CE_FreeRegInfo (CodeEntry* E)
420 /* Free an existing register info struct */
430 void CE_GenRegInfo (CodeEntry* E, RegContents* InputRegs)
431 /* Generate register info for this instruction. If an old info exists, it is
435 /* Pointers to the register contents */
439 /* Function register usage */
440 unsigned short Use, Chg;
442 /* If we don't have a register info struct, allocate one. */
444 E->RI = NewRegInfo (InputRegs);
447 E->RI->In = *InputRegs;
449 RC_Invalidate (&E->RI->In);
451 E->RI->Out2 = E->RI->Out = E->RI->In;
454 /* Get pointers to the register contents */
458 /* Handle the different instructions */
462 /* We don't know the value of the carry, so the result is
465 Out->RegA = UNKNOWN_REGVAL;
469 if (RegValIsKnown (In->RegA)) {
470 if (CE_KnownImm (E)) {
471 Out->RegA = In->RegA & (short) E->Num;
472 } else if (E->AM == AM65_ZP) {
473 switch (GetKnownReg (E->Use, In)) {
475 Out->RegA = In->RegA & In->Tmp1;
478 Out->RegA = In->RegA & In->SRegLo;
481 Out->RegA = In->RegA & In->SRegHi;
484 Out->RegA = UNKNOWN_REGVAL;
488 Out->RegA = UNKNOWN_REGVAL;
494 if (E->AM == AM65_ACC && In->RegA >= 0) {
495 Out->RegA = (In->RegA << 1) & 0xFF;
496 } else if (E->AM == AM65_ZP) {
497 switch (GetKnownReg (E->Chg, In)) {
499 Out->Tmp1 = (In->Tmp1 << 1) & 0xFF;
502 Out->SRegLo = (In->SRegLo << 1) & 0xFF;
505 Out->SRegHi = (In->SRegHi << 1) & 0xFF;
508 } else if (E->AM == AM65_ZPX) {
509 /* Invalidates all ZP registers */
510 RC_InvalidateZP (Out);
569 if (RegValIsKnown (In->RegA)) {
570 Out->RegA = (In->RegA - 1) & 0xFF;
575 if (E->AM == AM65_ACC && In->RegA >= 0) {
576 Out->RegA = (In->RegA - 1) & 0xFF;
577 } else if (E->AM == AM65_ZP) {
578 switch (GetKnownReg (E->Chg, In)) {
580 Out->Tmp1 = (In->Tmp1 - 1) & 0xFF;
583 Out->SRegLo = (In->SRegLo - 1) & 0xFF;
586 Out->SRegHi = (In->SRegHi - 1) & 0xFF;
589 } else if (E->AM == AM65_ZPX) {
590 /* Invalidates all ZP registers */
591 RC_InvalidateZP (Out);
596 if (RegValIsKnown (In->RegX)) {
597 Out->RegX = (In->RegX - 1) & 0xFF;
602 if (RegValIsKnown (In->RegY)) {
603 Out->RegY = (In->RegY - 1) & 0xFF;
608 if (RegValIsKnown (In->RegA)) {
609 if (CE_KnownImm (E)) {
610 Out->RegA = In->RegA ^ (short) E->Num;
611 } else if (E->AM == AM65_ZP) {
612 switch (GetKnownReg (E->Use, In)) {
614 Out->RegA = In->RegA ^ In->Tmp1;
617 Out->RegA = In->RegA ^ In->SRegLo;
620 Out->RegA = In->RegA ^ In->SRegHi;
623 Out->RegA = UNKNOWN_REGVAL;
627 Out->RegA = UNKNOWN_REGVAL;
633 if (RegValIsKnown (In->RegA)) {
634 Out->RegA = (In->RegA + 1) & 0xFF;
639 if (E->AM == AM65_ACC && In->RegA >= 0) {
640 Out->RegA = (In->RegA + 1) & 0xFF;
641 } else if (E->AM == AM65_ZP) {
642 switch (GetKnownReg (E->Chg, In)) {
644 Out->Tmp1 = (In->Tmp1 + 1) & 0xFF;
647 Out->SRegLo = (In->SRegLo + 1) & 0xFF;
650 Out->SRegHi = (In->SRegHi + 1) & 0xFF;
653 } else if (E->AM == AM65_ZPX) {
654 /* Invalidates all ZP registers */
655 RC_InvalidateZP (Out);
660 if (RegValIsKnown (In->RegX)) {
661 Out->RegX = (In->RegX + 1) & 0xFF;
666 if (RegValIsKnown (In->RegY)) {
667 Out->RegY = (In->RegY + 1) & 0xFF;
693 /* Get the code info for the function */
694 GetFuncInfo (E->Arg, &Use, &Chg);
696 Out->RegA = UNKNOWN_REGVAL;
699 Out->RegX = UNKNOWN_REGVAL;
702 Out->RegY = UNKNOWN_REGVAL;
704 if (Chg & REG_TMP1) {
705 Out->Tmp1 = UNKNOWN_REGVAL;
707 if (Chg & REG_SREG_LO) {
708 Out->SRegLo = UNKNOWN_REGVAL;
710 if (Chg & REG_SREG_HI) {
711 Out->SRegHi = UNKNOWN_REGVAL;
713 /* ## FIXME: Quick hack for some known functions: */
714 if (strcmp (E->Arg, "tosandax") == 0) {
721 } else if (strcmp (E->Arg, "tosorax") == 0) {
722 if (In->RegA == 0xFF) {
725 if (In->RegX == 0xFF) {
728 } else if (FindBoolCmpCond (E->Arg) != CMP_INV) {
740 if (CE_KnownImm (E)) {
741 Out->RegA = (unsigned char) E->Num;
742 } else if (E->AM == AM65_ZP) {
743 switch (GetKnownReg (E->Use, In)) {
745 Out->RegA = In->Tmp1;
748 Out->RegA = In->SRegLo;
751 Out->RegA = In->SRegHi;
754 Out->RegA = UNKNOWN_REGVAL;
758 /* A is now unknown */
759 Out->RegA = UNKNOWN_REGVAL;
764 if (CE_KnownImm (E)) {
765 Out->RegX = (unsigned char) E->Num;
766 } else if (E->AM == AM65_ZP) {
767 switch (GetKnownReg (E->Use, In)) {
769 Out->RegX = In->Tmp1;
772 Out->RegX = In->SRegLo;
775 Out->RegX = In->SRegHi;
778 Out->RegX = UNKNOWN_REGVAL;
782 /* X is now unknown */
783 Out->RegX = UNKNOWN_REGVAL;
788 if (CE_KnownImm (E)) {
789 Out->RegY = (unsigned char) E->Num;
790 } else if (E->AM == AM65_ZP) {
791 switch (GetKnownReg (E->Use, In)) {
793 Out->RegY = In->Tmp1;
796 Out->RegY = In->SRegLo;
799 Out->RegY = In->SRegHi;
802 Out->RegY = UNKNOWN_REGVAL;
806 /* Y is now unknown */
807 Out->RegY = UNKNOWN_REGVAL;
812 if (E->AM == AM65_ACC && In->RegA >= 0) {
813 Out->RegA = (In->RegA >> 1) & 0xFF;
814 } else if (E->AM == AM65_ZP) {
815 switch (GetKnownReg (E->Chg, In)) {
817 Out->Tmp1 = (In->Tmp1 >> 1) & 0xFF;
820 Out->SRegLo = (In->SRegLo >> 1) & 0xFF;
823 Out->SRegHi = (In->SRegHi >> 1) & 0xFF;
826 } else if (E->AM == AM65_ZPX) {
827 /* Invalidates all ZP registers */
828 RC_InvalidateZP (Out);
836 if (RegValIsKnown (In->RegA)) {
837 if (CE_KnownImm (E)) {
838 Out->RegA = In->RegA | (short) E->Num;
839 } else if (E->AM == AM65_ZP) {
840 switch (GetKnownReg (E->Use, In)) {
842 Out->RegA = In->RegA | In->Tmp1;
845 Out->RegA = In->RegA | In->SRegLo;
848 Out->RegA = In->RegA | In->SRegHi;
851 Out->RegA = UNKNOWN_REGVAL;
855 /* A is now unknown */
856 Out->RegA = UNKNOWN_REGVAL;
889 /* We don't know the value of the carry bit */
890 if (E->AM == AM65_ACC) {
891 Out->RegA = UNKNOWN_REGVAL;
892 } else if (E->AM == AM65_ZP) {
893 switch (GetKnownReg (E->Chg, In)) {
895 Out->Tmp1 = UNKNOWN_REGVAL;
898 Out->SRegLo = UNKNOWN_REGVAL;
901 Out->SRegHi = UNKNOWN_REGVAL;
904 } else if (E->AM == AM65_ZPX) {
905 /* Invalidates all ZP registers */
906 RC_InvalidateZP (Out);
911 /* We don't know the value of the carry bit */
912 if (E->AM == AM65_ACC) {
913 Out->RegA = UNKNOWN_REGVAL;
914 } else if (E->AM == AM65_ZP) {
915 switch (GetKnownReg (E->Chg, In)) {
917 Out->Tmp1 = UNKNOWN_REGVAL;
920 Out->SRegLo = UNKNOWN_REGVAL;
923 Out->SRegHi = UNKNOWN_REGVAL;
926 } else if (E->AM == AM65_ZPX) {
927 /* Invalidates all ZP registers */
928 RC_InvalidateZP (Out);
939 /* We don't know the value of the carry bit */
953 if (E->AM == AM65_ZP) {
954 switch (GetKnownReg (E->Chg, 0)) {
956 Out->Tmp1 = In->RegA;
959 Out->SRegLo = In->RegA;
962 Out->SRegHi = In->RegA;
965 } else if (E->AM == AM65_ZPX) {
966 /* Invalidates all ZP registers */
967 RC_InvalidateZP (Out);
972 if (E->AM == AM65_ZP) {
973 switch (GetKnownReg (E->Chg, 0)) {
975 Out->Tmp1 = In->RegX;
978 Out->SRegLo = In->RegX;
981 Out->SRegHi = In->RegX;
984 } else if (E->AM == AM65_ZPX) {
985 /* Invalidates all ZP registers */
986 RC_InvalidateZP (Out);
991 if (E->AM == AM65_ZP) {
992 switch (GetKnownReg (E->Chg, 0)) {
994 Out->Tmp1 = In->RegY;
997 Out->SRegLo = In->RegY;
1000 Out->SRegHi = In->RegY;
1003 } else if (E->AM == AM65_ZPX) {
1004 /* Invalidates all ZP registers */
1005 RC_InvalidateZP (Out);
1010 if (E->AM == AM65_ZP) {
1011 switch (GetKnownReg (E->Chg, 0)) {
1022 } else if (E->AM == AM65_ZPX) {
1023 /* Invalidates all ZP registers */
1024 RC_InvalidateZP (Out);
1029 Out->RegX = In->RegA;
1033 Out->RegY = In->RegA;
1037 if (E->AM == AM65_ZPX) {
1038 /* Invalidates all ZP registers */
1039 RC_InvalidateZP (Out);
1040 } else if (E->AM == AM65_ZP) {
1041 if (In->RegA >= 0) {
1042 switch (GetKnownReg (E->Chg, In)) {
1044 Out->Tmp1 &= ~In->RegA;
1047 Out->SRegLo &= ~In->RegA;
1050 Out->SRegHi &= ~In->RegA;
1054 switch (GetKnownReg (E->Chg, In)) {
1056 Out->Tmp1 = UNKNOWN_REGVAL;
1059 Out->SRegLo = UNKNOWN_REGVAL;
1062 Out->SRegHi = UNKNOWN_REGVAL;
1070 if (E->AM == AM65_ZPX) {
1071 /* Invalidates all ZP registers */
1072 RC_InvalidateZP (Out);
1073 } else if (E->AM == AM65_ZP) {
1074 if (In->RegA >= 0) {
1075 switch (GetKnownReg (E->Chg, In)) {
1077 Out->Tmp1 |= In->RegA;
1080 Out->SRegLo |= In->RegA;
1083 Out->SRegHi |= In->RegA;
1087 switch (GetKnownReg (E->Chg, In)) {
1089 Out->Tmp1 = UNKNOWN_REGVAL;
1092 Out->SRegLo = UNKNOWN_REGVAL;
1095 Out->SRegHi = UNKNOWN_REGVAL;
1103 Out->RegX = UNKNOWN_REGVAL;
1107 Out->RegA = In->RegX;
1114 Out->RegA = In->RegY;
1125 static char* RegInfoDesc (unsigned U, char* Buf)
1126 /* Return a string containing register info */
1130 strcat (Buf, U & REG_SREG_HI? "H" : "_");
1131 strcat (Buf, U & REG_SREG_LO? "L" : "_");
1132 strcat (Buf, U & REG_A? "A" : "_");
1133 strcat (Buf, U & REG_X? "X" : "_");
1134 strcat (Buf, U & REG_Y? "Y" : "_");
1135 strcat (Buf, U & REG_TMP1? "T1" : "__");
1136 strcat (Buf, U & REG_PTR1? "1" : "_");
1137 strcat (Buf, U & REG_PTR2? "2" : "_");
1138 strcat (Buf, U & REG_SAVE? "V" : "_");
1139 strcat (Buf, U & REG_SP? "S" : "_");
1146 void CE_Output (const CodeEntry* E, FILE* F)
1147 /* Output the code entry to a file */
1153 /* If we have a label, print that */
1154 unsigned LabelCount = CollCount (&E->Labels);
1156 for (I = 0; I < LabelCount; ++I) {
1157 CL_Output (CollConstAt (&E->Labels, I), F);
1160 /* Get the opcode description */
1161 D = GetOPCDesc (E->OPC);
1163 /* Print the mnemonic */
1164 Chars = fprintf (F, "\t%s", D->Mnemo);
1166 /* Print the operand */
1176 Chars += fprintf (F, "%*sa", 9-Chars, "");
1182 Chars += fprintf (F, "%*s#%s", 9-Chars, "", E->Arg);
1188 /* zeropage and absolute */
1189 Chars += fprintf (F, "%*s%s", 9-Chars, "", E->Arg);
1194 /* zeropage,X and absolute,X */
1195 Chars += fprintf (F, "%*s%s,x", 9-Chars, "", E->Arg);
1200 Chars += fprintf (F, "%*s%s,y", 9-Chars, "", E->Arg);
1205 Chars += fprintf (F, "%*s(%s,x)", 9-Chars, "", E->Arg);
1210 Chars += fprintf (F, "%*s(%s),y", 9-Chars, "", E->Arg);
1215 Chars += fprintf (F, "%*s(%s)", 9-Chars, "", E->Arg);
1220 Target = E->JumpTo? E->JumpTo->Name : E->Arg;
1221 Chars += fprintf (F, "%*s%s", 9-Chars, "", Target);
1225 Internal ("Invalid addressing mode");
1229 /* Print usage info if requested by the debugging flag */
1234 "%*s; USE: %-12s CHG: %-12s SIZE: %u\n",
1236 RegInfoDesc (E->Use, Use),
1237 RegInfoDesc (E->Chg, Chg),
1240 /* Terminate the line */