1 /*****************************************************************************/
5 /* Code segment structure */
9 /* (C) 2001-2003 Ullrich von Bassewitz */
10 /* Römerstrasse 52 */
11 /* D-70794 Filderstadt */
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 /*****************************************************************************/
187 /* Functions for parsing instructions */
188 /*****************************************************************************/
192 static const char* SkipSpace (const char* S)
193 /* Skip white space and return an updated pointer */
195 while (IsSpace (*S)) {
203 static const char* ReadToken (const char* L, const char* Term,
204 char* Buf, unsigned BufSize)
205 /* Read the next token into Buf, return the updated line pointer. The
206 * token is terminated by one of the characters given in term.
209 /* Read/copy the token */
211 unsigned ParenCount = 0;
212 while (*L && (ParenCount > 0 || strchr (Term, *L) == 0)) {
215 } else if (I == BufSize-1) {
216 /* Cannot store this character, this is an input error (maybe
217 * identifier too long or similar).
219 Error ("ASM code error: syntax error");
224 } else if (*L == '(') {
230 /* Terminate the buffer contents */
233 /* Return the updated line pointer */
239 static CodeEntry* ParseInsn (CodeSeg* S, LineInfo* LI, const char* L)
240 /* Parse an instruction nnd generate a code entry from it. If the line contains
241 * errors, output an error message and return NULL.
242 * For simplicity, we don't accept the broad range of input a "real" assembler
243 * does. The instruction and the argument are expected to be separated by
244 * white space, for example.
247 char Mnemo[IDENTSIZE+10];
249 am_t AM = 0; /* Initialize to keep gcc silent */
250 char Arg[IDENTSIZE+10];
255 /* Read the first token and skip white space after it */
256 L = SkipSpace (ReadToken (L, " \t:", Mnemo, sizeof (Mnemo)));
258 /* Check if we have a label */
261 /* Skip the colon and following white space */
265 CS_AddLabel (S, Mnemo);
267 /* If we have reached end of line, bail out, otherwise a mnemonic
274 L = SkipSpace (ReadToken (L, " \t", Mnemo, sizeof (Mnemo)));
277 /* Try to find the opcode description for the mnemonic */
278 OPC = FindOP65 (Mnemo);
280 /* If we didn't find the opcode, print an error and bail out */
282 Error ("ASM code error: %s is not a valid mnemonic", Mnemo);
286 /* Get the addressing mode */
297 StrCopy (Arg, sizeof (Arg), L+1);
303 L = ReadToken (L+1, ",)", Arg, sizeof (Arg));
305 /* Check for errors */
307 Error ("ASM code error: syntax error");
311 /* Check the different indirect modes */
313 /* Expect zp x indirect */
315 if (toupper (*L) != 'X') {
316 Error ("ASM code error: `X' expected");
321 Error ("ASM code error: `)' expected");
326 Error ("ASM code error: syntax error");
330 } else if (*L == ')') {
331 /* zp indirect or zp indirect, y */
335 if (toupper (*L) != 'Y') {
336 Error ("ASM code error: `Y' expected");
341 Error ("ASM code error: syntax error");
345 } else if (*L == '\0') {
348 Error ("ASM code error: syntax error");
364 /* Absolute, maybe indexed */
365 L = ReadToken (L, ",", Arg, sizeof (Arg));
367 /* Absolute, zeropage or branch */
368 if ((OPC->Info & OF_BRA) != 0) {
371 } else if (GetZPInfo(Arg) != 0) {
376 } else if (*L == ',') {
380 Error ("ASM code error: syntax error");
386 if (GetZPInfo(Arg) != 0) {
391 } else if (Reg == 'Y') {
394 Error ("ASM code error: syntax error");
398 Error ("ASM code error: syntax error");
407 /* If the instruction is a branch, check for the label and generate it
408 * if it does not exist. This may lead to unused labels (if the label
409 * is actually an external one) which are removed by the CS_MergeLabels
413 if (AM == AM65_BRA) {
415 /* Generate the hash over the label, then search for the label */
416 unsigned Hash = HashStr (Arg) % CS_LABEL_HASH_SIZE;
417 Label = CS_FindLabel (S, Arg, Hash);
419 /* If we don't have the label, it's a forward ref - create it */
421 /* Generate a new label */
422 Label = CS_NewCodeLabel (S, Arg, Hash);
426 /* We do now have the addressing mode in AM. Allocate a new CodeEntry
427 * structure and initialize it.
429 E = NewCodeEntry (OPC->OPC, AM, Arg, Label, LI);
431 /* Return the new code entry */
437 /*****************************************************************************/
439 /*****************************************************************************/
443 CodeSeg* NewCodeSeg (const char* SegName, SymEntry* Func)
444 /* Create a new code segment, initialize and return it */
449 /* Allocate memory */
450 CodeSeg* S = xmalloc (sizeof (CodeSeg));
452 /* Initialize the fields */
453 S->SegName = xstrdup (SegName);
455 InitCollection (&S->Entries);
456 InitCollection (&S->Labels);
457 for (I = 0; I < sizeof(S->LabelHash) / sizeof(S->LabelHash[0]); ++I) {
461 /* If we have a function given, get the return type of the function.
462 * Assume ANY return type besides void will use the A and X registers.
464 if (S->Func && !IsTypeVoid ((RetType = GetFuncReturn (Func->Type)))) {
465 if (SizeOf (RetType) == SizeOf (type_long)) {
466 S->ExitRegs = REG_EAX;
468 S->ExitRegs = REG_AX;
471 S->ExitRegs = REG_NONE;
474 /* Return the new struct */
480 void CS_AddEntry (CodeSeg* S, struct CodeEntry* E)
481 /* Add an entry to the given code segment */
483 /* Transfer the labels if we have any */
484 CS_MoveLabelsToEntry (S, E);
486 /* Add the entry to the list of code entries in this segment */
487 CollAppend (&S->Entries, E);
492 void CS_AddVLine (CodeSeg* S, LineInfo* LI, const char* Format, va_list ap)
493 /* Add a line to the given code segment */
497 char Token[IDENTSIZE+10];
499 /* Format the line */
501 xvsprintf (Buf, sizeof (Buf), Format, ap);
503 /* Skip whitespace */
506 /* Check which type of instruction we have */
507 E = 0; /* Assume no insn created */
511 /* Empty line, just ignore it */
515 /* Comment or hint, ignore it for now */
519 /* Control instruction */
520 ReadToken (L, " \t", Token, sizeof (Token));
521 Error ("ASM code error: Pseudo instruction `%s' not supported", Token);
525 E = ParseInsn (S, LI, L);
529 /* If we have a code entry, transfer the labels and insert it */
537 void CS_AddLine (CodeSeg* S, LineInfo* LI, const char* Format, ...)
538 /* Add a line to the given code segment */
541 va_start (ap, Format);
542 CS_AddVLine (S, LI, Format, ap);
548 void CS_InsertEntry (CodeSeg* S, struct CodeEntry* E, unsigned Index)
549 /* Insert the code entry at the index given. Following code entries will be
550 * moved to slots with higher indices.
553 /* Insert the entry into the collection */
554 CollInsert (&S->Entries, E, Index);
559 void CS_DelEntry (CodeSeg* S, unsigned Index)
560 /* Delete an entry from the code segment. This includes moving any associated
561 * labels, removing references to labels and even removing the referenced labels
562 * if the reference count drops to zero.
563 * Note: Labels are moved forward if possible, that is, they are moved to the
564 * next insn (not the preceeding one).
567 /* Get the code entry for the given index */
568 CodeEntry* E = CS_GetEntry (S, Index);
570 /* If the entry has a labels, we have to move this label to the next insn.
571 * If there is no next insn, move the label into the code segement label
572 * pool. The operation is further complicated by the fact that the next
573 * insn may already have a label. In that case change all reference to
574 * this label and delete the label instead of moving it.
576 unsigned Count = CE_GetLabelCount (E);
579 /* The instruction has labels attached. Check if there is a next
582 if (Index == CS_GetEntryCount (S)-1) {
584 /* No next instruction, move to the codeseg label pool */
585 CS_MoveLabelsToPool (S, E);
589 /* There is a next insn, get it */
590 CodeEntry* N = CS_GetEntry (S, Index+1);
592 /* Move labels to the next entry */
593 CS_MoveLabels (S, E, N);
598 /* If this insn references a label, remove the reference. And, if the
599 * the reference count for this label drops to zero, remove this label.
602 /* Remove the reference */
603 CS_RemoveLabelRef (S, E);
606 /* Delete the pointer to the insn */
607 CollDelete (&S->Entries, Index);
609 /* Delete the instruction itself */
615 void CS_DelEntries (CodeSeg* S, unsigned Start, unsigned Count)
616 /* Delete a range of code entries. This includes removing references to labels,
617 * labels attached to the entries and so on.
620 /* Start deleting the entries from the rear, because this involves less
624 CS_DelEntry (S, Start + Count);
630 void CS_MoveEntries (CodeSeg* S, unsigned Start, unsigned Count, unsigned NewPos)
631 /* Move a range of entries from one position to another. Start is the index
632 * of the first entry to move, Count is the number of entries and NewPos is
633 * the index of the target entry. The entry with the index Start will later
634 * have the index NewPos. All entries with indices NewPos and above are
635 * moved to higher indices. If the code block is moved to the end of the
636 * current code, and if pending labels exist, these labels will get attached
637 * to the first instruction of the moved block (the first one after the
641 /* If NewPos is at the end of the code segment, move any labels from the
642 * label pool to the first instruction of the moved range.
644 if (NewPos == CS_GetEntryCount (S)) {
645 CS_MoveLabelsToEntry (S, CS_GetEntry (S, Start));
648 /* Move the code block to the destination */
649 CollMoveMultiple (&S->Entries, Start, Count, NewPos);
654 struct CodeEntry* CS_GetPrevEntry (CodeSeg* S, unsigned Index)
655 /* Get the code entry preceeding the one with the index Index. If there is no
656 * preceeding code entry, return NULL.
660 /* This is the first entry */
663 /* Previous entry available */
664 return CollAtUnchecked (&S->Entries, Index-1);
670 struct CodeEntry* CS_GetNextEntry (CodeSeg* S, unsigned Index)
671 /* Get the code entry following the one with the index Index. If there is no
672 * following code entry, return NULL.
675 if (Index >= CollCount (&S->Entries)-1) {
676 /* This is the last entry */
679 /* Code entries left */
680 return CollAtUnchecked (&S->Entries, Index+1);
686 int CS_GetEntries (CodeSeg* S, struct CodeEntry** List,
687 unsigned Start, unsigned Count)
688 /* Get Count code entries into List starting at index start. Return true if
689 * we got the lines, return false if not enough lines were available.
692 /* Check if enough entries are available */
693 if (Start + Count > CollCount (&S->Entries)) {
697 /* Copy the entries */
699 *List++ = CollAtUnchecked (&S->Entries, Start++);
702 /* We have the entries */
708 unsigned CS_GetEntryIndex (CodeSeg* S, struct CodeEntry* E)
709 /* Return the index of a code entry */
711 int Index = CollIndex (&S->Entries, E);
718 int CS_RangeHasLabel (CodeSeg* S, unsigned Start, unsigned Count)
719 /* Return true if any of the code entries in the given range has a label
720 * attached. If the code segment does not span the given range, check the
721 * possible span instead.
724 unsigned EntryCount = CS_GetEntryCount(S);
726 /* Adjust count. We expect at least Start to be valid. */
727 CHECK (Start < EntryCount);
728 if (Start + Count > EntryCount) {
729 Count = EntryCount - Start;
732 /* Check each entry. Since we have validated the index above, we may
733 * use the unchecked access function in the loop which is faster.
736 const CodeEntry* E = CollAtUnchecked (&S->Entries, Start++);
737 if (CE_HasLabel (E)) {
742 /* No label in the complete range */
748 CodeLabel* CS_AddLabel (CodeSeg* S, const char* Name)
749 /* Add a code label for the next instruction to follow */
751 /* Calculate the hash from the name */
752 unsigned Hash = HashStr (Name) % CS_LABEL_HASH_SIZE;
754 /* Try to find the code label if it does already exist */
755 CodeLabel* L = CS_FindLabel (S, Name, Hash);
757 /* Did we find it? */
759 /* We found it - be sure it does not already have an owner */
761 Error ("ASM label `%s' is already defined", Name);
765 /* Not found - create a new one */
766 L = CS_NewCodeLabel (S, Name, Hash);
769 /* Safety. This call is quite costly, but safety is better */
770 if (CollIndex (&S->Labels, L) >= 0) {
771 Error ("ASM label `%s' is already defined", Name);
775 /* We do now have a valid label. Remember it for later */
776 CollAppend (&S->Labels, L);
778 /* Return the label */
784 CodeLabel* CS_GenLabel (CodeSeg* S, struct CodeEntry* E)
785 /* If the code entry E does already have a label, return it. Otherwise
786 * create a new label, attach it to E and return it.
791 if (CE_HasLabel (E)) {
793 /* Get the label from this entry */
794 L = CE_GetLabel (E, 0);
799 const char* Name = LocalLabelName (GetLocalLabel ());
801 /* Generate the hash over the name */
802 unsigned Hash = HashStr (Name) % CS_LABEL_HASH_SIZE;
804 /* Create a new label */
805 L = CS_NewCodeLabel (S, Name, Hash);
807 /* Attach this label to the code entry */
808 CE_AttachLabel (E, L);
812 /* Return the label */
818 void CS_DelLabel (CodeSeg* S, CodeLabel* L)
819 /* Remove references from this label and delete it. */
823 /* First, remove the label from the hash chain */
824 CS_RemoveLabelFromHash (S, L);
826 /* Remove references from insns jumping to this label */
827 Count = CollCount (&L->JumpFrom);
828 for (I = 0; I < Count; ++I) {
829 /* Get the insn referencing this label */
830 CodeEntry* E = CollAt (&L->JumpFrom, I);
831 /* Remove the reference */
834 CollDeleteAll (&L->JumpFrom);
836 /* Remove the reference to the owning instruction if it has one. The
837 * function may be called for a label without an owner when deleting
838 * unfinished parts of the code. This is unfortunate since it allows
839 * errors to slip through.
842 CollDeleteItem (&L->Owner->Labels, L);
845 /* All references removed, delete the label itself */
851 void CS_MergeLabels (CodeSeg* S)
852 /* Merge code labels. That means: For each instruction, remove all labels but
853 * one and adjust references accordingly.
859 /* First, remove all labels from the label symbol table that don't have an
860 * owner (this means that they are actually external labels but we didn't
861 * know that previously since they may have also been forward references).
863 for (I = 0; I < CS_LABEL_HASH_SIZE; ++I) {
865 /* Get the first label in this hash chain */
866 CodeLabel** L = &S->LabelHash[I];
868 if ((*L)->Owner == 0) {
870 /* The label does not have an owner, remove it from the chain */
874 /* Cleanup any entries jumping to this label */
875 for (J = 0; J < CL_GetRefCount (X); ++J) {
876 /* Get the entry referencing this label */
877 CodeEntry* E = CL_GetRef (X, J);
878 /* And remove the reference */
882 /* Print some debugging output */
884 printf ("Removing unused global label `%s'", X->Name);
887 /* And free the label */
890 /* Label is owned, point to next code label pointer */
896 /* Walk over all code entries */
897 for (I = 0; I < CS_GetEntryCount (S); ++I) {
902 /* Get a pointer to the next entry */
903 CodeEntry* E = CS_GetEntry (S, I);
905 /* If this entry has zero labels, continue with the next one */
906 unsigned LabelCount = CE_GetLabelCount (E);
907 if (LabelCount == 0) {
911 /* We have at least one label. Use the first one as reference label. */
912 RefLab = CE_GetLabel (E, 0);
914 /* Walk through the remaining labels and change references to these
915 * labels to a reference to the one and only label. Delete the labels
916 * that are no longer used. To increase performance, walk backwards
919 for (J = LabelCount-1; J >= 1; --J) {
921 /* Get the next label */
922 CodeLabel* L = CE_GetLabel (E, J);
924 /* Move all references from this label to the reference label */
925 CL_MoveRefs (L, RefLab);
927 /* Remove the label completely. */
931 /* The reference label is the only remaining label. Check if there
932 * are any references to this label, and delete it if this is not
935 if (CollCount (&RefLab->JumpFrom) == 0) {
936 /* Delete the label */
937 CS_DelLabel (S, RefLab);
944 void CS_MoveLabels (CodeSeg* S, struct CodeEntry* Old, struct CodeEntry* New)
945 /* Move all labels from Old to New. The routine will move the labels itself
946 * if New does not have any labels, and move references if there is at least
947 * a label for new. If references are moved, the old label is deleted
951 /* Get the number of labels to move */
952 unsigned OldLabelCount = CE_GetLabelCount (Old);
954 /* Does the new entry have itself a label? */
955 if (CE_HasLabel (New)) {
957 /* The new entry does already have a label - move references */
958 CodeLabel* NewLabel = CE_GetLabel (New, 0);
959 while (OldLabelCount--) {
961 /* Get the next label */
962 CodeLabel* OldLabel = CE_GetLabel (Old, OldLabelCount);
964 /* Move references */
965 CL_MoveRefs (OldLabel, NewLabel);
967 /* Delete the label */
968 CS_DelLabel (S, OldLabel);
974 /* The new entry does not have a label, just move them */
975 while (OldLabelCount--) {
977 /* Move the label to the new entry */
978 CE_MoveLabel (CE_GetLabel (Old, OldLabelCount), New);
987 void CS_RemoveLabelRef (CodeSeg* S, struct CodeEntry* E)
988 /* Remove the reference between E and the label it jumps to. The reference
989 * will be removed on both sides and E->JumpTo will be 0 after that. If
990 * the reference was the only one for the label, the label will get
994 /* Get a pointer to the label and make sure it exists */
995 CodeLabel* L = E->JumpTo;
998 /* Delete the entry from the label */
999 CollDeleteItem (&L->JumpFrom, E);
1001 /* The entry jumps no longer to L */
1004 /* If there are no more references, delete the label */
1005 if (CollCount (&L->JumpFrom) == 0) {
1012 void CS_MoveLabelRef (CodeSeg* S, struct CodeEntry* E, CodeLabel* L)
1013 /* Change the reference of E to L instead of the current one. If this
1014 * was the only reference to the old label, the old label will get
1018 /* Get the old label */
1019 CodeLabel* OldLabel = E->JumpTo;
1021 /* Be sure that code entry references a label */
1022 PRECONDITION (OldLabel != 0);
1024 /* Remove the reference to our label */
1025 CS_RemoveLabelRef (S, E);
1027 /* Use the new label */
1033 void CS_DelCodeAfter (CodeSeg* S, unsigned Last)
1034 /* Delete all entries including the given one */
1036 /* Get the number of entries in this segment */
1037 unsigned Count = CS_GetEntryCount (S);
1039 /* First pass: Delete all references to labels. If the reference count
1040 * for a label drops to zero, delete it.
1043 while (Last < C--) {
1045 /* Get the next entry */
1046 CodeEntry* E = CS_GetEntry (S, C);
1048 /* Check if this entry has a label reference */
1050 /* If the label is a label in the label pool and this is the last
1051 * reference to the label, remove the label from the pool.
1053 CodeLabel* L = E->JumpTo;
1054 int Index = CollIndex (&S->Labels, L);
1055 if (Index >= 0 && CollCount (&L->JumpFrom) == 1) {
1056 /* Delete it from the pool */
1057 CollDelete (&S->Labels, Index);
1060 /* Remove the reference to the label */
1061 CS_RemoveLabelRef (S, E);
1066 /* Second pass: Delete the instructions. If a label attached to an
1067 * instruction still has references, it must be references from outside
1068 * the deleted area. Don't delete the label in this case, just make it
1069 * ownerless and move it to the label pool.
1072 while (Last < C--) {
1074 /* Get the next entry */
1075 CodeEntry* E = CS_GetEntry (S, C);
1077 /* Check if this entry has a label attached */
1078 if (CE_HasLabel (E)) {
1079 /* Move the labels to the pool and clear the owner pointer */
1080 CS_MoveLabelsToPool (S, E);
1083 /* Delete the pointer to the entry */
1084 CollDelete (&S->Entries, C);
1086 /* Delete the entry itself */
1093 void CS_ResetMarks (CodeSeg* S, unsigned First, unsigned Last)
1094 /* Remove all user marks from the entries in the given range */
1096 while (First <= Last) {
1097 CE_ResetMark (CS_GetEntry (S, First++));
1103 int CS_IsBasicBlock (CodeSeg* S, unsigned First, unsigned Last)
1104 /* Check if the given code segment range is a basic block. That is, check if
1105 * First is the only entrance and Last is the only exit. This means that no
1106 * jump/branch inside the block may jump to an insn below First or after(!)
1107 * Last, and that no insn may jump into this block from the outside.
1112 /* Don't accept invalid ranges */
1113 CHECK (First <= Last);
1115 /* First pass: Walk over the range and remove all marks from the entries */
1116 CS_ResetMarks (S, First, Last);
1118 /* Second pass: Walk over the range checking all labels. Note: There may be
1119 * label on the first insn which is ok.
1124 /* Get the next entry */
1125 CodeEntry* E = CS_GetEntry (S, I);
1127 /* Check if this entry has one or more labels, if so, check which
1128 * entries jump to this label.
1130 unsigned LabelCount = CE_GetLabelCount (E);
1131 unsigned LabelIndex;
1132 for (LabelIndex = 0; LabelIndex < LabelCount; ++LabelIndex) {
1134 /* Get this label */
1135 CodeLabel* L = CE_GetLabel (E, LabelIndex);
1137 /* Walk over all entries that jump to this label. Check for each
1138 * of the entries if it is out of the range.
1140 unsigned RefCount = CL_GetRefCount (L);
1142 for (RefIndex = 0; RefIndex < RefCount; ++RefIndex) {
1144 /* Get the code entry that jumps here */
1145 CodeEntry* Ref = CL_GetRef (L, RefIndex);
1147 /* Walk over out complete range and check if we find the
1148 * refering entry. This is cheaper than using CS_GetEntryIndex,
1149 * because CS_GetEntryIndex will search the complete code
1150 * segment and not just our range.
1153 for (J = First; J <= Last; ++J) {
1154 if (Ref == CS_GetEntry (S, J)) {
1159 /* We did not find the entry. This means that the jump to
1160 * out code segment entry E came from outside the range,
1161 * which in turn means that the given range is not a basic
1164 CS_ResetMarks (S, First, Last);
1168 /* If we come here, we found the entry. Mark it, so we know
1169 * that the branch to the label is in range.
1179 /* Third pass: Walk again over the range and check all branches. If we
1180 * find a branch that is not marked, its target is not inside the range
1181 * (since we checked all the labels in the range before).
1186 /* Get the next entry */
1187 CodeEntry* E = CS_GetEntry (S, I);
1189 /* Check if this is a branch and if so, if it has a mark */
1190 if (E->Info & (OF_UBRA | OF_CBRA)) {
1191 if (!CE_HasMark (E)) {
1192 /* No mark means not a basic block. Before bailing out, be sure
1193 * to remove the marks from the remaining entries.
1195 CS_ResetMarks (S, I+1, Last);
1199 /* Remove the mark */
1207 /* Done - this is a basic block */
1213 void CS_OutputPrologue (const CodeSeg* S, FILE* F)
1214 /* If the given code segment is a code segment for a function, output the
1215 * assembler prologue into the file. That is: Output a comment header, switch
1216 * to the correct segment and enter the local function scope. If the code
1217 * segment is global, do nothing.
1220 /* Get the function associated with the code segment */
1221 SymEntry* Func = S->Func;
1223 /* If the code segment is associated with a function, print a function
1224 * header and enter a local scope. Be sure to switch to the correct
1225 * segment before outputing the function label.
1228 CS_PrintFunctionHeader (S, F);
1229 fprintf (F, ".segment\t\"%s\"\n\n.proc\t_%s\n\n", S->SegName, Func->Name);
1236 void CS_OutputEpilogue (const CodeSeg* S, FILE* F)
1237 /* If the given code segment is a code segment for a function, output the
1238 * assembler epilogue into the file. That is: Close the local function scope.
1242 fprintf (F, "\n.endproc\n\n");
1248 void CS_Output (const CodeSeg* S, FILE* F)
1249 /* Output the code segment data to a file */
1254 /* Get the number of entries in this segment */
1255 unsigned Count = CS_GetEntryCount (S);
1257 /* If the code segment is empty, bail out here */
1262 /* Output the segment directive */
1263 fprintf (F, ".segment\t\"%s\"\n\n", S->SegName);
1265 /* Output all entries, prepended by the line information if it has changed */
1267 for (I = 0; I < Count; ++I) {
1268 /* Get the next entry */
1269 const CodeEntry* E = CollConstAt (&S->Entries, I);
1270 /* Check if the line info has changed. If so, output the source line
1271 * if the option is enabled and output debug line info if the debug
1272 * option is enabled.
1275 /* Line info has changed, remember the new line info */
1278 /* Add the source line as a comment. Beware: When line continuation
1279 * was used, the line may contain newlines.
1282 const char* L = LI->Line;
1295 /* Add line debug info */
1297 fprintf (F, "\t.dbg\tline, \"%s\", %u\n",
1298 GetInputName (LI), GetInputLine (LI));
1301 /* Output the code */
1305 /* If debug info is enabled, terminate the last line number information */
1307 fprintf (F, "\t.dbg\tline\n");
1313 void CS_FreeRegInfo (CodeSeg* S)
1314 /* Free register infos for all instructions */
1317 for (I = 0; I < CS_GetEntryCount (S); ++I) {
1318 CE_FreeRegInfo (CS_GetEntry(S, I));
1324 void CS_GenRegInfo (CodeSeg* S)
1325 /* Generate register infos for all instructions */
1328 RegContents Regs; /* Initial register contents */
1329 RegContents* CurrentRegs; /* Current register contents */
1330 int WasJump; /* True if last insn was a jump */
1331 int Done; /* All runs done flag */
1333 /* Be sure to delete all register infos */
1336 /* We may need two runs to get back references right */
1339 /* Assume we're done after this run */
1342 /* On entry, the register contents are unknown */
1343 RC_Invalidate (&Regs);
1344 CurrentRegs = &Regs;
1346 /* Walk over all insns and note just the changes from one insn to the
1350 for (I = 0; I < CS_GetEntryCount (S); ++I) {
1354 /* Get the next instruction */
1355 CodeEntry* E = CollAtUnchecked (&S->Entries, I);
1357 /* If the instruction has a label, we need some special handling */
1358 unsigned LabelCount = CE_GetLabelCount (E);
1359 if (LabelCount > 0) {
1361 /* Loop over all entry points that jump here. If these entry
1362 * points already have register info, check if all values are
1363 * known and identical. If all values are identical, and the
1364 * preceeding instruction was not an unconditional branch, check
1365 * if the register value on exit of the preceeding instruction
1366 * is also identical. If all these values are identical, the
1367 * value of a register is known, otherwise it is unknown.
1369 CodeLabel* Label = CE_GetLabel (E, 0);
1372 /* Preceeding insn was an unconditional branch */
1373 CodeEntry* J = CL_GetRef(Label, 0);
1377 RC_Invalidate (&Regs);
1381 Regs = *CurrentRegs;
1385 while (Entry < CL_GetRefCount (Label)) {
1386 /* Get this entry */
1387 CodeEntry* J = CL_GetRef (Label, Entry);
1389 /* No register info for this entry. This means that the
1390 * instruction that jumps here is at higher addresses and
1391 * the jump is a backward jump. We need a second run to
1392 * get the register info right in this case. Until then,
1393 * assume unknown register contents.
1396 RC_Invalidate (&Regs);
1399 if (J->RI->Out2.RegA != Regs.RegA) {
1400 Regs.RegA = UNKNOWN_REGVAL;
1402 if (J->RI->Out2.RegX != Regs.RegX) {
1403 Regs.RegX = UNKNOWN_REGVAL;
1405 if (J->RI->Out2.RegY != Regs.RegY) {
1406 Regs.RegY = UNKNOWN_REGVAL;
1408 if (J->RI->Out2.SRegLo != Regs.SRegLo) {
1409 Regs.SRegLo = UNKNOWN_REGVAL;
1411 if (J->RI->Out2.SRegHi != Regs.SRegHi) {
1412 Regs.SRegHi = UNKNOWN_REGVAL;
1414 if (J->RI->Out2.Tmp1 != Regs.Tmp1) {
1415 Regs.Tmp1 = UNKNOWN_REGVAL;
1420 /* Use this register info */
1421 CurrentRegs = &Regs;
1425 /* Generate register info for this instruction */
1426 CE_GenRegInfo (E, CurrentRegs);
1428 /* Remember for the next insn if this insn was an uncondition branch */
1429 WasJump = (E->Info & OF_UBRA) != 0;
1431 /* Output registers for this insn are input for the next */
1432 CurrentRegs = &E->RI->Out;
1434 /* If this insn is a branch on zero flag, we may have more info on
1435 * register contents for one of both flow directions, but only if
1436 * there is a previous instruction.
1438 if ((E->Info & OF_ZBRA) != 0 && (P = CS_GetPrevEntry (S, I)) != 0) {
1440 /* Get the branch condition */
1441 bc_t BC = GetBranchCond (E->OPC);
1443 /* Check the previous instruction */
1455 /* A is zero in one execution flow direction */
1457 E->RI->Out2.RegA = 0;
1459 E->RI->Out.RegA = 0;
1464 /* If this is an immidiate compare, the A register has
1465 * the value of the compare later.
1467 if (CE_KnownImm (P)) {
1469 E->RI->Out2.RegA = (unsigned char)P->Num;
1471 E->RI->Out.RegA = (unsigned char)P->Num;
1477 /* If this is an immidiate compare, the X register has
1478 * the value of the compare later.
1480 if (CE_KnownImm (P)) {
1482 E->RI->Out2.RegX = (unsigned char)P->Num;
1484 E->RI->Out.RegX = (unsigned char)P->Num;
1490 /* If this is an immidiate compare, the Y register has
1491 * the value of the compare later.
1493 if (CE_KnownImm (P)) {
1495 E->RI->Out2.RegY = (unsigned char)P->Num;
1497 E->RI->Out.RegY = (unsigned char)P->Num;
1506 /* X is zero in one execution flow direction */
1508 E->RI->Out2.RegX = 0;
1510 E->RI->Out.RegX = 0;
1518 /* X is zero in one execution flow direction */
1520 E->RI->Out2.RegY = 0;
1522 E->RI->Out.RegY = 0;
1528 /* If the branch is a beq, both A and X are zero at the
1529 * branch target, otherwise they are zero at the next
1533 E->RI->Out2.RegA = E->RI->Out2.RegX = 0;
1535 E->RI->Out.RegA = E->RI->Out.RegX = 0;
1541 /* If the branch is a beq, both A and Y are zero at the
1542 * branch target, otherwise they are zero at the next
1546 E->RI->Out2.RegA = E->RI->Out2.RegY = 0;
1548 E->RI->Out.RegA = E->RI->Out.RegY = 0;