1 /*****************************************************************************/
5 /* Code segment structure */
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 /*****************************************************************************/
42 #include "debugflag.h"
61 /*****************************************************************************/
62 /* Helper functions */
63 /*****************************************************************************/
67 static void CS_PrintFunctionHeader (const CodeSeg* S, FILE* F)
68 /* Print a comment with the function signature to the given file */
70 /* Get the associated function */
71 const SymEntry* Func = S->Func;
73 /* If this is a global code segment, do nothing */
76 "; ---------------------------------------------------------------\n"
78 PrintFuncSig (F, Func->Name, Func->Type);
81 "; ---------------------------------------------------------------\n"
88 static void CS_MoveLabelsToEntry (CodeSeg* S, CodeEntry* E)
89 /* Move all labels from the label pool to the given entry and remove them
93 /* Transfer the labels if we have any */
95 unsigned LabelCount = CollCount (&S->Labels);
96 for (I = 0; I < LabelCount; ++I) {
99 CodeLabel* L = CollAt (&S->Labels, I);
101 /* Attach it to the entry */
102 CE_AttachLabel (E, L);
105 /* Delete the transfered labels */
106 CollDeleteAll (&S->Labels);
111 static void CS_MoveLabelsToPool (CodeSeg* S, CodeEntry* E)
112 /* Move the labels of the code entry E to the label pool of the code segment */
114 unsigned LabelCount = CE_GetLabelCount (E);
115 while (LabelCount--) {
116 CodeLabel* L = CE_GetLabel (E, LabelCount);
118 CollAppend (&S->Labels, L);
120 CollDeleteAll (&E->Labels);
125 static CodeLabel* CS_FindLabel (CodeSeg* S, const char* Name, unsigned Hash)
126 /* Find the label with the given name. Return the label or NULL if not found */
128 /* Get the first hash chain entry */
129 CodeLabel* L = S->LabelHash[Hash];
131 /* Search the list */
133 if (strcmp (Name, L->Name) == 0) {
144 static CodeLabel* CS_NewCodeLabel (CodeSeg* S, const char* Name, unsigned Hash)
145 /* Create a new label and insert it into the label hash table */
147 /* Create a new label */
148 CodeLabel* L = NewCodeLabel (Name, Hash);
150 /* Enter the label into the hash table */
151 L->Next = S->LabelHash[L->Hash];
152 S->LabelHash[L->Hash] = L;
154 /* Return the new label */
160 static void CS_RemoveLabelFromHash (CodeSeg* S, CodeLabel* L)
161 /* Remove the given code label from the hash list */
163 /* Get the first entry in the hash chain */
164 CodeLabel* List = S->LabelHash[L->Hash];
167 /* First, remove the label from the hash chain */
169 /* First entry in hash chain */
170 S->LabelHash[L->Hash] = L->Next;
172 /* Must search through the chain */
173 while (List->Next != L) {
174 /* If we've reached the end of the chain, something is *really* wrong */
175 CHECK (List->Next != 0);
179 /* The next entry is the one, we have been searching for */
180 List->Next = L->Next;
186 static CodeLabel* CS_AddLabelInternal (CodeSeg* S, const char* Name,
187 void (*ErrorFunc) (const char*, ...))
188 /* Add a code label for the next instruction to follow */
190 /* Calculate the hash from the name */
191 unsigned Hash = HashStr (Name) % CS_LABEL_HASH_SIZE;
193 /* Try to find the code label if it does already exist */
194 CodeLabel* L = CS_FindLabel (S, Name, Hash);
196 /* Did we find it? */
198 /* We found it - be sure it does not already have an owner */
200 ErrorFunc ("ASM label `%s' is already defined", Name);
203 /* Not found - create a new one */
204 L = CS_NewCodeLabel (S, Name, Hash);
207 /* Safety. This call is quite costly, but safety is better */
208 if (CollIndex (&S->Labels, L) >= 0) {
209 ErrorFunc ("ASM label `%s' is already defined", Name);
212 /* We do now have a valid label. Remember it for later */
213 CollAppend (&S->Labels, L);
215 /* Return the label */
221 /*****************************************************************************/
222 /* Functions for parsing instructions */
223 /*****************************************************************************/
227 static const char* SkipSpace (const char* S)
228 /* Skip white space and return an updated pointer */
230 while (IsSpace (*S)) {
238 static const char* ReadToken (const char* L, const char* Term,
239 char* Buf, unsigned BufSize)
240 /* Read the next token into Buf, return the updated line pointer. The
241 * token is terminated by one of the characters given in term.
244 /* Read/copy the token */
246 unsigned ParenCount = 0;
247 while (*L && (ParenCount > 0 || strchr (Term, *L) == 0)) {
250 } else if (I == BufSize-1) {
251 /* Cannot store this character, this is an input error (maybe
252 * identifier too long or similar).
254 Error ("ASM code error: syntax error");
259 } else if (*L == '(') {
265 /* Terminate the buffer contents */
268 /* Return the updated line pointer */
274 static CodeEntry* ParseInsn (CodeSeg* S, LineInfo* LI, const char* L)
275 /* Parse an instruction nnd generate a code entry from it. If the line contains
276 * errors, output an error message and return NULL.
277 * For simplicity, we don't accept the broad range of input a "real" assembler
278 * does. The instruction and the argument are expected to be separated by
279 * white space, for example.
282 char Mnemo[IDENTSIZE+10];
284 am_t AM = 0; /* Initialize to keep gcc silent */
285 char Arg[IDENTSIZE+10];
290 /* Read the first token and skip white space after it */
291 L = SkipSpace (ReadToken (L, " \t:", Mnemo, sizeof (Mnemo)));
293 /* Check if we have a label */
296 /* Skip the colon and following white space */
300 CS_AddLabelInternal (S, Mnemo, Error);
302 /* If we have reached end of line, bail out, otherwise a mnemonic
309 L = SkipSpace (ReadToken (L, " \t", Mnemo, sizeof (Mnemo)));
312 /* Try to find the opcode description for the mnemonic */
313 OPC = FindOP65 (Mnemo);
315 /* If we didn't find the opcode, print an error and bail out */
317 Error ("ASM code error: %s is not a valid mnemonic", Mnemo);
321 /* Get the addressing mode */
332 StrCopy (Arg, sizeof (Arg), L+1);
338 L = ReadToken (L+1, ",)", Arg, sizeof (Arg));
340 /* Check for errors */
342 Error ("ASM code error: syntax error");
346 /* Check the different indirect modes */
348 /* Expect zp x indirect */
350 if (toupper (*L) != 'X') {
351 Error ("ASM code error: `X' expected");
356 Error ("ASM code error: `)' expected");
361 Error ("ASM code error: syntax error");
365 } else if (*L == ')') {
366 /* zp indirect or zp indirect, y */
370 if (toupper (*L) != 'Y') {
371 Error ("ASM code error: `Y' expected");
376 Error ("ASM code error: syntax error");
380 } else if (*L == '\0') {
383 Error ("ASM code error: syntax error");
399 /* Absolute, maybe indexed */
400 L = ReadToken (L, ",", Arg, sizeof (Arg));
402 /* Absolute, zeropage or branch */
403 if ((OPC->Info & OF_BRA) != 0) {
406 } else if (GetZPInfo(Arg) != 0) {
411 } else if (*L == ',') {
415 Error ("ASM code error: syntax error");
421 if (GetZPInfo(Arg) != 0) {
426 } else if (Reg == 'Y') {
429 Error ("ASM code error: syntax error");
433 Error ("ASM code error: syntax error");
442 /* If the instruction is a branch, check for the label and generate it
443 * if it does not exist. This may lead to unused labels (if the label
444 * is actually an external one) which are removed by the CS_MergeLabels
448 if (AM == AM65_BRA) {
450 /* Generate the hash over the label, then search for the label */
451 unsigned Hash = HashStr (Arg) % CS_LABEL_HASH_SIZE;
452 Label = CS_FindLabel (S, Arg, Hash);
454 /* If we don't have the label, it's a forward ref - create it */
456 /* Generate a new label */
457 Label = CS_NewCodeLabel (S, Arg, Hash);
461 /* We do now have the addressing mode in AM. Allocate a new CodeEntry
462 * structure and initialize it.
464 E = NewCodeEntry (OPC->OPC, AM, Arg, Label, LI);
466 /* Return the new code entry */
472 /*****************************************************************************/
474 /*****************************************************************************/
478 CodeSeg* NewCodeSeg (const char* SegName, SymEntry* Func)
479 /* Create a new code segment, initialize and return it */
484 /* Allocate memory */
485 CodeSeg* S = xmalloc (sizeof (CodeSeg));
487 /* Initialize the fields */
488 S->SegName = xstrdup (SegName);
490 InitCollection (&S->Entries);
491 InitCollection (&S->Labels);
492 for (I = 0; I < sizeof(S->LabelHash) / sizeof(S->LabelHash[0]); ++I) {
496 /* If we have a function given, get the return type of the function.
497 * Assume ANY return type besides void will use the A and X registers.
499 if (S->Func && !IsTypeVoid ((RetType = GetFuncReturn (Func->Type)))) {
500 if (SizeOf (RetType) == SizeOf (type_long)) {
501 S->ExitRegs = REG_EAX;
503 S->ExitRegs = REG_AX;
506 S->ExitRegs = REG_NONE;
509 /* Return the new struct */
515 void CS_AddEntry (CodeSeg* S, struct CodeEntry* E)
516 /* Add an entry to the given code segment */
518 /* Transfer the labels if we have any */
519 CS_MoveLabelsToEntry (S, E);
521 /* Add the entry to the list of code entries in this segment */
522 CollAppend (&S->Entries, E);
527 void CS_AddVLine (CodeSeg* S, LineInfo* LI, const char* Format, va_list ap)
528 /* Add a line to the given code segment */
532 char Token[IDENTSIZE+10];
534 /* Format the line */
536 xvsprintf (Buf, sizeof (Buf), Format, ap);
538 /* Skip whitespace */
541 /* Check which type of instruction we have */
542 E = 0; /* Assume no insn created */
546 /* Empty line, just ignore it */
550 /* Comment or hint, ignore it for now */
554 /* Control instruction */
555 ReadToken (L, " \t", Token, sizeof (Token));
556 Error ("ASM code error: Pseudo instruction `%s' not supported", Token);
560 E = ParseInsn (S, LI, L);
564 /* If we have a code entry, transfer the labels and insert it */
572 void CS_AddLine (CodeSeg* S, LineInfo* LI, const char* Format, ...)
573 /* Add a line to the given code segment */
576 va_start (ap, Format);
577 CS_AddVLine (S, LI, Format, ap);
583 void CS_InsertEntry (CodeSeg* S, struct CodeEntry* E, unsigned Index)
584 /* Insert the code entry at the index given. Following code entries will be
585 * moved to slots with higher indices.
588 /* Insert the entry into the collection */
589 CollInsert (&S->Entries, E, Index);
594 void CS_DelEntry (CodeSeg* S, unsigned Index)
595 /* Delete an entry from the code segment. This includes moving any associated
596 * labels, removing references to labels and even removing the referenced labels
597 * if the reference count drops to zero.
598 * Note: Labels are moved forward if possible, that is, they are moved to the
599 * next insn (not the preceeding one).
602 /* Get the code entry for the given index */
603 CodeEntry* E = CS_GetEntry (S, Index);
605 /* If the entry has a labels, we have to move this label to the next insn.
606 * If there is no next insn, move the label into the code segement label
607 * pool. The operation is further complicated by the fact that the next
608 * insn may already have a label. In that case change all reference to
609 * this label and delete the label instead of moving it.
611 unsigned Count = CE_GetLabelCount (E);
614 /* The instruction has labels attached. Check if there is a next
617 if (Index == CS_GetEntryCount (S)-1) {
619 /* No next instruction, move to the codeseg label pool */
620 CS_MoveLabelsToPool (S, E);
624 /* There is a next insn, get it */
625 CodeEntry* N = CS_GetEntry (S, Index+1);
627 /* Move labels to the next entry */
628 CS_MoveLabels (S, E, N);
633 /* If this insn references a label, remove the reference. And, if the
634 * the reference count for this label drops to zero, remove this label.
637 /* Remove the reference */
638 CS_RemoveLabelRef (S, E);
641 /* Delete the pointer to the insn */
642 CollDelete (&S->Entries, Index);
644 /* Delete the instruction itself */
650 void CS_DelEntries (CodeSeg* S, unsigned Start, unsigned Count)
651 /* Delete a range of code entries. This includes removing references to labels,
652 * labels attached to the entries and so on.
655 /* Start deleting the entries from the rear, because this involves less
659 CS_DelEntry (S, Start + Count);
665 void CS_MoveEntries (CodeSeg* S, unsigned Start, unsigned Count, unsigned NewPos)
666 /* Move a range of entries from one position to another. Start is the index
667 * of the first entry to move, Count is the number of entries and NewPos is
668 * the index of the target entry. The entry with the index Start will later
669 * have the index NewPos. All entries with indices NewPos and above are
670 * moved to higher indices. If the code block is moved to the end of the
671 * current code, and if pending labels exist, these labels will get attached
672 * to the first instruction of the moved block (the first one after the
676 /* If NewPos is at the end of the code segment, move any labels from the
677 * label pool to the first instruction of the moved range.
679 if (NewPos == CS_GetEntryCount (S)) {
680 CS_MoveLabelsToEntry (S, CS_GetEntry (S, Start));
683 /* Move the code block to the destination */
684 CollMoveMultiple (&S->Entries, Start, Count, NewPos);
689 struct CodeEntry* CS_GetPrevEntry (CodeSeg* S, unsigned Index)
690 /* Get the code entry preceeding the one with the index Index. If there is no
691 * preceeding code entry, return NULL.
695 /* This is the first entry */
698 /* Previous entry available */
699 return CollAtUnchecked (&S->Entries, Index-1);
705 struct CodeEntry* CS_GetNextEntry (CodeSeg* S, unsigned Index)
706 /* Get the code entry following the one with the index Index. If there is no
707 * following code entry, return NULL.
710 if (Index >= CollCount (&S->Entries)-1) {
711 /* This is the last entry */
714 /* Code entries left */
715 return CollAtUnchecked (&S->Entries, Index+1);
721 int CS_GetEntries (CodeSeg* S, struct CodeEntry** List,
722 unsigned Start, unsigned Count)
723 /* Get Count code entries into List starting at index start. Return true if
724 * we got the lines, return false if not enough lines were available.
727 /* Check if enough entries are available */
728 if (Start + Count > CollCount (&S->Entries)) {
732 /* Copy the entries */
734 *List++ = CollAtUnchecked (&S->Entries, Start++);
737 /* We have the entries */
743 unsigned CS_GetEntryIndex (CodeSeg* S, struct CodeEntry* E)
744 /* Return the index of a code entry */
746 int Index = CollIndex (&S->Entries, E);
753 int CS_RangeHasLabel (CodeSeg* S, unsigned Start, unsigned Count)
754 /* Return true if any of the code entries in the given range has a label
755 * attached. If the code segment does not span the given range, check the
756 * possible span instead.
759 unsigned EntryCount = CS_GetEntryCount(S);
761 /* Adjust count. We expect at least Start to be valid. */
762 CHECK (Start < EntryCount);
763 if (Start + Count > EntryCount) {
764 Count = EntryCount - Start;
767 /* Check each entry. Since we have validated the index above, we may
768 * use the unchecked access function in the loop which is faster.
771 const CodeEntry* E = CollAtUnchecked (&S->Entries, Start++);
772 if (CE_HasLabel (E)) {
777 /* No label in the complete range */
783 CodeLabel* CS_AddLabel (CodeSeg* S, const char* Name)
784 /* Add a code label for the next instruction to follow */
786 return CS_AddLabelInternal (S, Name, Internal);
791 CodeLabel* CS_GenLabel (CodeSeg* S, struct CodeEntry* E)
792 /* If the code entry E does already have a label, return it. Otherwise
793 * create a new label, attach it to E and return it.
798 if (CE_HasLabel (E)) {
800 /* Get the label from this entry */
801 L = CE_GetLabel (E, 0);
806 const char* Name = LocalLabelName (GetLocalLabel ());
808 /* Generate the hash over the name */
809 unsigned Hash = HashStr (Name) % CS_LABEL_HASH_SIZE;
811 /* Create a new label */
812 L = CS_NewCodeLabel (S, Name, Hash);
814 /* Attach this label to the code entry */
815 CE_AttachLabel (E, L);
819 /* Return the label */
825 void CS_DelLabel (CodeSeg* S, CodeLabel* L)
826 /* Remove references from this label and delete it. */
830 /* First, remove the label from the hash chain */
831 CS_RemoveLabelFromHash (S, L);
833 /* Remove references from insns jumping to this label */
834 Count = CollCount (&L->JumpFrom);
835 for (I = 0; I < Count; ++I) {
836 /* Get the insn referencing this label */
837 CodeEntry* E = CollAt (&L->JumpFrom, I);
838 /* Remove the reference */
841 CollDeleteAll (&L->JumpFrom);
843 /* Remove the reference to the owning instruction if it has one. The
844 * function may be called for a label without an owner when deleting
845 * unfinished parts of the code. This is unfortunate since it allows
846 * errors to slip through.
849 CollDeleteItem (&L->Owner->Labels, L);
852 /* All references removed, delete the label itself */
858 void CS_MergeLabels (CodeSeg* S)
859 /* Merge code labels. That means: For each instruction, remove all labels but
860 * one and adjust references accordingly.
866 /* First, remove all labels from the label symbol table that don't have an
867 * owner (this means that they are actually external labels but we didn't
868 * know that previously since they may have also been forward references).
870 for (I = 0; I < CS_LABEL_HASH_SIZE; ++I) {
872 /* Get the first label in this hash chain */
873 CodeLabel** L = &S->LabelHash[I];
875 if ((*L)->Owner == 0) {
877 /* The label does not have an owner, remove it from the chain */
881 /* Cleanup any entries jumping to this label */
882 for (J = 0; J < CL_GetRefCount (X); ++J) {
883 /* Get the entry referencing this label */
884 CodeEntry* E = CL_GetRef (X, J);
885 /* And remove the reference */
889 /* Print some debugging output */
891 printf ("Removing unused global label `%s'", X->Name);
894 /* And free the label */
897 /* Label is owned, point to next code label pointer */
903 /* Walk over all code entries */
904 for (I = 0; I < CS_GetEntryCount (S); ++I) {
909 /* Get a pointer to the next entry */
910 CodeEntry* E = CS_GetEntry (S, I);
912 /* If this entry has zero labels, continue with the next one */
913 unsigned LabelCount = CE_GetLabelCount (E);
914 if (LabelCount == 0) {
918 /* We have at least one label. Use the first one as reference label. */
919 RefLab = CE_GetLabel (E, 0);
921 /* Walk through the remaining labels and change references to these
922 * labels to a reference to the one and only label. Delete the labels
923 * that are no longer used. To increase performance, walk backwards
926 for (J = LabelCount-1; J >= 1; --J) {
928 /* Get the next label */
929 CodeLabel* L = CE_GetLabel (E, J);
931 /* Move all references from this label to the reference label */
932 CL_MoveRefs (L, RefLab);
934 /* Remove the label completely. */
938 /* The reference label is the only remaining label. Check if there
939 * are any references to this label, and delete it if this is not
942 if (CollCount (&RefLab->JumpFrom) == 0) {
943 /* Delete the label */
944 CS_DelLabel (S, RefLab);
951 void CS_MoveLabels (CodeSeg* S, struct CodeEntry* Old, struct CodeEntry* New)
952 /* Move all labels from Old to New. The routine will move the labels itself
953 * if New does not have any labels, and move references if there is at least
954 * a label for new. If references are moved, the old label is deleted
958 /* Get the number of labels to move */
959 unsigned OldLabelCount = CE_GetLabelCount (Old);
961 /* Does the new entry have itself a label? */
962 if (CE_HasLabel (New)) {
964 /* The new entry does already have a label - move references */
965 CodeLabel* NewLabel = CE_GetLabel (New, 0);
966 while (OldLabelCount--) {
968 /* Get the next label */
969 CodeLabel* OldLabel = CE_GetLabel (Old, OldLabelCount);
971 /* Move references */
972 CL_MoveRefs (OldLabel, NewLabel);
974 /* Delete the label */
975 CS_DelLabel (S, OldLabel);
981 /* The new entry does not have a label, just move them */
982 while (OldLabelCount--) {
984 /* Move the label to the new entry */
985 CE_MoveLabel (CE_GetLabel (Old, OldLabelCount), New);
994 void CS_RemoveLabelRef (CodeSeg* S, struct CodeEntry* E)
995 /* Remove the reference between E and the label it jumps to. The reference
996 * will be removed on both sides and E->JumpTo will be 0 after that. If
997 * the reference was the only one for the label, the label will get
1001 /* Get a pointer to the label and make sure it exists */
1002 CodeLabel* L = E->JumpTo;
1005 /* Delete the entry from the label */
1006 CollDeleteItem (&L->JumpFrom, E);
1008 /* The entry jumps no longer to L */
1011 /* If there are no more references, delete the label */
1012 if (CollCount (&L->JumpFrom) == 0) {
1019 void CS_MoveLabelRef (CodeSeg* S, struct CodeEntry* E, CodeLabel* L)
1020 /* Change the reference of E to L instead of the current one. If this
1021 * was the only reference to the old label, the old label will get
1025 /* Get the old label */
1026 CodeLabel* OldLabel = E->JumpTo;
1028 /* Be sure that code entry references a label */
1029 PRECONDITION (OldLabel != 0);
1031 /* Remove the reference to our label */
1032 CS_RemoveLabelRef (S, E);
1034 /* Use the new label */
1040 void CS_DelCodeAfter (CodeSeg* S, unsigned Last)
1041 /* Delete all entries including the given one */
1043 /* Get the number of entries in this segment */
1044 unsigned Count = CS_GetEntryCount (S);
1046 /* First pass: Delete all references to labels. If the reference count
1047 * for a label drops to zero, delete it.
1050 while (Last < C--) {
1052 /* Get the next entry */
1053 CodeEntry* E = CS_GetEntry (S, C);
1055 /* Check if this entry has a label reference */
1057 /* If the label is a label in the label pool and this is the last
1058 * reference to the label, remove the label from the pool.
1060 CodeLabel* L = E->JumpTo;
1061 int Index = CollIndex (&S->Labels, L);
1062 if (Index >= 0 && CollCount (&L->JumpFrom) == 1) {
1063 /* Delete it from the pool */
1064 CollDelete (&S->Labels, Index);
1067 /* Remove the reference to the label */
1068 CS_RemoveLabelRef (S, E);
1073 /* Second pass: Delete the instructions. If a label attached to an
1074 * instruction still has references, it must be references from outside
1075 * the deleted area. Don't delete the label in this case, just make it
1076 * ownerless and move it to the label pool.
1079 while (Last < C--) {
1081 /* Get the next entry */
1082 CodeEntry* E = CS_GetEntry (S, C);
1084 /* Check if this entry has a label attached */
1085 if (CE_HasLabel (E)) {
1086 /* Move the labels to the pool and clear the owner pointer */
1087 CS_MoveLabelsToPool (S, E);
1090 /* Delete the pointer to the entry */
1091 CollDelete (&S->Entries, C);
1093 /* Delete the entry itself */
1100 void CS_ResetMarks (CodeSeg* S, unsigned First, unsigned Last)
1101 /* Remove all user marks from the entries in the given range */
1103 while (First <= Last) {
1104 CE_ResetMark (CS_GetEntry (S, First++));
1110 int CS_IsBasicBlock (CodeSeg* S, unsigned First, unsigned Last)
1111 /* Check if the given code segment range is a basic block. That is, check if
1112 * First is the only entrance and Last is the only exit. This means that no
1113 * jump/branch inside the block may jump to an insn below First or after(!)
1114 * Last, and that no insn may jump into this block from the outside.
1119 /* Don't accept invalid ranges */
1120 CHECK (First <= Last);
1122 /* First pass: Walk over the range and remove all marks from the entries */
1123 CS_ResetMarks (S, First, Last);
1125 /* Second pass: Walk over the range checking all labels. Note: There may be
1126 * label on the first insn which is ok.
1131 /* Get the next entry */
1132 CodeEntry* E = CS_GetEntry (S, I);
1134 /* Check if this entry has one or more labels, if so, check which
1135 * entries jump to this label.
1137 unsigned LabelCount = CE_GetLabelCount (E);
1138 unsigned LabelIndex;
1139 for (LabelIndex = 0; LabelIndex < LabelCount; ++LabelIndex) {
1141 /* Get this label */
1142 CodeLabel* L = CE_GetLabel (E, LabelIndex);
1144 /* Walk over all entries that jump to this label. Check for each
1145 * of the entries if it is out of the range.
1147 unsigned RefCount = CL_GetRefCount (L);
1149 for (RefIndex = 0; RefIndex < RefCount; ++RefIndex) {
1151 /* Get the code entry that jumps here */
1152 CodeEntry* Ref = CL_GetRef (L, RefIndex);
1154 /* Walk over out complete range and check if we find the
1155 * refering entry. This is cheaper than using CS_GetEntryIndex,
1156 * because CS_GetEntryIndex will search the complete code
1157 * segment and not just our range.
1160 for (J = First; J <= Last; ++J) {
1161 if (Ref == CS_GetEntry (S, J)) {
1166 /* We did not find the entry. This means that the jump to
1167 * out code segment entry E came from outside the range,
1168 * which in turn means that the given range is not a basic
1171 CS_ResetMarks (S, First, Last);
1175 /* If we come here, we found the entry. Mark it, so we know
1176 * that the branch to the label is in range.
1186 /* Third pass: Walk again over the range and check all branches. If we
1187 * find a branch that is not marked, its target is not inside the range
1188 * (since we checked all the labels in the range before).
1193 /* Get the next entry */
1194 CodeEntry* E = CS_GetEntry (S, I);
1196 /* Check if this is a branch and if so, if it has a mark */
1197 if (E->Info & (OF_UBRA | OF_CBRA)) {
1198 if (!CE_HasMark (E)) {
1199 /* No mark means not a basic block. Before bailing out, be sure
1200 * to remove the marks from the remaining entries.
1202 CS_ResetMarks (S, I+1, Last);
1206 /* Remove the mark */
1214 /* Done - this is a basic block */
1220 void CS_OutputPrologue (const CodeSeg* S, FILE* F)
1221 /* If the given code segment is a code segment for a function, output the
1222 * assembler prologue into the file. That is: Output a comment header, switch
1223 * to the correct segment and enter the local function scope. If the code
1224 * segment is global, do nothing.
1227 /* Get the function associated with the code segment */
1228 SymEntry* Func = S->Func;
1230 /* If the code segment is associated with a function, print a function
1231 * header and enter a local scope. Be sure to switch to the correct
1232 * segment before outputing the function label.
1235 CS_PrintFunctionHeader (S, F);
1236 fprintf (F, ".segment\t\"%s\"\n\n.proc\t_%s\n\n", S->SegName, Func->Name);
1243 void CS_OutputEpilogue (const CodeSeg* S, FILE* F)
1244 /* If the given code segment is a code segment for a function, output the
1245 * assembler epilogue into the file. That is: Close the local function scope.
1249 fprintf (F, "\n.endproc\n\n");
1255 void CS_Output (const CodeSeg* S, FILE* F)
1256 /* Output the code segment data to a file */
1261 /* Get the number of entries in this segment */
1262 unsigned Count = CS_GetEntryCount (S);
1264 /* If the code segment is empty, bail out here */
1269 /* Output the segment directive */
1270 fprintf (F, ".segment\t\"%s\"\n\n", S->SegName);
1272 /* Output all entries, prepended by the line information if it has changed */
1274 for (I = 0; I < Count; ++I) {
1275 /* Get the next entry */
1276 const CodeEntry* E = CollConstAt (&S->Entries, I);
1277 /* Check if the line info has changed. If so, output the source line
1278 * if the option is enabled and output debug line info if the debug
1279 * option is enabled.
1282 /* Line info has changed, remember the new line info */
1285 /* Add the source line as a comment */
1287 fprintf (F, ";\n; %s\n;\n", LI->Line);
1290 /* Add line debug info */
1292 fprintf (F, "\t.dbg\tline, \"%s\", %u\n",
1293 GetInputName (LI), GetInputLine (LI));
1296 /* Output the code */
1300 /* If debug info is enabled, terminate the last line number information */
1302 fprintf (F, "\t.dbg\tline\n");
1308 void CS_FreeRegInfo (CodeSeg* S)
1309 /* Free register infos for all instructions */
1312 for (I = 0; I < CS_GetEntryCount (S); ++I) {
1313 CE_FreeRegInfo (CS_GetEntry(S, I));
1319 void CS_GenRegInfo (CodeSeg* S)
1320 /* Generate register infos for all instructions */
1323 RegContents Regs; /* Initial register contents */
1324 RegContents* CurrentRegs; /* Current register contents */
1325 int WasJump; /* True if last insn was a jump */
1326 int Done; /* All runs done flag */
1328 /* Be sure to delete all register infos */
1331 /* We may need two runs to get back references right */
1334 /* Assume we're done after this run */
1337 /* On entry, the register contents are unknown */
1338 RC_Invalidate (&Regs);
1339 CurrentRegs = &Regs;
1341 /* Walk over all insns and note just the changes from one insn to the
1345 for (I = 0; I < CS_GetEntryCount (S); ++I) {
1349 /* Get the next instruction */
1350 CodeEntry* E = CollAtUnchecked (&S->Entries, I);
1352 /* If the instruction has a label, we need some special handling */
1353 unsigned LabelCount = CE_GetLabelCount (E);
1354 if (LabelCount > 0) {
1356 /* Loop over all entry points that jump here. If these entry
1357 * points already have register info, check if all values are
1358 * known and identical. If all values are identical, and the
1359 * preceeding instruction was not an unconditional branch, check
1360 * if the register value on exit of the preceeding instruction
1361 * is also identical. If all these values are identical, the
1362 * value of a register is known, otherwise it is unknown.
1364 CodeLabel* Label = CE_GetLabel (E, 0);
1367 /* Preceeding insn was an unconditional branch */
1368 CodeEntry* J = CL_GetRef(Label, 0);
1372 RC_Invalidate (&Regs);
1376 Regs = *CurrentRegs;
1380 while (Entry < CL_GetRefCount (Label)) {
1381 /* Get this entry */
1382 CodeEntry* J = CL_GetRef (Label, Entry);
1384 /* No register info for this entry. This means that the
1385 * instruction that jumps here is at higher addresses and
1386 * the jump is a backward jump. We need a second run to
1387 * get the register info right in this case. Until then,
1388 * assume unknown register contents.
1391 RC_Invalidate (&Regs);
1394 if (J->RI->Out2.RegA != Regs.RegA) {
1395 Regs.RegA = UNKNOWN_REGVAL;
1397 if (J->RI->Out2.RegX != Regs.RegX) {
1398 Regs.RegX = UNKNOWN_REGVAL;
1400 if (J->RI->Out2.RegY != Regs.RegY) {
1401 Regs.RegY = UNKNOWN_REGVAL;
1403 if (J->RI->Out2.SRegLo != Regs.SRegLo) {
1404 Regs.SRegLo = UNKNOWN_REGVAL;
1406 if (J->RI->Out2.SRegHi != Regs.SRegHi) {
1407 Regs.SRegHi = UNKNOWN_REGVAL;
1409 if (J->RI->Out2.Tmp1 != Regs.Tmp1) {
1410 Regs.Tmp1 = UNKNOWN_REGVAL;
1415 /* Use this register info */
1416 CurrentRegs = &Regs;
1420 /* Generate register info for this instruction */
1421 CE_GenRegInfo (E, CurrentRegs);
1423 /* Remember for the next insn if this insn was an uncondition branch */
1424 WasJump = (E->Info & OF_UBRA) != 0;
1426 /* Output registers for this insn are input for the next */
1427 CurrentRegs = &E->RI->Out;
1429 /* If this insn is a branch on zero flag, we may have more info on
1430 * register contents for one of both flow directions, but only if
1431 * there is a previous instruction.
1433 if ((E->Info & OF_ZBRA) != 0 && (P = CS_GetPrevEntry (S, I)) != 0) {
1435 /* Get the branch condition */
1436 bc_t BC = GetBranchCond (E->OPC);
1438 /* Check the previous instruction */
1450 /* A is zero in one execution flow direction */
1452 E->RI->Out2.RegA = 0;
1454 E->RI->Out.RegA = 0;
1459 /* If this is an immidiate compare, the A register has
1460 * the value of the compare later.
1462 if (CE_KnownImm (P)) {
1464 E->RI->Out2.RegA = (unsigned char)P->Num;
1466 E->RI->Out.RegA = (unsigned char)P->Num;
1472 /* If this is an immidiate compare, the X register has
1473 * the value of the compare later.
1475 if (CE_KnownImm (P)) {
1477 E->RI->Out2.RegX = (unsigned char)P->Num;
1479 E->RI->Out.RegX = (unsigned char)P->Num;
1485 /* If this is an immidiate compare, the Y register has
1486 * the value of the compare later.
1488 if (CE_KnownImm (P)) {
1490 E->RI->Out2.RegY = (unsigned char)P->Num;
1492 E->RI->Out.RegY = (unsigned char)P->Num;
1501 /* X is zero in one execution flow direction */
1503 E->RI->Out2.RegX = 0;
1505 E->RI->Out.RegX = 0;
1513 /* X is zero in one execution flow direction */
1515 E->RI->Out2.RegY = 0;
1517 E->RI->Out.RegY = 0;
1523 /* If the branch is a beq, both A and X are zero at the
1524 * branch target, otherwise they are zero at the next
1528 E->RI->Out2.RegA = E->RI->Out2.RegX = 0;
1530 E->RI->Out.RegA = E->RI->Out.RegX = 0;
1536 /* If the branch is a beq, both A and Y are zero at the
1537 * branch target, otherwise they are zero at the next
1541 E->RI->Out2.RegA = E->RI->Out2.RegY = 0;
1543 E->RI->Out.RegA = E->RI->Out.RegY = 0;