1 /*****************************************************************************/
5 /* Segment handling for the ld65 linker */
9 /* (C) 1998-2011, Ullrich von Bassewitz */
10 /* Roemerstrasse 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 /*****************************************************************************/
49 /*****************************************************************************/
51 /*****************************************************************************/
55 /* Segment structure */
56 typedef struct Segment Segment;
58 unsigned Name; /* Name index of the segment */
59 unsigned Id; /* Segment id for debug info */
60 Segment* Next; /* Hash list */
61 Collection Sections; /* Sections in this segment */
62 unsigned long PC; /* PC were this segment is located */
63 unsigned long Size; /* Size of data so far */
64 struct ObjData* AlignObj; /* Module that requested the alignment */
65 const char* OutputName; /* Name of output file or NULL */
66 unsigned long OutputOffs; /* Offset in output file */
67 unsigned char Align; /* Alignment needed */
68 unsigned char FillVal; /* Value to use for fill bytes */
69 unsigned char AddrSize; /* Address size of segment */
70 unsigned char ReadOnly; /* True for readonly segments (config) */
71 unsigned char Relocatable; /* True if the segment is relocatable */
72 unsigned char Placed; /* Did we place this segment already? */
73 unsigned char Dumped; /* Did we dump this segment? */
78 /* Section structure (a section is a part of a segment) */
79 typedef struct Section Section;
81 Section* Next; /* List of sections in a segment */
82 Segment* Seg; /* Segment that contains the section */
83 struct ObjData* Obj; /* Object file this section comes from */
84 struct Fragment* FragRoot; /* Fragment list */
85 struct Fragment* FragLast; /* Pointer to last fragment */
86 unsigned long Offs; /* Offset into the segment */
87 unsigned long Size; /* Size of the section */
88 unsigned long Fill; /* Fill bytes for alignment */
89 unsigned char Align; /* Alignment */
90 unsigned char AddrSize; /* Address size of segment */
95 /* Prototype for a function that is used to write expressions to the target
96 * file (used in SegWrite). It returns one of the following values:
98 #define SEG_EXPR_OK 0U /* Ok */
99 #define SEG_EXPR_RANGE_ERROR 1U /* Range error */
100 #define SEG_EXPR_TOO_COMPLEX 2U /* Expression too complex */
101 #define SEG_EXPR_INVALID 3U /* Expression is invalid (e.g. unmapped segment) */
103 typedef unsigned (*SegWriteFunc) (ExprNode* E, /* The expression to write */
104 int Signed, /* Signed expression? */
105 unsigned Size, /* Size (=range) */
106 unsigned long Offs, /* File offset */
107 void* Data); /* Callers data */
111 /*****************************************************************************/
113 /*****************************************************************************/
117 Segment* GetSegment (unsigned Name, unsigned char AddrSize, const char* ObjName);
118 /* Search for a segment and return an existing one. If the segment does not
119 * exist, create a new one and return that. ObjName is only used for the error
120 * message and may be NULL if the segment is linker generated.
123 Section* NewSection (Segment* Seg, unsigned char Align, unsigned char AddrSize);
124 /* Create a new section for the given segment */
126 Section* ReadSection (FILE* F, struct ObjData* O);
127 /* Read a section from a file */
129 Segment* SegFind (unsigned Name);
130 /* Return the given segment or NULL if not found. */
132 int IsBSSType (Segment* S);
133 /* Check if the given segment is a BSS style segment, that is, it does not
134 * contain non-zero data.
138 /* Dump the segments and it's contents */
140 unsigned SegWriteConstExpr (FILE* F, ExprNode* E, int Signed, unsigned Size);
141 /* Write a supposedly constant expression to the target file. Do a range
142 * check and return one of the SEG_EXPR_xxx codes.
145 void SegWrite (const char* TgtName, FILE* Tgt, Segment* S, SegWriteFunc F, void* Data);
146 /* Write the data from the given segment to a file. For expressions, F is
147 * called (see description of SegWriteFunc above).
150 unsigned SegmentCount (void);
151 /* Return the total number of segments */
153 void PrintSegmentMap (FILE* F);
154 /* Print a segment map to the given file */
156 void PrintDbgSegments (FILE* F);
157 /* Output the segments to the debug file */
159 void CheckSegments (void);
160 /* Walk through the segment list and check if there are segments that were
161 * not written to the output file. Output an error if this is the case.
166 /* End of segments.h */