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-2004 Ullrich von Bassewitz                                       */
  10 /*               Römerstrasse 52                                             */
  11 /*               D-70794 Filderstadt                                         */
  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     /* Optimization settings for this segment */
  86     unsigned char   Optimize;                   /* On/off switch */
  87     unsigned        CodeSizeFactor;
  88 };
  89
  90
  91
  92 /*****************************************************************************/
  93 /*                                   Code                                    */
  94 /*****************************************************************************/
  95
  96
  97
  98 CodeSeg* NewCodeSeg (const char* SegName, SymEntry* Func);
  99 /* Create a new code segment, initialize and return it */
 100
 101 void CS_AddEntry (CodeSeg* S, struct CodeEntry* E);
 102 /* Add an entry to the given code segment */
 103
 104 void CS_AddVLine (CodeSeg* S, LineInfo* LI, const char* Format, va_list ap) attribute ((format(printf,3,0)));
 105 /* Add a line to the given code segment */
 106
 107 void CS_AddLine (CodeSeg* S, LineInfo* LI, const char* Format, ...) attribute ((format(printf,3,4)));
 108 /* Add a line to the given code segment */
 109
 110 #if defined(HAVE_INLINE)
 111 INLINE unsigned CS_GetEntryCount (const CodeSeg* S)
 112 /* Return the number of entries for the given code segment */
 113 {
 114     return CollCount (&S->Entries);
 115 }
 116 #else
 117 #  define CS_GetEntryCount(S)   CollCount (&(S)->Entries)
 118 #endif
 119
 120 void CS_InsertEntry (CodeSeg* S, struct CodeEntry* E, unsigned Index);
 121 /* Insert the code entry at the index given. Following code entries will be
 122  * moved to slots with higher indices.
 123  */
 124
 125 void CS_DelEntry (CodeSeg* S, unsigned Index);
 126 /* Delete an entry from the code segment. This includes moving any associated
 127  * labels, removing references to labels and even removing the referenced labels
 128  * if the reference count drops to zero.
 129  * Note: Labels are moved forward if possible, that is, they are moved to the
 130  * next insn (not the preceeding one).
 131  */
 132
 133 void CS_DelEntries (CodeSeg* S, unsigned Start, unsigned Count);
 134 /* Delete a range of code entries. This includes removing references to labels,
 135  * labels attached to the entries and so on.
 136  */
 137
 138 void CS_MoveEntries (CodeSeg* S, unsigned Start, unsigned Count, unsigned NewPos);
 139 /* Move a range of entries from one position to another. Start is the index
 140  * of the first entry to move, Count is the number of entries and NewPos is
 141  * the index of the target entry. The entry with the index Start will later
 142  * have the index NewPos. All entries with indices NewPos and above are
 143  * moved to higher indices. If the code block is moved to the end of the
 144  * current code, and if pending labels exist, these labels will get attached
 145  * to the first instruction of the moved block (the first one after the
 146  * current code end)
 147  */
 148
 149 #if defined(HAVE_INLINE)
 150 INLINE void CS_MoveEntry (CodeSeg* S, unsigned OldPos, unsigned NewPos)
 151 /* Move an entry from one position to another. OldPos is the current position
 152  * of the entry, NewPos is the new position of the entry.
 153  */
 154 {
 155     CollMove (&S->Entries, OldPos, NewPos);
 156 }
 157 #else
 158 #  define CS_MoveEntry(S, OldPos, NewPos)       CollMove (&(S)->Entries, OldPos, NewPos)
 159 #endif
 160
 161 #if defined(HAVE_INLINE)
 162 INLINE struct CodeEntry* CS_GetEntry (CodeSeg* S, unsigned Index)
 163 /* Get an entry from the given code segment */
 164 {
 165     return CollAt (&S->Entries, Index);
 166 }
 167 #else
 168 #  define CS_GetEntry(S, Index) ((struct CodeEntry*) CollAt(&(S)->Entries, (Index)))
 169 #endif
 170
 171 struct CodeEntry* CS_GetPrevEntry (CodeSeg* S, unsigned Index);
 172 /* Get the code entry preceeding the one with the index Index. If there is no
 173  * preceeding code entry, return NULL.
 174  */
 175
 176 struct CodeEntry* CS_GetNextEntry (CodeSeg* S, unsigned Index);
 177 /* Get the code entry following the one with the index Index. If there is no
 178  * following code entry, return NULL.
 179  */
 180
 181 int CS_GetEntries (CodeSeg* S, struct CodeEntry** List,
 182                    unsigned Start, unsigned Count);
 183 /* Get Count code entries into List starting at index start. Return true if
 184  * we got the lines, return false if not enough lines were available.
 185  */
 186
 187 unsigned CS_GetEntryIndex (CodeSeg* S, struct CodeEntry* E);
 188 /* Return the index of a code entry */
 189
 190 int CS_RangeHasLabel (CodeSeg* S, unsigned Start, unsigned Count);
 191 /* Return true if any of the code entries in the given range has a label
 192  * attached. If the code segment does not span the given range, check the
 193  * possible span instead.
 194  */
 195
 196 #if defined(HAVE_INLINE)
 197 INLINE int CS_HavePendingLabel (const CodeSeg* S)
 198 /* Return true if there are open labels that will get attached to the next
 199  * instruction that is added.
 200  */
 201 {
 202     return (CollCount (&S->Labels) > 0);
 203 }
 204 #else
 205 #  define CS_HavePendingLabel(S)        (CollCount (&(S)->Labels) > 0)
 206 #endif
 207
 208 CodeLabel* CS_AddLabel (CodeSeg* S, const char* Name);
 209 /* Add a code label for the next instruction to follow */
 210
 211 CodeLabel* CS_GenLabel (CodeSeg* S, struct CodeEntry* E);
 212 /* If the code entry E does already have a label, return it. Otherwise
 213  * create a new label, attach it to E and return it.
 214  */
 215
 216 void CS_DelLabel (CodeSeg* S, CodeLabel* L);
 217 /* Remove references from this label and delete it. */
 218
 219 void CS_MergeLabels (CodeSeg* S);
 220 /* Merge code labels. That means: For each instruction, remove all labels but
 221  * one and adjust references accordingly.
 222  */
 223
 224 void CS_MoveLabels (CodeSeg* S, struct CodeEntry* Old, struct CodeEntry* New);
 225 /* Move all labels from Old to New. The routine will move the labels itself
 226  * if New does not have any labels, and move references if there is at least
 227  * a label for new. If references are moved, the old label is deleted
 228  * afterwards.
 229  */
 230
 231 void CS_RemoveLabelRef (CodeSeg* S, struct CodeEntry* E);
 232 /* Remove the reference between E and the label it jumps to. The reference
 233  * will be removed on both sides and E->JumpTo will be 0 after that. If
 234  * the reference was the only one for the label, the label will get
 235  * deleted.
 236  */
 237
 238 void CS_MoveLabelRef (CodeSeg* S, struct CodeEntry* E, CodeLabel* L);
 239 /* Change the reference of E to L instead of the current one. If this
 240  * was the only reference to the old label, the old label will get
 241  * deleted.
 242  */
 243
 244 void CS_DelCodeAfter (CodeSeg* S, unsigned Last);
 245 /* Delete all entries including the given one */
 246
 247 void CS_ResetMarks (CodeSeg* S, unsigned First, unsigned Last);
 248 /* Remove all user marks from the entries in the given range */
 249
 250 #if defined(HAVE_INLINE)
 251 INLINE void CS_ResetAllMarks (CodeSeg* S)
 252 /* Remove all user marks from the code segment */
 253 {
 254     if (CS_GetEntryCount (S) > 0) {
 255         CS_ResetMarks (S, 0, CS_GetEntryCount (S));
 256     }
 257 }
 258 #else
 259 #  define CS_ResetAllMarks(S) \
 260         ((CS_GetEntryCount (S) > 0)? CS_ResetMarks (S, 0, CS_GetEntryCount (S)) : (void) 0)
 261 #endif
 262
 263 int CS_IsBasicBlock (CodeSeg* S, unsigned First, unsigned Last);
 264 /* Check if the given code segment range is a basic block. That is, check if
 265  * First is the only entrance and Last is the only exit. This means that no
 266  * jump/branch inside the block may jump to an insn below First or after(!)
 267  * Last, and that no insn may jump into this block from the outside.
 268  */
 269
 270 void CS_OutputPrologue (const CodeSeg* S, FILE* F);
 271 /* If the given code segment is a code segment for a function, output the
 272  * assembler prologue into the file. That is: Output a comment header, switch
 273  * to the correct segment and enter the local function scope. If the code
 274  * segment is global, do nothing.
 275  */
 276
 277 void CS_OutputEpilogue (const CodeSeg* S, FILE* F);
 278 /* If the given code segment is a code segment for a function, output the
 279  * assembler epilogue into the file. That is: Close the local function scope.
 280  */
 281
 282 void CS_Output (CodeSeg* S, FILE* F);
 283 /* Output the code segment data to a file */
 284
 285 void CS_FreeRegInfo (CodeSeg* S);
 286 /* Free register infos for all instructions */
 287
 288 void CS_GenRegInfo (CodeSeg* S);
 289 /* Generate register infos for all instructions */
 290
 291
 292
 293 /* End of codeseg.h */
 294 #endif
 295
 296
 297