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 /*****************************************************************************/
55 /*****************************************************************************/
57 /*****************************************************************************/
62 static char EmptyArg[] = "";
66 /*****************************************************************************/
67 /* Helper functions */
68 /*****************************************************************************/
72 static void FreeArg (char* Arg)
73 /* Free a code entry argument */
75 if (Arg != EmptyArg) {
82 static char* GetArgCopy (const char* Arg)
83 /* Create an argument copy for assignment */
85 if (Arg && Arg[0] != '\0') {
89 /* Use the empty argument string */
96 static int NumArg (const char* Arg, unsigned long* Num)
97 /* If the given argument is numerical, convert it and return true. Otherwise
98 * set Num to zero and return false.
104 /* Determine the base */
109 } else if (*Arg == '%') {
114 /* Convert the value. strtol is not exactly what we want here, but it's
115 * cheap and may be replaced by something fancier later.
117 Val = strtoul (Arg, &End, Base);
119 /* Check if the conversion was successful */
122 /* Could not convert */
137 static void SetUseChgInfo (CodeEntry* E, const OPCDesc* D)
138 /* Set the Use and Chg in E */
142 /* If this is a subroutine call, or a jump to an external function,
143 * lookup the information about this function and use it. The jump itself
144 * does not change any registers, so we don't need to use the data from D.
146 if ((E->Info & (OF_BRA | OF_CALL)) != 0 && E->JumpTo == 0) {
147 /* A subroutine call or jump to external symbol (function exit) */
148 GetFuncInfo (E->Arg, &E->Use, &E->Chg);
150 /* Some other instruction. Use the values from the opcode description
151 * plus addressing mode info.
153 E->Use = D->Use | GetAMUseInfo (E->AM);
156 /* Check for special zero page registers used */
161 /* Be conservative: */
165 Info = GetZPInfo (E->Arg);
166 if (Info && Info->ByteUse != REG_NONE) {
167 if (E->OPC == OP65_ASL || E->OPC == OP65_DEC ||
168 E->OPC == OP65_INC || E->OPC == OP65_LSR ||
169 E->OPC == OP65_ROL || E->OPC == OP65_ROR ||
170 E->OPC == OP65_TRB || E->OPC == OP65_TSB) {
171 /* The zp loc is both, input and output */
172 E->Chg |= Info->ByteUse;
173 E->Use |= Info->ByteUse;
174 } else if ((E->Info & OF_STORE) != 0) {
176 E->Chg |= Info->ByteUse;
179 E->Use |= Info->ByteUse;
187 Info = GetZPInfo (E->Arg);
188 if (Info && Info->ByteUse != REG_NONE) {
189 /* These addressing modes will never change the zp loc */
190 E->Use |= Info->WordUse;
195 /* Keep gcc silent */
203 static unsigned GetReg (unsigned short Use, const RegContents* RC)
204 /* Map the register info in Use plus the validity into in RI into exactly
208 if ((Use & REG_A) != 0) {
209 return (RC && RC->RegA >= 0)? REG_A : REG_NONE;
210 } else if ((Use & REG_X) != 0) {
211 return (RC && RC->RegX >= 0)? REG_X : REG_NONE;
212 } else if ((Use & REG_Y) != 0) {
213 return (RC && RC->RegY >= 0)? REG_Y : REG_NONE;
214 } else if ((Use & REG_TMP1) != 0) {
215 return (RC && RC->Tmp1 >= 0)? REG_TMP1 : REG_NONE;
216 } else if ((Use & REG_SREG_LO) != 0) {
217 return (RC && RC->SRegLo >= 0)? REG_SREG_LO : REG_NONE;
218 } else if ((Use & REG_SREG_HI) != 0) {
219 return (RC && RC->SRegHi >= 0)? REG_SREG_HI : REG_NONE;
227 /*****************************************************************************/
229 /*****************************************************************************/
233 CodeEntry* NewCodeEntry (opc_t OPC, am_t AM, const char* Arg,
234 CodeLabel* JumpTo, LineInfo* LI)
235 /* Create a new code entry, initialize and return it */
237 /* Get the opcode description */
238 const OPCDesc* D = GetOPCDesc (OPC);
240 /* Allocate memory */
241 CodeEntry* E = xmalloc (sizeof (CodeEntry));
243 /* Initialize the fields */
246 E->Arg = GetArgCopy (Arg);
247 E->Flags = NumArg (E->Arg, &E->Num)? CEF_NUMARG : 0;
249 E->Size = GetInsnSize (E->OPC, E->AM);
251 E->LI = UseLineInfo (LI);
253 SetUseChgInfo (E, D);
254 InitCollection (&E->Labels);
256 /* If we have a label given, add this entry to the label */
258 CollAppend (&JumpTo->JumpFrom, E);
261 /* Return the initialized struct */
267 void FreeCodeEntry (CodeEntry* E)
268 /* Free the given code entry */
270 /* Free the string argument if we have one */
273 /* Cleanup the collection */
274 DoneCollection (&E->Labels);
276 /* Release the line info */
277 ReleaseLineInfo (E->LI);
279 /* Delete the register info */
288 void CE_ReplaceOPC (CodeEntry* E, opc_t OPC)
289 /* Replace the opcode of the instruction. This will also replace related info,
290 * Size, Use and Chg, but it will NOT update any arguments or labels.
293 /* Get the opcode descriptor */
294 const OPCDesc* D = GetOPCDesc (OPC);
296 /* Replace the opcode */
299 E->Size = GetInsnSize (E->OPC, E->AM);
300 SetUseChgInfo (E, D);
305 int CodeEntriesAreEqual (const CodeEntry* E1, const CodeEntry* E2)
306 /* Check if both code entries are equal */
308 return E1->OPC == E2->OPC && E1->AM == E2->AM && strcmp (E1->Arg, E2->Arg) == 0;
313 void CE_AttachLabel (CodeEntry* E, CodeLabel* L)
314 /* Attach the label to the entry */
316 /* Add it to the entries label list */
317 CollAppend (&E->Labels, L);
319 /* Tell the label about it's owner */
325 void CE_MoveLabel (CodeLabel* L, CodeEntry* E)
326 /* Move the code label L from it's former owner to the code entry E. */
328 /* Delete the label from the owner */
329 CollDeleteItem (&L->Owner->Labels, L);
331 /* Set the new owner */
332 CollAppend (&E->Labels, L);
338 void CE_SetNumArg (CodeEntry* E, long Num)
339 /* Set a new numeric argument for the given code entry that must already
340 * have a numeric argument.
345 /* Check that the entry has a numerical argument */
346 CHECK (E->Flags & CEF_NUMARG);
348 /* Make the new argument string */
351 xsprintf (Buf, sizeof (Buf), "$%02X", (unsigned) Num);
352 } else if (E->Size == 3) {
354 xsprintf (Buf, sizeof (Buf), "$%04X", (unsigned) Num);
356 Internal ("Invalid instruction size in CE_SetNumArg");
359 /* Free the old argument */
362 /* Assign the new one */
363 E->Arg = GetArgCopy (Buf);
365 /* Use the new numerical value */
371 int CE_KnownImm (const CodeEntry* E)
372 /* Return true if the argument of E is a known immediate value */
374 return (E->AM == AM65_IMM && (E->Flags & CEF_NUMARG) != 0);
379 void CE_FreeRegInfo (CodeEntry* E)
380 /* Free an existing register info struct */
390 void CE_GenRegInfo (CodeEntry* E, RegContents* InputRegs)
391 /* Generate register info for this instruction. If an old info exists, it is
395 /* Pointers to the register contents */
399 /* Function register usage */
400 unsigned short Use, Chg;
402 /* If we don't have a register info struct, allocate one. */
404 E->RI = NewRegInfo (InputRegs);
407 E->RI->In = *InputRegs;
409 RC_Invalidate (&E->RI->In);
411 E->RI->Out2 = E->RI->Out = E->RI->In;
414 /* Get pointers to the register contents */
418 /* Handle the different instructions */
422 /* We don't know the value of the carry, so the result is
430 if (CE_KnownImm (E)) {
431 Out->RegA = In->RegA & (short) E->Num;
432 } else if (E->AM == AM65_ZP) {
433 switch (GetReg (E->Use, In)) {
435 Out->RegA = In->RegA & In->Tmp1;
438 Out->RegA = In->RegA & In->SRegLo;
441 Out->RegA = In->RegA & In->SRegHi;
454 if (E->AM == AM65_ACC && In->RegA >= 0) {
455 Out->RegA = (In->RegA << 1) & 0xFF;
456 } else if (E->AM == AM65_ZP) {
457 switch (GetReg (E->Chg, In)) {
459 Out->Tmp1 = (In->Tmp1 << 1) & 0xFF;
462 Out->SRegLo = (In->SRegLo << 1) & 0xFF;
465 Out->SRegHi = (In->SRegHi << 1) & 0xFF;
468 } else if (E->AM == AM65_ZPX) {
469 /* Invalidates all ZP registers */
470 RC_InvalidateZP (Out);
530 Out->RegA = (In->RegA - 1) & 0xFF;
535 if (E->AM == AM65_ACC && In->RegA >= 0) {
536 Out->RegA = (In->RegA - 1) & 0xFF;
537 } else if (E->AM == AM65_ZP) {
538 switch (GetReg (E->Chg, In)) {
540 Out->Tmp1 = (In->Tmp1 - 1) & 0xFF;
543 Out->SRegLo = (In->SRegLo - 1) & 0xFF;
546 Out->SRegHi = (In->SRegHi - 1) & 0xFF;
549 } else if (E->AM == AM65_ZPX) {
550 /* Invalidates all ZP registers */
551 RC_InvalidateZP (Out);
557 Out->RegX = (In->RegX - 1) & 0xFF;
563 Out->RegY = (In->RegY - 1) & 0xFF;
569 if (CE_KnownImm (E)) {
570 Out->RegA = In->RegA ^ (short) E->Num;
571 } else if (E->AM == AM65_ZP) {
572 switch (GetReg (E->Use, In)) {
574 Out->RegA = In->RegA ^ In->Tmp1;
577 Out->RegA = In->RegA ^ In->SRegLo;
580 Out->RegA = In->RegA ^ In->SRegHi;
594 Out->RegA = (In->RegA + 1) & 0xFF;
599 if (E->AM == AM65_ACC && In->RegA >= 0) {
600 Out->RegA = (In->RegA + 1) & 0xFF;
601 } else if (E->AM == AM65_ZP) {
602 switch (GetReg (E->Chg, In)) {
604 Out->Tmp1 = (In->Tmp1 + 1) & 0xFF;
607 Out->SRegLo = (In->SRegLo + 1) & 0xFF;
610 Out->SRegHi = (In->SRegHi + 1) & 0xFF;
613 } else if (E->AM == AM65_ZPX) {
614 /* Invalidates all ZP registers */
615 RC_InvalidateZP (Out);
621 Out->RegX = (In->RegX + 1) & 0xFF;
627 Out->RegY = (In->RegY + 1) & 0xFF;
653 /* Get the code info for the function */
654 GetFuncInfo (E->Arg, &Use, &Chg);
664 if (Chg & REG_TMP1) {
667 if (Chg & REG_SREG_LO) {
670 if (Chg & REG_SREG_HI) {
682 if (CE_KnownImm (E)) {
683 Out->RegA = (unsigned char) E->Num;
684 } else if (E->AM == AM65_ZP) {
685 switch (GetReg (E->Use, In)) {
687 Out->RegA = In->Tmp1;
690 Out->RegA = In->SRegLo;
693 Out->RegA = In->SRegHi;
700 /* A is now unknown */
706 if (CE_KnownImm (E)) {
707 Out->RegX = (unsigned char) E->Num;
708 } else if (E->AM == AM65_ZP) {
709 switch (GetReg (E->Use, In)) {
711 Out->RegX = In->Tmp1;
714 Out->RegX = In->SRegLo;
717 Out->RegX = In->SRegHi;
724 /* X is now unknown */
730 if (CE_KnownImm (E)) {
731 Out->RegY = (unsigned char) E->Num;
732 } else if (E->AM == AM65_ZP) {
733 switch (GetReg (E->Use, In)) {
735 Out->RegY = In->Tmp1;
738 Out->RegY = In->SRegLo;
741 Out->RegY = In->SRegHi;
748 /* Y is now unknown */
754 if (E->AM == AM65_ACC && In->RegA >= 0) {
755 Out->RegA = (In->RegA >> 1) & 0xFF;
756 } else if (E->AM == AM65_ZP) {
757 switch (GetReg (E->Chg, In)) {
759 Out->Tmp1 = (In->Tmp1 >> 1) & 0xFF;
762 Out->SRegLo = (In->SRegLo >> 1) & 0xFF;
765 Out->SRegHi = (In->SRegHi >> 1) & 0xFF;
768 } else if (E->AM == AM65_ZPX) {
769 /* Invalidates all ZP registers */
770 RC_InvalidateZP (Out);
779 if (CE_KnownImm (E)) {
780 Out->RegA = In->RegA | (short) E->Num;
781 } else if (E->AM == AM65_ZP) {
782 switch (GetReg (E->Use, In)) {
784 Out->RegA = In->RegA | In->Tmp1;
787 Out->RegA = In->RegA | In->SRegLo;
790 Out->RegA = In->RegA | In->SRegHi;
797 /* A is now unknown */
831 /* We don't know the value of the carry bit */
832 if (E->AM == AM65_ACC) {
834 } else if (E->AM == AM65_ZP) {
835 switch (GetReg (E->Chg, In)) {
846 } else if (E->AM == AM65_ZPX) {
847 /* Invalidates all ZP registers */
848 RC_InvalidateZP (Out);
853 /* We don't know the value of the carry bit */
854 if (E->AM == AM65_ACC) {
856 } else if (E->AM == AM65_ZP) {
857 switch (GetReg (E->Chg, In)) {
868 } else if (E->AM == AM65_ZPX) {
869 /* Invalidates all ZP registers */
870 RC_InvalidateZP (Out);
881 /* We don't know the value of the carry bit */
895 if (E->AM == AM65_ZP) {
896 switch (GetReg (E->Chg, 0)) {
898 Out->Tmp1 = In->RegA;
901 Out->SRegLo = In->RegA;
904 Out->SRegHi = In->RegA;
907 } else if (E->AM == AM65_ZPX) {
908 /* Invalidates all ZP registers */
909 RC_InvalidateZP (Out);
914 if (E->AM == AM65_ZP) {
915 switch (GetReg (E->Chg, 0)) {
917 Out->Tmp1 = In->RegX;
920 Out->SRegLo = In->RegX;
923 Out->SRegHi = In->RegX;
926 } else if (E->AM == AM65_ZPX) {
927 /* Invalidates all ZP registers */
928 RC_InvalidateZP (Out);
933 if (E->AM == AM65_ZP) {
934 switch (GetReg (E->Chg, 0)) {
936 Out->Tmp1 = In->RegY;
939 Out->SRegLo = In->RegY;
942 Out->SRegHi = In->RegY;
945 } else if (E->AM == AM65_ZPX) {
946 /* Invalidates all ZP registers */
947 RC_InvalidateZP (Out);
952 if (E->AM == AM65_ZP) {
953 switch (GetReg (E->Chg, 0)) {
964 } else if (E->AM == AM65_ZPX) {
965 /* Invalidates all ZP registers */
966 RC_InvalidateZP (Out);
971 Out->RegX = In->RegA;
975 Out->RegY = In->RegA;
979 if (E->AM == AM65_ZPX) {
980 /* Invalidates all ZP registers */
981 RC_InvalidateZP (Out);
982 } else if (E->AM == AM65_ZP) {
984 switch (GetReg (E->Chg, In)) {
986 Out->Tmp1 &= ~In->RegA;
989 Out->SRegLo &= ~In->RegA;
992 Out->SRegHi &= ~In->RegA;
996 switch (GetReg (E->Chg, In)) {
1012 if (E->AM == AM65_ZPX) {
1013 /* Invalidates all ZP registers */
1014 RC_InvalidateZP (Out);
1015 } else if (E->AM == AM65_ZP) {
1016 if (In->RegA >= 0) {
1017 switch (GetReg (E->Chg, In)) {
1019 Out->Tmp1 |= In->RegA;
1022 Out->SRegLo |= In->RegA;
1025 Out->SRegHi |= In->RegA;
1029 switch (GetReg (E->Chg, In)) {
1049 Out->RegA = In->RegX;
1056 Out->RegA = In->RegY;
1067 static char* RegInfoDesc (unsigned U, char* Buf)
1068 /* Return a string containing register info */
1072 strcat (Buf, U & REG_SREG_HI? "H" : "_");
1073 strcat (Buf, U & REG_SREG_LO? "L" : "_");
1074 strcat (Buf, U & REG_A? "A" : "_");
1075 strcat (Buf, U & REG_X? "X" : "_");
1076 strcat (Buf, U & REG_Y? "Y" : "_");
1077 strcat (Buf, U & REG_TMP1? "T1" : "__");
1078 strcat (Buf, U & REG_PTR1? "1" : "_");
1079 strcat (Buf, U & REG_PTR2? "2" : "_");
1080 strcat (Buf, U & REG_SAVE? "V" : "_");
1087 void CE_Output (const CodeEntry* E, FILE* F)
1088 /* Output the code entry to a file */
1094 /* If we have a label, print that */
1095 unsigned LabelCount = CollCount (&E->Labels);
1097 for (I = 0; I < LabelCount; ++I) {
1098 CL_Output (CollConstAt (&E->Labels, I), F);
1101 /* Get the opcode description */
1102 D = GetOPCDesc (E->OPC);
1104 /* Print the mnemonic */
1105 Chars = fprintf (F, "\t%s", D->Mnemo);
1107 /* Print the operand */
1117 Chars += fprintf (F, "%*sa", 9-Chars, "");
1123 Chars += fprintf (F, "%*s#%s", 9-Chars, "", E->Arg);
1129 /* zeropage and absolute */
1130 Chars += fprintf (F, "%*s%s", 9-Chars, "", E->Arg);
1135 /* zeropage,X and absolute,X */
1136 Chars += fprintf (F, "%*s%s,x", 9-Chars, "", E->Arg);
1141 Chars += fprintf (F, "%*s%s,y", 9-Chars, "", E->Arg);
1146 Chars += fprintf (F, "%*s(%s,x)", 9-Chars, "", E->Arg);
1151 Chars += fprintf (F, "%*s(%s),y", 9-Chars, "", E->Arg);
1156 Chars += fprintf (F, "%*s(%s)", 9-Chars, "", E->Arg);
1161 Target = E->JumpTo? E->JumpTo->Name : E->Arg;
1162 Chars += fprintf (F, "%*s%s", 9-Chars, "", Target);
1166 Internal ("Invalid addressing mode");
1170 /* Print usage info if requested by the debugging flag */
1175 "%*s; USE: %-20s CHG: %-20s SIZE: %u\n",
1177 RegInfoDesc (E->Use, Use),
1178 RegInfoDesc (E->Chg, Chg),
1181 /* Terminate the line */