git.sur5r.net Git - cc65/blob - src/cc65/codeseg.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 codeseg.h                                 */
   4 /*                                                                           */
   5 /*                          Code segment structure                           */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2001-2002 Ullrich von Bassewitz                                       */
  10 /*               Wacholderweg 14                                             */
  11 /*               D-70597 Stuttgart                                           */
  12 /* EMail:        uz@cc65.org                                                 */
  13 /*                                                                           */
  14 /*                                                                           */
  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.                                    */
  18 /*                                                                           */
  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:                            */
  22 /*                                                                           */
  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              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef CODESEG_H
  37 #define CODESEG_H
  38
  39
  40
  41 #include <stdarg.h>
  42 #include <stdio.h>
  43
  44 /* common */
  45 #include "attrib.h"
  46 #include "coll.h"
  47 #include "inline.h"
  48
  49 /* cc65 */
  50 #include "codelab.h"
  51 #include "lineinfo.h"
  52 #include "symentry.h"
  53
  54
  55
  56 /*****************************************************************************/
  57 /*                                 Forwards                                  */
  58 /*****************************************************************************/
  59
  60
  61
  62 struct CodeEntry;
  63
  64
  65
  66 /*****************************************************************************/
  67 /*                                   Data                                    */
  68 /*****************************************************************************/
  69
  70
  71
  72 /* Size of the label hash table */
  73 #define CS_LABEL_HASH_SIZE      29
  74
  75 /* Code segment structure */
  76 typedef struct CodeSeg CodeSeg;
  77 struct 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 */
  84 };
  85
  86
  87
  88 /*****************************************************************************/
  89 /*                                   Code                                    */
  90 /*****************************************************************************/
  91
  92
  93
  94 CodeSeg* NewCodeSeg (const char* SegName, SymEntry* Func);
  95 /* Create a new code segment, initialize and return it */
  96
  97 void CS_AddEntry (CodeSeg* S, struct CodeEntry* E);
  98 /* Add an entry to the given code segment */
  99
 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 */
 102
 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 */
 105
 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.
 109  */
 110
 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.
 115  * Note: Labels are moved forward if possible, that is, they are moved to the
 116  * next insn (not the preceeding one).
 117  */
 118
 119 void CS_DelEntries (CodeSeg* S, unsigned Start, unsigned Count);
 120 /* Delete a range of code entries. This includes removing references to labels,
 121  * labels attached to the entries and so on.
 122  */
 123
 124 void CS_MoveEntries (CodeSeg* S, unsigned Start, unsigned Count, unsigned NewPos);
 125 /* Move a range of entries from one position to another. Start is the index
 126  * of the first entry to move, Count is the number of entries and NewPos is
 127  * the index of the target entry. The entry with the index Start will later
 128  * have the index NewPos. All entries with indices NewPos and above are
 129  * moved to higher indices. If the code block is moved to the end of the
 130  * current code, and if pending labels exist, these labels will get attached
 131  * to the first instruction of the moved block (the first one after the
 132  * current code end)
 133  */
 134
 135 #if defined(HAVE_INLINE)
 136 INLINE void CS_MoveEntry (CodeSeg* S, unsigned OldPos, unsigned NewPos)
 137 /* Move an entry from one position to another. OldPos is the current position
 138  * of the entry, NewPos is the new position of the entry.
 139  */
 140 {
 141     CollMove (&S->Entries, OldPos, NewPos);
 142 }
 143 #else
 144 #  define CS_MoveEntry(S, OldPos, NewPos)       CollMove (&(S)->Entries, OldPos, NewPos)
 145 #endif
 146
 147 #if defined(HAVE_INLINE)
 148 INLINE struct CodeEntry* CS_GetEntry (CodeSeg* S, unsigned Index)
 149 /* Get an entry from the given code segment */
 150 {
 151     return CollAt (&S->Entries, Index);
 152 }
 153 #else
 154 #  define CS_GetEntry(S, Index) CollAt(&(S)->Entries, (Index))
 155 #endif
 156
 157 struct CodeEntry* CS_GetPrevEntry (CodeSeg* S, unsigned Index);
 158 /* Get the code entry preceeding the one with the index Index. If there is no
 159  * preceeding code entry, return NULL.
 160  */
 161
 162 struct CodeEntry* CS_GetNextEntry (CodeSeg* S, unsigned Index);
 163 /* Get the code entry following the one with the index Index. If there is no
 164  * following code entry, return NULL.
 165  */
 166
 167 int CS_GetEntries (CodeSeg* S, struct CodeEntry** List,
 168                    unsigned Start, unsigned Count);
 169 /* Get Count code entries into List starting at index start. Return true if
 170  * we got the lines, return false if not enough lines were available.
 171  */
 172
 173 unsigned CS_GetEntryIndex (CodeSeg* S, struct CodeEntry* E);
 174 /* Return the index of a code entry */
 175
 176 int CS_RangeHasLabel (CodeSeg* S, unsigned Start, unsigned Count);
 177 /* Return true if any of the code entries in the given range has a label
 178  * attached. If the code segment does not span the given range, check the
 179  * possible span instead.
 180  */
 181
 182 CodeLabel* CS_AddLabel (CodeSeg* S, const char* Name);
 183 /* Add a code label for the next instruction to follow */
 184
 185 CodeLabel* CS_GenLabel (CodeSeg* S, struct CodeEntry* E);
 186 /* If the code entry E does already have a label, return it. Otherwise
 187  * create a new label, attach it to E and return it.
 188  */
 189
 190 void CS_DelLabel (CodeSeg* S, CodeLabel* L);
 191 /* Remove references from this label and delete it. */
 192
 193 void CS_MergeLabels (CodeSeg* S);
 194 /* Merge code labels. That means: For each instruction, remove all labels but
 195  * one and adjust references accordingly.
 196  */
 197
 198 void CS_MoveLabels (CodeSeg* S, struct CodeEntry* Old, struct CodeEntry* New);
 199 /* Move all labels from Old to New. The routine will move the labels itself
 200  * if New does not have any labels, and move references if there is at least
 201  * a label for new. If references are moved, the old label is deleted
 202  * afterwards.
 203  */
 204
 205 void CS_RemoveLabelRef (CodeSeg* S, struct CodeEntry* E);
 206 /* Remove the reference between E and the label it jumps to. The reference
 207  * will be removed on both sides and E->JumpTo will be 0 after that. If
 208  * the reference was the only one for the label, the label will get
 209  * deleted.
 210  */
 211
 212 void CS_MoveLabelRef (CodeSeg* S, struct CodeEntry* E, CodeLabel* L);
 213 /* Change the reference of E to L instead of the current one. If this
 214  * was the only reference to the old label, the old label will get
 215  * deleted.
 216  */
 217
 218 void CS_DelCodeAfter (CodeSeg* S, unsigned Last);
 219 /* Delete all entries including the given one */
 220
 221 void CS_OutputPrologue (const CodeSeg* S, FILE* F);
 222 /* If the given code segment is a code segment for a function, output the
 223  * assembler prologue into the file. That is: Output a comment header, switch
 224  * to the correct segment and enter the local function scope. If the code
 225  * segment is global, do nothing.
 226  */
 227
 228 void CS_OutputEpilogue (const CodeSeg* S, FILE* F);
 229 /* If the given code segment is a code segment for a function, output the
 230  * assembler epilogue into the file. That is: Close the local function scope.
 231  */
 232
 233 void CS_Output (const CodeSeg* S, FILE* F);
 234 /* Output the code segment data to a file */
 235
 236 #if defined(HAVE_INLINE)
 237 INLINE unsigned CS_GetEntryCount (const CodeSeg* S)
 238 /* Return the number of entries for the given code segment */
 239 {
 240     return CollCount (&S->Entries);
 241 }
 242 #else
 243 #  define CS_GetEntryCount(S)   CollCount (&(S)->Entries)
 244 #endif
 245
 246 void CS_FreeRegInfo (CodeSeg* S);
 247 /* Free register infos for all instructions */
 248
 249 void CS_GenRegInfo (CodeSeg* S);
 250 /* Generate register infos for all instructions */
 251
 252
 253
 254 /* End of codeseg.h */
 255 #endif
 256
 257
 258