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_MoveLabelsToPool (CodeSeg* S, CodeEntry* E)
66 /* Move the labels of the code entry E to the label pool of the code segment */
68 unsigned LabelCount = CE_GetLabelCount (E);
69 while (LabelCount--) {
70 CodeLabel* L = CE_GetLabel (E, LabelCount);
72 CollAppend (&S->Labels, L);
74 CollDeleteAll (&E->Labels);
79 static CodeLabel* CS_FindLabel (CodeSeg* S, const char* Name, unsigned Hash)
80 /* Find the label with the given name. Return the label or NULL if not found */
82 /* Get the first hash chain entry */
83 CodeLabel* L = S->LabelHash[Hash];
87 if (strcmp (Name, L->Name) == 0) {
98 static CodeLabel* CS_NewCodeLabel (CodeSeg* S, const char* Name, unsigned Hash)
99 /* Create a new label and insert it into the label hash table */
101 /* Create a new label */
102 CodeLabel* L = NewCodeLabel (Name, Hash);
104 /* Enter the label into the hash table */
105 L->Next = S->LabelHash[L->Hash];
106 S->LabelHash[L->Hash] = L;
108 /* Return the new label */
114 static void CS_RemoveLabelFromHash (CodeSeg* S, CodeLabel* L)
115 /* Remove the given code label from the hash list */
117 /* Get the first entry in the hash chain */
118 CodeLabel* List = S->LabelHash[L->Hash];
121 /* First, remove the label from the hash chain */
123 /* First entry in hash chain */
124 S->LabelHash[L->Hash] = L->Next;
126 /* Must search through the chain */
127 while (List->Next != L) {
128 /* If we've reached the end of the chain, something is *really* wrong */
129 CHECK (List->Next != 0);
133 /* The next entry is the one, we have been searching for */
134 List->Next = L->Next;
140 /*****************************************************************************/
141 /* Functions for parsing instructions */
142 /*****************************************************************************/
146 static const char* SkipSpace (const char* S)
147 /* Skip white space and return an updated pointer */
149 while (IsSpace (*S)) {
157 static const char* ReadToken (const char* L, const char* Term,
158 char* Buf, unsigned BufSize)
159 /* Read the next token into Buf, return the updated line pointer. The
160 * token is terminated by one of the characters given in term.
163 /* Read/copy the token */
165 unsigned ParenCount = 0;
166 while (*L && (ParenCount > 0 || strchr (Term, *L) == 0)) {
172 } else if (*L == '(') {
178 /* Terminate the buffer contents */
181 /* Return the updated line pointer */
187 static CodeEntry* ParseInsn (CodeSeg* S, LineInfo* LI, const char* L)
188 /* Parse an instruction nnd generate a code entry from it. If the line contains
189 * errors, output an error message and return NULL.
190 * For simplicity, we don't accept the broad range of input a "real" assembler
191 * does. The instruction and the argument are expected to be separated by
192 * white space, for example.
197 am_t AM = 0; /* Initialize to keep gcc silent */
204 L = ReadToken (L, " \t", Mnemo, sizeof (Mnemo));
206 /* Try to find the opcode description for the mnemonic */
207 OPC = FindOP65 (Mnemo);
209 /* If we didn't find the opcode, print an error and bail out */
211 Error ("ASM code error: %s is not a valid mnemonic", Mnemo);
215 /* Skip separator white space */
218 /* Get the addressing mode */
229 StrCopy (Arg, sizeof (Arg), L+1);
235 L = ReadToken (L+1, ",)", Arg, sizeof (Arg));
237 /* Check for errors */
239 Error ("ASM code error: syntax error");
243 /* Check the different indirect modes */
245 /* Expect zp x indirect */
247 if (toupper (*L) != 'X') {
248 Error ("ASM code error: `X' expected");
253 Error ("ASM code error: `)' expected");
258 Error ("ASM code error: syntax error");
262 } else if (*L == ')') {
263 /* zp indirect or zp indirect, y */
267 if (toupper (*L) != 'Y') {
268 Error ("ASM code error: `Y' expected");
273 Error ("ASM code error: syntax error");
277 } else if (*L == '\0') {
280 Error ("ASM code error: syntax error");
296 /* Absolute, maybe indexed */
297 L = ReadToken (L, ",", Arg, sizeof (Arg));
299 /* Absolute, zeropage or branch */
300 if ((OPC->Info & OF_BRA) != 0) {
303 } else if (IsZPName (Arg)) {
308 } else if (*L == ',') {
312 Error ("ASM code error: syntax error");
318 if (IsZPName (Arg)) {
323 } else if (Reg == 'Y') {
326 Error ("ASM code error: syntax error");
330 Error ("ASM code error: syntax error");
339 /* If the instruction is a branch, check for the label and generate it
340 * if it does not exist. Ignore anything but local labels here.
343 if (AM == AM65_BRA && Arg[0] == 'L') {
345 /* Generate the hash over the label, then search for the label */
346 unsigned Hash = HashStr (Arg) % CS_LABEL_HASH_SIZE;
347 Label = CS_FindLabel (S, Arg, Hash);
349 /* If we don't have the label, it's a forward ref - create it */
351 /* Generate a new label */
352 Label = CS_NewCodeLabel (S, Arg, Hash);
356 /* We do now have the addressing mode in AM. Allocate a new CodeEntry
357 * structure and initialize it.
359 E = NewCodeEntry (OPC->OPC, AM, Arg, Label, LI);
361 /* Return the new code entry */
367 /*****************************************************************************/
369 /*****************************************************************************/
373 CodeSeg* NewCodeSeg (const char* SegName, SymEntry* Func)
374 /* Create a new code segment, initialize and return it */
378 /* Allocate memory */
379 CodeSeg* S = xmalloc (sizeof (CodeSeg));
381 /* Initialize the fields */
382 S->SegName = xstrdup (SegName);
384 InitCollection (&S->Entries);
385 InitCollection (&S->Labels);
386 for (I = 0; I < sizeof(S->LabelHash) / sizeof(S->LabelHash[0]); ++I) {
390 /* If we have a function given, get the return type of the function.
391 * Assume ANY return type besides void will use the A and X registers.
393 if (S->Func && !IsTypeVoid (GetFuncReturn (Func->Type))) {
394 S->ExitRegs = REG_AX;
396 S->ExitRegs = REG_NONE;
399 /* Return the new struct */
405 void CS_AddEntry (CodeSeg* S, struct CodeEntry* E)
406 /* Add an entry to the given code segment */
408 /* Transfer the labels if we have any */
410 unsigned LabelCount = CollCount (&S->Labels);
411 for (I = 0; I < LabelCount; ++I) {
414 CodeLabel* L = CollAt (&S->Labels, I);
416 /* Attach it to the entry */
417 CE_AttachLabel (E, L);
420 /* Delete the transfered labels */
421 CollDeleteAll (&S->Labels);
423 /* Add the entry to the list of code entries in this segment */
424 CollAppend (&S->Entries, E);
429 void CS_AddLine (CodeSeg* S, LineInfo* LI, const char* Format, va_list ap)
430 /* Add a line to the given code segment */
436 /* Format the line */
438 xvsprintf (Buf, sizeof (Buf), Format, ap);
440 /* Skip whitespace */
443 /* Check which type of instruction we have */
444 E = 0; /* Assume no insn created */
448 /* Empty line, just ignore it */
452 /* Comment or hint, ignore it for now */
456 /* Control instruction */
457 ReadToken (L, " \t", Token, sizeof (Token));
458 Error ("ASM code error: Pseudo instruction `%s' not supported", Token);
462 E = ParseInsn (S, LI, L);
466 /* If we have a code entry, transfer the labels and insert it */
474 void CS_InsertEntry (CodeSeg* S, struct CodeEntry* E, unsigned Index)
475 /* Insert the code entry at the index given. Following code entries will be
476 * moved to slots with higher indices.
479 /* Insert the entry into the collection */
480 CollInsert (&S->Entries, E, Index);
485 void CS_DelEntry (CodeSeg* S, unsigned Index)
486 /* Delete an entry from the code segment. This includes moving any associated
487 * labels, removing references to labels and even removing the referenced labels
488 * if the reference count drops to zero.
491 /* Get the code entry for the given index */
492 CodeEntry* E = CS_GetEntry (S, Index);
494 /* If the entry has a labels, we have to move this label to the next insn.
495 * If there is no next insn, move the label into the code segement label
496 * pool. The operation is further complicated by the fact that the next
497 * insn may already have a label. In that case change all reference to
498 * this label and delete the label instead of moving it.
500 unsigned Count = CE_GetLabelCount (E);
503 /* The instruction has labels attached. Check if there is a next
506 if (Index == CS_GetEntryCount (S)-1) {
508 /* No next instruction, move to the codeseg label pool */
509 CS_MoveLabelsToPool (S, E);
513 /* There is a next insn, get it */
514 CodeEntry* N = CS_GetEntry (S, Index+1);
516 /* Move labels to the next entry */
517 CS_MoveLabels (S, E, N);
522 /* If this insn references a label, remove the reference. And, if the
523 * the reference count for this label drops to zero, remove this label.
526 /* Remove the reference */
527 CS_RemoveLabelRef (S, E);
530 /* Delete the pointer to the insn */
531 CollDelete (&S->Entries, Index);
533 /* Delete the instruction itself */
539 void CS_DelEntries (CodeSeg* S, unsigned Start, unsigned Count)
540 /* Delete a range of code entries. This includes removing references to labels,
541 * labels attached to the entries and so on.
544 /* Start deleting the entries from the rear, because this involves less
548 CS_DelEntry (S, Start + Count);
554 void CS_MoveEntry (CodeSeg* S, unsigned OldPos, unsigned NewPos)
555 /* Move an entry from one position to another. OldPos is the current position
556 * of the entry, NewPos is the new position of the entry.
559 /* Get the code entry and remove it from the collection */
560 CodeEntry* E = CS_GetEntry (S, OldPos);
561 CollDelete (&S->Entries, OldPos);
563 /* Correct NewPos if needed */
564 if (NewPos >= OldPos) {
565 /* Position has changed with removal */
569 /* Now insert it at the new position */
570 CollInsert (&S->Entries, E, NewPos);
575 struct CodeEntry* CS_GetNextEntry (CodeSeg* S, unsigned Index)
576 /* Get the code entry following the one with the index Index. If there is no
577 * following code entry, return NULL.
580 if (Index >= CollCount (&S->Entries)-1) {
581 /* This is the last entry */
584 /* Code entries left */
585 return CollAtUnchecked (&S->Entries, Index+1);
591 int CS_GetEntries (CodeSeg* S, struct CodeEntry** List,
592 unsigned Start, unsigned Count)
593 /* Get Count code entries into List starting at index start. Return true if
594 * we got the lines, return false if not enough lines were available.
597 /* Check if enough entries are available */
598 if (Start + Count > CollCount (&S->Entries)) {
602 /* Copy the entries */
604 *List++ = CollAtUnchecked (&S->Entries, Start++);
607 /* We have the entries */
613 unsigned CS_GetEntryIndex (CodeSeg* S, struct CodeEntry* E)
614 /* Return the index of a code entry */
616 int Index = CollIndex (&S->Entries, E);
623 CodeLabel* CS_AddLabel (CodeSeg* S, const char* Name)
624 /* Add a code label for the next instruction to follow */
626 /* Calculate the hash from the name */
627 unsigned Hash = HashStr (Name) % CS_LABEL_HASH_SIZE;
629 /* Try to find the code label if it does already exist */
630 CodeLabel* L = CS_FindLabel (S, Name, Hash);
632 /* Did we find it? */
634 /* We found it - be sure it does not already have an owner */
635 CHECK (L->Owner == 0);
637 /* Not found - create a new one */
638 L = CS_NewCodeLabel (S, Name, Hash);
641 /* Safety. This call is quite costly, but safety is better */
642 if (CollIndex (&S->Labels, L) >= 0) {
643 Internal ("AddCodeLabel: Label `%s' already defined", Name);
646 /* We do now have a valid label. Remember it for later */
647 CollAppend (&S->Labels, L);
649 /* Return the label */
655 CodeLabel* CS_GenLabel (CodeSeg* S, struct CodeEntry* E)
656 /* If the code entry E does already have a label, return it. Otherwise
657 * create a new label, attach it to E and return it.
662 if (CE_HasLabel (E)) {
664 /* Get the label from this entry */
665 L = CE_GetLabel (E, 0);
670 const char* Name = LocalLabelName (GetLocalLabel ());
672 /* Generate the hash over the name */
673 unsigned Hash = HashStr (Name) % CS_LABEL_HASH_SIZE;
675 /* Create a new label */
676 L = CS_NewCodeLabel (S, Name, Hash);
678 /* Attach this label to the code entry */
679 CE_AttachLabel (E, L);
683 /* Return the label */
689 void CS_DelLabel (CodeSeg* S, CodeLabel* L)
690 /* Remove references from this label and delete it. */
694 /* First, remove the label from the hash chain */
695 CS_RemoveLabelFromHash (S, L);
697 /* Remove references from insns jumping to this label */
698 Count = CollCount (&L->JumpFrom);
699 for (I = 0; I < Count; ++I) {
700 /* Get the insn referencing this label */
701 CodeEntry* E = CollAt (&L->JumpFrom, I);
702 /* Remove the reference */
705 CollDeleteAll (&L->JumpFrom);
707 /* Remove the reference to the owning instruction if it has one. The
708 * function may be called for a label without an owner when deleting
709 * unfinished parts of the code. This is unfortunate since it allows
710 * errors to slip through.
713 CollDeleteItem (&L->Owner->Labels, L);
716 /* All references removed, delete the label itself */
722 void CS_MergeLabels (CodeSeg* S)
723 /* Merge code labels. That means: For each instruction, remove all labels but
724 * one and adjust references accordingly.
729 /* Walk over all code entries */
730 for (I = 0; I < CS_GetEntryCount (S); ++I) {
735 /* Get a pointer to the next entry */
736 CodeEntry* E = CS_GetEntry (S, I);
738 /* If this entry has zero labels, continue with the next one */
739 unsigned LabelCount = CE_GetLabelCount (E);
740 if (LabelCount == 0) {
744 /* We have at least one label. Use the first one as reference label. */
745 RefLab = CE_GetLabel (E, 0);
747 /* Walk through the remaining labels and change references to these
748 * labels to a reference to the one and only label. Delete the labels
749 * that are no longer used. To increase performance, walk backwards
752 for (J = LabelCount-1; J >= 1; --J) {
754 /* Get the next label */
755 CodeLabel* L = CE_GetLabel (E, J);
757 /* Move all references from this label to the reference label */
758 CL_MoveRefs (L, RefLab);
760 /* Remove the label completely. */
764 /* The reference label is the only remaining label. Check if there
765 * are any references to this label, and delete it if this is not
768 if (CollCount (&RefLab->JumpFrom) == 0) {
769 /* Delete the label */
770 CS_DelLabel (S, RefLab);
777 void CS_MoveLabels (CodeSeg* S, struct CodeEntry* Old, struct CodeEntry* New)
778 /* Move all labels from Old to New. The routine will move the labels itself
779 * if New does not have any labels, and move references if there is at least
780 * a label for new. If references are moved, the old label is deleted
784 /* Get the number of labels to move */
785 unsigned OldLabelCount = CE_GetLabelCount (Old);
787 /* Does the new entry have itself a label? */
788 if (CE_HasLabel (New)) {
790 /* The new entry does already have a label - move references */
791 CodeLabel* NewLabel = CE_GetLabel (New, 0);
792 while (OldLabelCount--) {
794 /* Get the next label */
795 CodeLabel* OldLabel = CE_GetLabel (Old, OldLabelCount);
797 /* Move references */
798 CL_MoveRefs (OldLabel, NewLabel);
800 /* Delete the label */
801 CS_DelLabel (S, OldLabel);
807 /* The new entry does not have a label, just move them */
808 while (OldLabelCount--) {
810 /* Move the label to the new entry */
811 CE_MoveLabel (CE_GetLabel (Old, OldLabelCount), New);
820 void CS_RemoveLabelRef (CodeSeg* S, struct CodeEntry* E)
821 /* Remove the reference between E and the label it jumps to. The reference
822 * will be removed on both sides and E->JumpTo will be 0 after that. If
823 * the reference was the only one for the label, the label will get
827 /* Get a pointer to the label and make sure it exists */
828 CodeLabel* L = E->JumpTo;
831 /* Delete the entry from the label */
832 CollDeleteItem (&L->JumpFrom, E);
834 /* The entry jumps no longer to L */
837 /* If there are no more references, delete the label */
838 if (CollCount (&L->JumpFrom) == 0) {
845 void CS_MoveLabelRef (CodeSeg* S, struct CodeEntry* E, CodeLabel* L)
846 /* Change the reference of E to L instead of the current one. If this
847 * was the only reference to the old label, the old label will get
851 /* Get the old label */
852 CodeLabel* OldLabel = E->JumpTo;
854 /* Be sure that code entry references a label */
855 PRECONDITION (OldLabel != 0);
857 /* Remove the reference to our label */
858 CS_RemoveLabelRef (S, E);
860 /* Use the new label */
866 void CS_DelCodeAfter (CodeSeg* S, unsigned Last)
867 /* Delete all entries including the given one */
869 /* Get the number of entries in this segment */
870 unsigned Count = CS_GetEntryCount (S);
872 /* First pass: Delete all references to labels. If the reference count
873 * for a label drops to zero, delete it.
878 /* Get the next entry */
879 CodeEntry* E = CS_GetEntry (S, C);
881 /* Check if this entry has a label reference */
883 /* If the label is a label in the label pool and this is the last
884 * reference to the label, remove the label from the pool.
886 CodeLabel* L = E->JumpTo;
887 int Index = CollIndex (&S->Labels, L);
888 if (Index >= 0 && CollCount (&L->JumpFrom) == 1) {
889 /* Delete it from the pool */
890 CollDelete (&S->Labels, Index);
893 /* Remove the reference to the label */
894 CS_RemoveLabelRef (S, E);
899 /* Second pass: Delete the instructions. If a label attached to an
900 * instruction still has references, it must be references from outside
901 * the deleted area. Don't delete the label in this case, just make it
902 * ownerless and move it to the label pool.
907 /* Get the next entry */
908 CodeEntry* E = CS_GetEntry (S, C);
910 /* Check if this entry has a label attached */
911 if (CE_HasLabel (E)) {
912 /* Move the labels to the pool and clear the owner pointer */
913 CS_MoveLabelsToPool (S, E);
916 /* Delete the pointer to the entry */
917 CollDelete (&S->Entries, C);
919 /* Delete the entry itself */
926 void CS_Output (const CodeSeg* S, FILE* F)
927 /* Output the code segment data to a file */
932 /* Get the number of entries in this segment */
933 unsigned Count = CS_GetEntryCount (S);
935 /* If the code segment is empty, bail out here */
940 /* Output the segment directive */
941 fprintf (F, ".segment\t\"%s\"\n\n", S->SegName);
943 /* If this is a segment for a function, enter a function */
945 fprintf (F, ".proc\t_%s\n\n", S->Func->Name);
948 /* Output all entries, prepended by the line information if it has changed */
950 for (I = 0; I < Count; ++I) {
951 /* Get the next entry */
952 const CodeEntry* E = CollConstAt (&S->Entries, I);
953 /* Check if the line info has changed. If so, output the source line
954 * if the option is enabled and output debug line info if the debug
958 /* Line info has changed, remember the new line info */
961 /* Add the source line as a comment */
963 fprintf (F, ";\n; %s\n;\n", LI->Line);
966 /* Add line debug info */
968 fprintf (F, "\t.dbg\tline, \"%s\", %u\n",
969 GetInputName (LI), GetInputLine (LI));
972 /* Output the code */
976 /* If debug info is enabled, terminate the last line number information */
978 fprintf (F, "\t.dbg\tline\n");
981 /* If this is a segment for a function, leave the function */
983 fprintf (F, "\n.endproc\n\n");