1 /*****************************************************************************/
5 /* Module to handle the raw binary format */
9 /* (C) 1999-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 /*****************************************************************************/
41 #include "alignment.h"
60 /*****************************************************************************/
62 /*****************************************************************************/
67 unsigned Undef; /* Count of undefined externals */
68 FILE* F; /* Output file */
69 const char* Filename; /* Name of output file */
74 /*****************************************************************************/
76 /*****************************************************************************/
80 BinDesc* NewBinDesc (void)
81 /* Create a new binary format descriptor */
83 /* Allocate memory for a new BinDesc struct */
84 BinDesc* D = xmalloc (sizeof (BinDesc));
86 /* Initialize the fields */
91 /* Return the created struct */
97 void FreeBinDesc (BinDesc* D)
98 /* Free a binary format descriptor */
105 static unsigned BinWriteExpr (ExprNode* E, int Signed, unsigned Size,
106 unsigned long Offs attribute ((unused)),
108 /* Called from SegWrite for an expression. Evaluate the expression, check the
109 * range and write the expression value to the file.
112 /* There's a predefined function to handle constant expressions */
113 return SegWriteConstExpr (((BinDesc*)Data)->F, E, Signed, Size);
118 static void PrintBoolVal (const char* Name, int B)
119 /* Print a boolean value for debugging */
121 Print (stdout, 2, " %s = %s\n", Name, B? "true" : "false");
126 static void PrintNumVal (const char* Name, unsigned long V)
127 /* Print a numerical value for debugging */
129 Print (stdout, 2, " %s = 0x%lx\n", Name, V);
134 static void BinWriteMem (BinDesc* D, MemoryArea* M)
135 /* Write the segments of one memory area to a file */
139 /* Get the start address of this memory area */
140 unsigned long Addr = M->Start;
142 /* Debugging: Check that the file offset is correct */
143 if (ftell (D->F) != (long)M->FileOffs) {
144 Internal ("Invalid file offset for memory area %s: %ld/%lu",
145 GetString (M->Name), ftell (D->F), M->FileOffs);
148 /* Walk over all segments in this memory area */
149 for (I = 0; I < CollCount (&M->SegList); ++I) {
153 /* Get the segment */
154 SegDesc* S = CollAtUnchecked (&M->SegList, I);
156 /* Keep the user happy */
157 Print (stdout, 1, " Writing `%s'\n", GetString (S->Name));
159 /* Writes do only occur in the load area and not for BSS segments */
160 DoWrite = (S->Flags & SF_BSS) == 0 && /* No BSS segment */
161 S->Load == M && /* LOAD segment */
162 S->Seg->Dumped == 0; /* Not already written */
164 /* Output debugging stuff */
165 PrintBoolVal ("bss", S->Flags & SF_BSS);
166 PrintBoolVal ("LoadArea", S->Load == M);
167 PrintBoolVal ("Dumped", S->Seg->Dumped);
168 PrintBoolVal ("DoWrite", DoWrite);
169 PrintNumVal ("Address", Addr);
170 PrintNumVal ("FileOffs", (unsigned long) ftell (D->F));
172 /* Check if the alignment for the segment from the linker config is
173 * a multiple for that of the segment.
175 if ((S->RunAlignment % S->Seg->Alignment) != 0) {
176 /* Segment requires another alignment than configured
179 Warning ("Segment `%s' is not aligned properly. Resulting "
180 "executable may not be functional.",
181 GetString (S->Name));
184 /* If this is the run memory area, we must apply run alignment. If
185 * this is not the run memory area but the load memory area (which
186 * means that both are different), we must apply load alignment.
187 * Beware: DoWrite may be true even if this is the run memory area,
188 * because it may be also the load memory area.
192 /* Handle ALIGN and OFFSET/START */
193 if (S->Flags & SF_ALIGN) {
194 /* Align the address */
195 unsigned long NewAddr = AlignAddr (Addr, S->RunAlignment);
196 if (DoWrite || (M->Flags & MF_FILL) != 0) {
197 WriteMult (D->F, M->FillVal, NewAddr - Addr);
198 PrintNumVal ("SF_ALIGN", NewAddr - Addr);
201 } else if (S->Flags & (SF_OFFSET | SF_START)) {
202 unsigned long NewAddr = S->Addr;
203 if (S->Flags & SF_OFFSET) {
204 /* It's an offset, not a fixed address, make an address */
207 if (DoWrite || (M->Flags & MF_FILL) != 0) {
208 WriteMult (D->F, M->FillVal, NewAddr-Addr);
209 PrintNumVal ("SF_OFFSET", NewAddr - Addr);
214 } else if (S->Load == M) {
216 /* Handle ALIGN_LOAD */
217 if (S->Flags & SF_ALIGN_LOAD) {
218 /* Align the address */
219 unsigned long NewAddr = AlignAddr (Addr, S->LoadAlignment);
220 if (DoWrite || (M->Flags & MF_FILL) != 0) {
221 WriteMult (D->F, M->FillVal, NewAddr - Addr);
222 PrintNumVal ("SF_ALIGN_LOAD", NewAddr - Addr);
229 /* Now write the segment to disk if it is not a BSS type segment and
230 * if the memory area is the load area.
233 unsigned long P = ftell (D->F);
234 S->Seg->FillVal = M->FillVal;
235 SegWrite (D->Filename, D->F, S->Seg, BinWriteExpr, D);
236 PrintNumVal ("Wrote", (unsigned long) (ftell (D->F) - P));
237 } else if (M->Flags & MF_FILL) {
238 WriteMult (D->F, M->FillVal, S->Seg->Size);
239 PrintNumVal ("Filled", (unsigned long) S->Seg->Size);
242 /* If this was the load memory area, mark the segment as dumped */
247 /* Calculate the new address */
248 Addr += S->Seg->Size;
251 /* If a fill was requested, fill the remaining space */
252 if ((M->Flags & MF_FILL) != 0 && M->FillLevel < M->Size) {
253 unsigned long ToFill = M->Size - M->FillLevel;
254 Print (stdout, 2, " Filling 0x%lx bytes with 0x%02x\n",
256 WriteMult (D->F, M->FillVal, ToFill);
257 M->FillLevel = M->Size;
263 static int BinUnresolved (unsigned Name attribute ((unused)), void* D)
264 /* Called if an unresolved symbol is encountered */
266 /* Unresolved symbols are an error in binary format. Bump the counter
267 * and return zero telling the caller that the symbol is indeed
270 ((BinDesc*) D)->Undef++;
276 void BinWriteTarget (BinDesc* D, struct File* F)
277 /* Write a binary output file */
281 /* Place the filename in the control structure */
282 D->Filename = GetString (F->Name);
284 /* Check for unresolved symbols. The function BinUnresolved is called
285 * if we get an unresolved symbol.
287 D->Undef = 0; /* Reset the counter */
288 CheckUnresolvedImports (BinUnresolved, D);
290 /* We had unresolved symbols, cannot create output file */
291 Error ("%u unresolved external(s) found - cannot create output file", D->Undef);
295 D->F = fopen (D->Filename, "wb");
297 Error ("Cannot open `%s': %s", D->Filename, strerror (errno));
300 /* Keep the user happy */
301 Print (stdout, 1, "Opened `%s'...\n", D->Filename);
303 /* Dump all memory areas */
304 for (I = 0; I < CollCount (&F->MemoryAreas); ++I) {
306 MemoryArea* M = CollAtUnchecked (&F->MemoryAreas, I);
307 Print (stdout, 1, " Dumping `%s'\n", GetString (M->Name));
312 if (fclose (D->F) != 0) {
313 Error ("Cannot write to `%s': %s", D->Filename, strerror (errno));
316 /* Reset the file and filename */