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 /*****************************************************************************/
56 /*****************************************************************************/
58 /*****************************************************************************/
66 /*****************************************************************************/
68 /*****************************************************************************/
72 /* Size of the label hash table */
73 #define CS_LABEL_HASH_SIZE 29
75 /* Code segment structure */
76 typedef struct CodeSeg CodeSeg;
78 char* SegName; /* Segment name */
79 SymEntry* Func; /* Owner function */
80 Collection Entries; /* List of code entries */
81 Collection Labels; /* Labels for next insn */
82 CodeLabel* LabelHash [CS_LABEL_HASH_SIZE]; /* Label hash table */
83 unsigned short ExitRegs; /* Register use on exit */
88 /*****************************************************************************/
90 /*****************************************************************************/
94 CodeSeg* NewCodeSeg (const char* SegName, SymEntry* Func);
95 /* Create a new code segment, initialize and return it */
97 void CS_AddEntry (CodeSeg* S, struct CodeEntry* E);
98 /* Add an entry to the given code segment */
100 void CS_AddVLine (CodeSeg* S, LineInfo* LI, const char* Format, va_list ap) attribute ((format(printf,3,0)));
101 /* Add a line to the given code segment */
103 void CS_AddLine (CodeSeg* S, LineInfo* LI, const char* Format, ...) attribute ((format(printf,3,4)));
104 /* Add a line to the given code segment */
106 void CS_InsertEntry (CodeSeg* S, struct CodeEntry* E, unsigned Index);
107 /* Insert the code entry at the index given. Following code entries will be
108 * moved to slots with higher indices.
111 void CS_DelEntry (CodeSeg* S, unsigned Index);
112 /* Delete an entry from the code segment. This includes moving any associated
113 * labels, removing references to labels and even removing the referenced labels
114 * if the reference count drops to zero.
117 void CS_DelEntries (CodeSeg* S, unsigned Start, unsigned Count);
118 /* Delete a range of code entries. This includes removing references to labels,
119 * labels attached to the entries and so on.
122 void CS_MoveEntries (CodeSeg* S, unsigned Start, unsigned Count, unsigned NewPos);
123 /* Move a range of entries from one position to another. Start is the index
124 * of the first entry to move, Count is the number of entries and NewPos is
125 * the index of the target entry. The entry with the index Start will later
126 * have the index NewPos. All entries with indices NewPos and above are
127 * moved to higher indices. If the code block is moved to the end of the
128 * current code, and if pending labels exist, these labels will get attached
129 * to the first instruction of the moved block (the first one after the
133 #if defined(HAVE_INLINE)
134 INLINE void CS_MoveEntry (CodeSeg* S, unsigned OldPos, unsigned NewPos)
135 /* Move an entry from one position to another. OldPos is the current position
136 * of the entry, NewPos is the new position of the entry.
139 CollMove (&S->Entries, OldPos, NewPos);
142 # define CS_MoveEntry(S, OldPos, NewPos) CollMove (&(S)->Entries, OldPos, NewPos)
145 #if defined(HAVE_INLINE)
146 INLINE struct CodeEntry* CS_GetEntry (CodeSeg* S, unsigned Index)
147 /* Get an entry from the given code segment */
149 return CollAt (&S->Entries, Index);
152 # define CS_GetEntry(S, Index) CollAt(&(S)->Entries, (Index))
155 struct CodeEntry* CS_GetPrevEntry (CodeSeg* S, unsigned Index);
156 /* Get the code entry preceeding the one with the index Index. If there is no
157 * preceeding code entry, return NULL.
160 struct CodeEntry* CS_GetNextEntry (CodeSeg* S, unsigned Index);
161 /* Get the code entry following the one with the index Index. If there is no
162 * following code entry, return NULL.
165 int CS_GetEntries (CodeSeg* S, struct CodeEntry** List,
166 unsigned Start, unsigned Count);
167 /* Get Count code entries into List starting at index start. Return true if
168 * we got the lines, return false if not enough lines were available.
171 unsigned CS_GetEntryIndex (CodeSeg* S, struct CodeEntry* E);
172 /* Return the index of a code entry */
174 CodeLabel* CS_AddLabel (CodeSeg* S, const char* Name);
175 /* Add a code label for the next instruction to follow */
177 CodeLabel* CS_GenLabel (CodeSeg* S, struct CodeEntry* E);
178 /* If the code entry E does already have a label, return it. Otherwise
179 * create a new label, attach it to E and return it.
182 void CS_DelLabel (CodeSeg* S, CodeLabel* L);
183 /* Remove references from this label and delete it. */
185 void CS_MergeLabels (CodeSeg* S);
186 /* Merge code labels. That means: For each instruction, remove all labels but
187 * one and adjust references accordingly.
190 void CS_MoveLabels (CodeSeg* S, struct CodeEntry* Old, struct CodeEntry* New);
191 /* Move all labels from Old to New. The routine will move the labels itself
192 * if New does not have any labels, and move references if there is at least
193 * a label for new. If references are moved, the old label is deleted
197 void CS_RemoveLabelRef (CodeSeg* S, struct CodeEntry* E);
198 /* Remove the reference between E and the label it jumps to. The reference
199 * will be removed on both sides and E->JumpTo will be 0 after that. If
200 * the reference was the only one for the label, the label will get
204 void CS_MoveLabelRef (CodeSeg* S, struct CodeEntry* E, CodeLabel* L);
205 /* Change the reference of E to L instead of the current one. If this
206 * was the only reference to the old label, the old label will get
210 void CS_DelCodeAfter (CodeSeg* S, unsigned Last);
211 /* Delete all entries including the given one */
213 void CS_Output (const CodeSeg* S, FILE* F);
214 /* Output the code segment data to a file */
216 #if defined(HAVE_INLINE)
217 INLINE unsigned CS_GetEntryCount (const CodeSeg* S)
218 /* Return the number of entries for the given code segment */
220 return CollCount (&S->Entries);
223 # define CS_GetEntryCount(S) CollCount (&(S)->Entries)
226 void CS_FreeRegInfo (CodeSeg* S);
227 /* Free register infos for all instructions */
229 void CS_GenRegInfo (CodeSeg* S);
230 /* Generate register infos for all instructions */
234 /* End of codeseg.h */