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 /*****************************************************************************/
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 #if defined(HAVE_INLINE)
107 INLINE unsigned CS_GetEntryCount (const CodeSeg* S)
108 /* Return the number of entries for the given code segment */
110 return CollCount (&S->Entries);
113 # define CS_GetEntryCount(S) CollCount (&(S)->Entries)
116 void CS_InsertEntry (CodeSeg* S, struct CodeEntry* E, unsigned Index);
117 /* Insert the code entry at the index given. Following code entries will be
118 * moved to slots with higher indices.
121 void CS_DelEntry (CodeSeg* S, unsigned Index);
122 /* Delete an entry from the code segment. This includes moving any associated
123 * labels, removing references to labels and even removing the referenced labels
124 * if the reference count drops to zero.
125 * Note: Labels are moved forward if possible, that is, they are moved to the
126 * next insn (not the preceeding one).
129 void CS_DelEntries (CodeSeg* S, unsigned Start, unsigned Count);
130 /* Delete a range of code entries. This includes removing references to labels,
131 * labels attached to the entries and so on.
134 void CS_MoveEntries (CodeSeg* S, unsigned Start, unsigned Count, unsigned NewPos);
135 /* Move a range of entries from one position to another. Start is the index
136 * of the first entry to move, Count is the number of entries and NewPos is
137 * the index of the target entry. The entry with the index Start will later
138 * have the index NewPos. All entries with indices NewPos and above are
139 * moved to higher indices. If the code block is moved to the end of the
140 * current code, and if pending labels exist, these labels will get attached
141 * to the first instruction of the moved block (the first one after the
145 #if defined(HAVE_INLINE)
146 INLINE void CS_MoveEntry (CodeSeg* S, unsigned OldPos, unsigned NewPos)
147 /* Move an entry from one position to another. OldPos is the current position
148 * of the entry, NewPos is the new position of the entry.
151 CollMove (&S->Entries, OldPos, NewPos);
154 # define CS_MoveEntry(S, OldPos, NewPos) CollMove (&(S)->Entries, OldPos, NewPos)
157 #if defined(HAVE_INLINE)
158 INLINE struct CodeEntry* CS_GetEntry (CodeSeg* S, unsigned Index)
159 /* Get an entry from the given code segment */
161 return CollAt (&S->Entries, Index);
164 # define CS_GetEntry(S, Index) ((struct CodeEntry*) CollAt(&(S)->Entries, (Index)))
167 struct CodeEntry* CS_GetPrevEntry (CodeSeg* S, unsigned Index);
168 /* Get the code entry preceeding the one with the index Index. If there is no
169 * preceeding code entry, return NULL.
172 struct CodeEntry* CS_GetNextEntry (CodeSeg* S, unsigned Index);
173 /* Get the code entry following the one with the index Index. If there is no
174 * following code entry, return NULL.
177 int CS_GetEntries (CodeSeg* S, struct CodeEntry** List,
178 unsigned Start, unsigned Count);
179 /* Get Count code entries into List starting at index start. Return true if
180 * we got the lines, return false if not enough lines were available.
183 unsigned CS_GetEntryIndex (CodeSeg* S, struct CodeEntry* E);
184 /* Return the index of a code entry */
186 int CS_RangeHasLabel (CodeSeg* S, unsigned Start, unsigned Count);
187 /* Return true if any of the code entries in the given range has a label
188 * attached. If the code segment does not span the given range, check the
189 * possible span instead.
192 #if defined(HAVE_INLINE)
193 INLINE int CS_HavePendingLabel (const CodeSeg* S)
194 /* Return true if there are open labels that will get attached to the next
195 * instruction that is added.
198 return (CollCount (&S->Labels) > 0);
201 # define CS_HavePendingLabel(S) (CollCount (&(S)->Labels) > 0)
204 CodeLabel* CS_AddLabel (CodeSeg* S, const char* Name);
205 /* Add a code label for the next instruction to follow */
207 CodeLabel* CS_GenLabel (CodeSeg* S, struct CodeEntry* E);
208 /* If the code entry E does already have a label, return it. Otherwise
209 * create a new label, attach it to E and return it.
212 void CS_DelLabel (CodeSeg* S, CodeLabel* L);
213 /* Remove references from this label and delete it. */
215 void CS_MergeLabels (CodeSeg* S);
216 /* Merge code labels. That means: For each instruction, remove all labels but
217 * one and adjust references accordingly.
220 void CS_MoveLabels (CodeSeg* S, struct CodeEntry* Old, struct CodeEntry* New);
221 /* Move all labels from Old to New. The routine will move the labels itself
222 * if New does not have any labels, and move references if there is at least
223 * a label for new. If references are moved, the old label is deleted
227 void CS_RemoveLabelRef (CodeSeg* S, struct CodeEntry* E);
228 /* Remove the reference between E and the label it jumps to. The reference
229 * will be removed on both sides and E->JumpTo will be 0 after that. If
230 * the reference was the only one for the label, the label will get
234 void CS_MoveLabelRef (CodeSeg* S, struct CodeEntry* E, CodeLabel* L);
235 /* Change the reference of E to L instead of the current one. If this
236 * was the only reference to the old label, the old label will get
240 void CS_DelCodeAfter (CodeSeg* S, unsigned Last);
241 /* Delete all entries including the given one */
243 void CS_ResetMarks (CodeSeg* S, unsigned First, unsigned Last);
244 /* Remove all user marks from the entries in the given range */
246 #if defined(HAVE_INLINE)
247 INLINE void CS_ResetAllMarks (CodeSeg* S)
248 /* Remove all user marks from the code segment */
250 if (CS_GetEntryCount (S) > 0) {
251 CS_ResetMarks (S, 0, CS_GetEntryCount (S));
255 # define CS_ResetAllMarks(S) \
256 ((CS_GetEntryCount (S) > 0)? CS_ResetMarks (S, 0, CS_GetEntryCount (S)) : (void) 0)
259 int CS_IsBasicBlock (CodeSeg* S, unsigned First, unsigned Last);
260 /* Check if the given code segment range is a basic block. That is, check if
261 * First is the only entrance and Last is the only exit. This means that no
262 * jump/branch inside the block may jump to an insn below First or after(!)
263 * Last, and that no insn may jump into this block from the outside.
266 void CS_OutputPrologue (const CodeSeg* S, FILE* F);
267 /* If the given code segment is a code segment for a function, output the
268 * assembler prologue into the file. That is: Output a comment header, switch
269 * to the correct segment and enter the local function scope. If the code
270 * segment is global, do nothing.
273 void CS_OutputEpilogue (const CodeSeg* S, FILE* F);
274 /* If the given code segment is a code segment for a function, output the
275 * assembler epilogue into the file. That is: Close the local function scope.
278 void CS_Output (const CodeSeg* S, FILE* F);
279 /* Output the code segment data to a file */
281 void CS_FreeRegInfo (CodeSeg* S);
282 /* Free register infos for all instructions */
284 void CS_GenRegInfo (CodeSeg* S);
285 /* Generate register infos for all instructions */
289 /* End of codeseg.h */