1 /*****************************************************************************/
5 /* Code segment structure */
9 /* (C) 2001 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 /*****************************************************************************/
59 /*****************************************************************************/
60 /* Helper functions */
61 /*****************************************************************************/
65 static void CS_MoveLabelsToEntry (CodeSeg* S, CodeEntry* E)
66 /* Move all labels from the label pool to the given entry and remove them
70 /* Transfer the labels if we have any */
72 unsigned LabelCount = CollCount (&S->Labels);
73 for (I = 0; I < LabelCount; ++I) {
76 CodeLabel* L = CollAt (&S->Labels, I);
78 /* Attach it to the entry */
79 CE_AttachLabel (E, L);
82 /* Delete the transfered labels */
83 CollDeleteAll (&S->Labels);
88 static void CS_MoveLabelsToPool (CodeSeg* S, CodeEntry* E)
89 /* Move the labels of the code entry E to the label pool of the code segment */
91 unsigned LabelCount = CE_GetLabelCount (E);
92 while (LabelCount--) {
93 CodeLabel* L = CE_GetLabel (E, LabelCount);
95 CollAppend (&S->Labels, L);
97 CollDeleteAll (&E->Labels);
102 static CodeLabel* CS_FindLabel (CodeSeg* S, const char* Name, unsigned Hash)
103 /* Find the label with the given name. Return the label or NULL if not found */
105 /* Get the first hash chain entry */
106 CodeLabel* L = S->LabelHash[Hash];
108 /* Search the list */
110 if (strcmp (Name, L->Name) == 0) {
121 static CodeLabel* CS_NewCodeLabel (CodeSeg* S, const char* Name, unsigned Hash)
122 /* Create a new label and insert it into the label hash table */
124 /* Create a new label */
125 CodeLabel* L = NewCodeLabel (Name, Hash);
127 /* Enter the label into the hash table */
128 L->Next = S->LabelHash[L->Hash];
129 S->LabelHash[L->Hash] = L;
131 /* Return the new label */
137 static void CS_RemoveLabelFromHash (CodeSeg* S, CodeLabel* L)
138 /* Remove the given code label from the hash list */
140 /* Get the first entry in the hash chain */
141 CodeLabel* List = S->LabelHash[L->Hash];
144 /* First, remove the label from the hash chain */
146 /* First entry in hash chain */
147 S->LabelHash[L->Hash] = L->Next;
149 /* Must search through the chain */
150 while (List->Next != L) {
151 /* If we've reached the end of the chain, something is *really* wrong */
152 CHECK (List->Next != 0);
156 /* The next entry is the one, we have been searching for */
157 List->Next = L->Next;
163 /*****************************************************************************/
164 /* Functions for parsing instructions */
165 /*****************************************************************************/
169 static const char* SkipSpace (const char* S)
170 /* Skip white space and return an updated pointer */
172 while (IsSpace (*S)) {
180 static const char* ReadToken (const char* L, const char* Term,
181 char* Buf, unsigned BufSize)
182 /* Read the next token into Buf, return the updated line pointer. The
183 * token is terminated by one of the characters given in term.
186 /* Read/copy the token */
188 unsigned ParenCount = 0;
189 while (*L && (ParenCount > 0 || strchr (Term, *L) == 0)) {
195 } else if (*L == '(') {
201 /* Terminate the buffer contents */
204 /* Return the updated line pointer */
210 static CodeEntry* ParseInsn (CodeSeg* S, LineInfo* LI, const char* L)
211 /* Parse an instruction nnd generate a code entry from it. If the line contains
212 * errors, output an error message and return NULL.
213 * For simplicity, we don't accept the broad range of input a "real" assembler
214 * does. The instruction and the argument are expected to be separated by
215 * white space, for example.
220 am_t AM = 0; /* Initialize to keep gcc silent */
227 L = ReadToken (L, " \t", Mnemo, sizeof (Mnemo));
229 /* Try to find the opcode description for the mnemonic */
230 OPC = FindOP65 (Mnemo);
232 /* If we didn't find the opcode, print an error and bail out */
234 Error ("ASM code error: %s is not a valid mnemonic", Mnemo);
238 /* Skip separator white space */
241 /* Get the addressing mode */
252 StrCopy (Arg, sizeof (Arg), L+1);
258 L = ReadToken (L+1, ",)", Arg, sizeof (Arg));
260 /* Check for errors */
262 Error ("ASM code error: syntax error");
266 /* Check the different indirect modes */
268 /* Expect zp x indirect */
270 if (toupper (*L) != 'X') {
271 Error ("ASM code error: `X' expected");
276 Error ("ASM code error: `)' expected");
281 Error ("ASM code error: syntax error");
285 } else if (*L == ')') {
286 /* zp indirect or zp indirect, y */
290 if (toupper (*L) != 'Y') {
291 Error ("ASM code error: `Y' expected");
296 Error ("ASM code error: syntax error");
300 } else if (*L == '\0') {
303 Error ("ASM code error: syntax error");
319 /* Absolute, maybe indexed */
320 L = ReadToken (L, ",", Arg, sizeof (Arg));
322 /* Absolute, zeropage or branch */
323 if ((OPC->Info & OF_BRA) != 0) {
326 } else if (IsZPName (Arg)) {
331 } else if (*L == ',') {
335 Error ("ASM code error: syntax error");
341 if (IsZPName (Arg)) {
346 } else if (Reg == 'Y') {
349 Error ("ASM code error: syntax error");
353 Error ("ASM code error: syntax error");
362 /* If the instruction is a branch, check for the label and generate it
363 * if it does not exist. Ignore anything but local labels here.
366 if (AM == AM65_BRA && Arg[0] == 'L') {
368 /* Generate the hash over the label, then search for the label */
369 unsigned Hash = HashStr (Arg) % CS_LABEL_HASH_SIZE;
370 Label = CS_FindLabel (S, Arg, Hash);
372 /* If we don't have the label, it's a forward ref - create it */
374 /* Generate a new label */
375 Label = CS_NewCodeLabel (S, Arg, Hash);
379 /* We do now have the addressing mode in AM. Allocate a new CodeEntry
380 * structure and initialize it.
382 E = NewCodeEntry (OPC->OPC, AM, Arg, Label, LI);
384 /* Return the new code entry */
390 /*****************************************************************************/
392 /*****************************************************************************/
396 CodeSeg* NewCodeSeg (const char* SegName, SymEntry* Func)
397 /* Create a new code segment, initialize and return it */
401 /* Allocate memory */
402 CodeSeg* S = xmalloc (sizeof (CodeSeg));
404 /* Initialize the fields */
405 S->SegName = xstrdup (SegName);
407 InitCollection (&S->Entries);
408 InitCollection (&S->Labels);
409 for (I = 0; I < sizeof(S->LabelHash) / sizeof(S->LabelHash[0]); ++I) {
413 /* If we have a function given, get the return type of the function.
414 * Assume ANY return type besides void will use the A and X registers.
416 if (S->Func && !IsTypeVoid (GetFuncReturn (Func->Type))) {
417 S->ExitRegs = REG_AX;
419 S->ExitRegs = REG_NONE;
422 /* Return the new struct */
428 void CS_AddEntry (CodeSeg* S, struct CodeEntry* E)
429 /* Add an entry to the given code segment */
431 /* Transfer the labels if we have any */
432 CS_MoveLabelsToEntry (S, E);
434 /* Add the entry to the list of code entries in this segment */
435 CollAppend (&S->Entries, E);
440 void CS_AddLine (CodeSeg* S, LineInfo* LI, const char* Format, va_list ap)
441 /* Add a line to the given code segment */
447 /* Format the line */
449 xvsprintf (Buf, sizeof (Buf), Format, ap);
451 /* Skip whitespace */
454 /* Check which type of instruction we have */
455 E = 0; /* Assume no insn created */
459 /* Empty line, just ignore it */
463 /* Comment or hint, ignore it for now */
467 /* Control instruction */
468 ReadToken (L, " \t", Token, sizeof (Token));
469 Error ("ASM code error: Pseudo instruction `%s' not supported", Token);
473 E = ParseInsn (S, LI, L);
477 /* If we have a code entry, transfer the labels and insert it */
485 void CS_InsertEntry (CodeSeg* S, struct CodeEntry* E, unsigned Index)
486 /* Insert the code entry at the index given. Following code entries will be
487 * moved to slots with higher indices.
490 /* Insert the entry into the collection */
491 CollInsert (&S->Entries, E, Index);
496 void CS_DelEntry (CodeSeg* S, unsigned Index)
497 /* Delete an entry from the code segment. This includes moving any associated
498 * labels, removing references to labels and even removing the referenced labels
499 * if the reference count drops to zero.
502 /* Get the code entry for the given index */
503 CodeEntry* E = CS_GetEntry (S, Index);
505 /* If the entry has a labels, we have to move this label to the next insn.
506 * If there is no next insn, move the label into the code segement label
507 * pool. The operation is further complicated by the fact that the next
508 * insn may already have a label. In that case change all reference to
509 * this label and delete the label instead of moving it.
511 unsigned Count = CE_GetLabelCount (E);
514 /* The instruction has labels attached. Check if there is a next
517 if (Index == CS_GetEntryCount (S)-1) {
519 /* No next instruction, move to the codeseg label pool */
520 CS_MoveLabelsToPool (S, E);
524 /* There is a next insn, get it */
525 CodeEntry* N = CS_GetEntry (S, Index+1);
527 /* Move labels to the next entry */
528 CS_MoveLabels (S, E, N);
533 /* If this insn references a label, remove the reference. And, if the
534 * the reference count for this label drops to zero, remove this label.
537 /* Remove the reference */
538 CS_RemoveLabelRef (S, E);
541 /* Delete the pointer to the insn */
542 CollDelete (&S->Entries, Index);
544 /* Delete the instruction itself */
550 void CS_DelEntries (CodeSeg* S, unsigned Start, unsigned Count)
551 /* Delete a range of code entries. This includes removing references to labels,
552 * labels attached to the entries and so on.
555 /* Start deleting the entries from the rear, because this involves less
559 CS_DelEntry (S, Start + Count);
565 void CS_MoveEntries (CodeSeg* S, unsigned Start, unsigned Count, unsigned NewPos)
566 /* Move a range of entries from one position to another. Start is the index
567 * of the first entry to move, Count is the number of entries and NewPos is
568 * the index of the target entry. The entry with the index Start will later
569 * have the index NewPos. All entries with indices NewPos and above are
570 * moved to higher indices. If the code block is moved to the end of the
571 * current code, and if pending labels exist, these labels will get attached
572 * to the first instruction of the moved block (the first one after the
576 /* If NewPos is at the end of the code segment, move any labels from the
577 * label pool to the first instruction of the moved range.
579 if (NewPos == CS_GetEntryCount (S)) {
580 CS_MoveLabelsToEntry (S, CS_GetEntry (S, Start));
583 /* Move the code block to the destination */
584 CollMoveMultiple (&S->Entries, Start, Count, NewPos);
589 struct CodeEntry* CS_GetNextEntry (CodeSeg* S, unsigned Index)
590 /* Get the code entry following the one with the index Index. If there is no
591 * following code entry, return NULL.
594 if (Index >= CollCount (&S->Entries)-1) {
595 /* This is the last entry */
598 /* Code entries left */
599 return CollAtUnchecked (&S->Entries, Index+1);
605 int CS_GetEntries (CodeSeg* S, struct CodeEntry** List,
606 unsigned Start, unsigned Count)
607 /* Get Count code entries into List starting at index start. Return true if
608 * we got the lines, return false if not enough lines were available.
611 /* Check if enough entries are available */
612 if (Start + Count > CollCount (&S->Entries)) {
616 /* Copy the entries */
618 *List++ = CollAtUnchecked (&S->Entries, Start++);
621 /* We have the entries */
627 unsigned CS_GetEntryIndex (CodeSeg* S, struct CodeEntry* E)
628 /* Return the index of a code entry */
630 int Index = CollIndex (&S->Entries, E);
637 CodeLabel* CS_AddLabel (CodeSeg* S, const char* Name)
638 /* Add a code label for the next instruction to follow */
640 /* Calculate the hash from the name */
641 unsigned Hash = HashStr (Name) % CS_LABEL_HASH_SIZE;
643 /* Try to find the code label if it does already exist */
644 CodeLabel* L = CS_FindLabel (S, Name, Hash);
646 /* Did we find it? */
648 /* We found it - be sure it does not already have an owner */
649 CHECK (L->Owner == 0);
651 /* Not found - create a new one */
652 L = CS_NewCodeLabel (S, Name, Hash);
655 /* Safety. This call is quite costly, but safety is better */
656 if (CollIndex (&S->Labels, L) >= 0) {
657 Internal ("AddCodeLabel: Label `%s' already defined", Name);
660 /* We do now have a valid label. Remember it for later */
661 CollAppend (&S->Labels, L);
663 /* Return the label */
669 CodeLabel* CS_GenLabel (CodeSeg* S, struct CodeEntry* E)
670 /* If the code entry E does already have a label, return it. Otherwise
671 * create a new label, attach it to E and return it.
676 if (CE_HasLabel (E)) {
678 /* Get the label from this entry */
679 L = CE_GetLabel (E, 0);
684 const char* Name = LocalLabelName (GetLocalLabel ());
686 /* Generate the hash over the name */
687 unsigned Hash = HashStr (Name) % CS_LABEL_HASH_SIZE;
689 /* Create a new label */
690 L = CS_NewCodeLabel (S, Name, Hash);
692 /* Attach this label to the code entry */
693 CE_AttachLabel (E, L);
697 /* Return the label */
703 void CS_DelLabel (CodeSeg* S, CodeLabel* L)
704 /* Remove references from this label and delete it. */
708 /* First, remove the label from the hash chain */
709 CS_RemoveLabelFromHash (S, L);
711 /* Remove references from insns jumping to this label */
712 Count = CollCount (&L->JumpFrom);
713 for (I = 0; I < Count; ++I) {
714 /* Get the insn referencing this label */
715 CodeEntry* E = CollAt (&L->JumpFrom, I);
716 /* Remove the reference */
719 CollDeleteAll (&L->JumpFrom);
721 /* Remove the reference to the owning instruction if it has one. The
722 * function may be called for a label without an owner when deleting
723 * unfinished parts of the code. This is unfortunate since it allows
724 * errors to slip through.
727 CollDeleteItem (&L->Owner->Labels, L);
730 /* All references removed, delete the label itself */
736 void CS_MergeLabels (CodeSeg* S)
737 /* Merge code labels. That means: For each instruction, remove all labels but
738 * one and adjust references accordingly.
743 /* Walk over all code entries */
744 for (I = 0; I < CS_GetEntryCount (S); ++I) {
749 /* Get a pointer to the next entry */
750 CodeEntry* E = CS_GetEntry (S, I);
752 /* If this entry has zero labels, continue with the next one */
753 unsigned LabelCount = CE_GetLabelCount (E);
754 if (LabelCount == 0) {
758 /* We have at least one label. Use the first one as reference label. */
759 RefLab = CE_GetLabel (E, 0);
761 /* Walk through the remaining labels and change references to these
762 * labels to a reference to the one and only label. Delete the labels
763 * that are no longer used. To increase performance, walk backwards
766 for (J = LabelCount-1; J >= 1; --J) {
768 /* Get the next label */
769 CodeLabel* L = CE_GetLabel (E, J);
771 /* Move all references from this label to the reference label */
772 CL_MoveRefs (L, RefLab);
774 /* Remove the label completely. */
778 /* The reference label is the only remaining label. Check if there
779 * are any references to this label, and delete it if this is not
782 if (CollCount (&RefLab->JumpFrom) == 0) {
783 /* Delete the label */
784 CS_DelLabel (S, RefLab);
791 void CS_MoveLabels (CodeSeg* S, struct CodeEntry* Old, struct CodeEntry* New)
792 /* Move all labels from Old to New. The routine will move the labels itself
793 * if New does not have any labels, and move references if there is at least
794 * a label for new. If references are moved, the old label is deleted
798 /* Get the number of labels to move */
799 unsigned OldLabelCount = CE_GetLabelCount (Old);
801 /* Does the new entry have itself a label? */
802 if (CE_HasLabel (New)) {
804 /* The new entry does already have a label - move references */
805 CodeLabel* NewLabel = CE_GetLabel (New, 0);
806 while (OldLabelCount--) {
808 /* Get the next label */
809 CodeLabel* OldLabel = CE_GetLabel (Old, OldLabelCount);
811 /* Move references */
812 CL_MoveRefs (OldLabel, NewLabel);
814 /* Delete the label */
815 CS_DelLabel (S, OldLabel);
821 /* The new entry does not have a label, just move them */
822 while (OldLabelCount--) {
824 /* Move the label to the new entry */
825 CE_MoveLabel (CE_GetLabel (Old, OldLabelCount), New);
834 void CS_RemoveLabelRef (CodeSeg* S, struct CodeEntry* E)
835 /* Remove the reference between E and the label it jumps to. The reference
836 * will be removed on both sides and E->JumpTo will be 0 after that. If
837 * the reference was the only one for the label, the label will get
841 /* Get a pointer to the label and make sure it exists */
842 CodeLabel* L = E->JumpTo;
845 /* Delete the entry from the label */
846 CollDeleteItem (&L->JumpFrom, E);
848 /* The entry jumps no longer to L */
851 /* If there are no more references, delete the label */
852 if (CollCount (&L->JumpFrom) == 0) {
859 void CS_MoveLabelRef (CodeSeg* S, struct CodeEntry* E, CodeLabel* L)
860 /* Change the reference of E to L instead of the current one. If this
861 * was the only reference to the old label, the old label will get
865 /* Get the old label */
866 CodeLabel* OldLabel = E->JumpTo;
868 /* Be sure that code entry references a label */
869 PRECONDITION (OldLabel != 0);
871 /* Remove the reference to our label */
872 CS_RemoveLabelRef (S, E);
874 /* Use the new label */
880 void CS_DelCodeAfter (CodeSeg* S, unsigned Last)
881 /* Delete all entries including the given one */
883 /* Get the number of entries in this segment */
884 unsigned Count = CS_GetEntryCount (S);
886 /* First pass: Delete all references to labels. If the reference count
887 * for a label drops to zero, delete it.
892 /* Get the next entry */
893 CodeEntry* E = CS_GetEntry (S, C);
895 /* Check if this entry has a label reference */
897 /* If the label is a label in the label pool and this is the last
898 * reference to the label, remove the label from the pool.
900 CodeLabel* L = E->JumpTo;
901 int Index = CollIndex (&S->Labels, L);
902 if (Index >= 0 && CollCount (&L->JumpFrom) == 1) {
903 /* Delete it from the pool */
904 CollDelete (&S->Labels, Index);
907 /* Remove the reference to the label */
908 CS_RemoveLabelRef (S, E);
913 /* Second pass: Delete the instructions. If a label attached to an
914 * instruction still has references, it must be references from outside
915 * the deleted area. Don't delete the label in this case, just make it
916 * ownerless and move it to the label pool.
921 /* Get the next entry */
922 CodeEntry* E = CS_GetEntry (S, C);
924 /* Check if this entry has a label attached */
925 if (CE_HasLabel (E)) {
926 /* Move the labels to the pool and clear the owner pointer */
927 CS_MoveLabelsToPool (S, E);
930 /* Delete the pointer to the entry */
931 CollDelete (&S->Entries, C);
933 /* Delete the entry itself */
940 void CS_Output (const CodeSeg* S, FILE* F)
941 /* Output the code segment data to a file */
946 /* Get the number of entries in this segment */
947 unsigned Count = CS_GetEntryCount (S);
949 /* If the code segment is empty, bail out here */
954 /* Output the segment directive */
955 fprintf (F, ".segment\t\"%s\"\n\n", S->SegName);
957 /* If this is a segment for a function, enter a function */
959 fprintf (F, ".proc\t_%s\n\n", S->Func->Name);
962 /* Output all entries, prepended by the line information if it has changed */
964 for (I = 0; I < Count; ++I) {
965 /* Get the next entry */
966 const CodeEntry* E = CollConstAt (&S->Entries, I);
967 /* Check if the line info has changed. If so, output the source line
968 * if the option is enabled and output debug line info if the debug
972 /* Line info has changed, remember the new line info */
975 /* Add the source line as a comment */
977 fprintf (F, ";\n; %s\n;\n", LI->Line);
980 /* Add line debug info */
982 fprintf (F, "\t.dbg\tline, \"%s\", %u\n",
983 GetInputName (LI), GetInputLine (LI));
986 /* Output the code */
990 /* If debug info is enabled, terminate the last line number information */
992 fprintf (F, "\t.dbg\tline\n");
995 /* If this is a segment for a function, leave the function */
997 fprintf (F, "\n.endproc\n\n");