1 /*****************************************************************************/
5 /* Module to handle the raw binary format */
9 /* (C) 1999-2010, 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 /*****************************************************************************/
59 /*****************************************************************************/
61 /*****************************************************************************/
66 unsigned Undef; /* Count of undefined externals */
67 FILE* F; /* Output file */
68 const char* Filename; /* Name of output file */
73 /*****************************************************************************/
75 /*****************************************************************************/
79 BinDesc* NewBinDesc (void)
80 /* Create a new binary format descriptor */
82 /* Allocate memory for a new BinDesc struct */
83 BinDesc* D = xmalloc (sizeof (BinDesc));
85 /* Initialize the fields */
90 /* Return the created struct */
96 void FreeBinDesc (BinDesc* D)
97 /* Free a binary format descriptor */
104 static unsigned BinWriteExpr (ExprNode* E, int Signed, unsigned Size,
105 unsigned long Offs attribute ((unused)),
107 /* Called from SegWrite for an expression. Evaluate the expression, check the
108 * range and write the expression value to the file.
111 /* There's a predefined function to handle constant expressions */
112 return SegWriteConstExpr (((BinDesc*)Data)->F, E, Signed, Size);
117 static void PrintBoolVal (const char* Name, int B)
118 /* Print a boolean value for debugging */
120 Print (stdout, 2, " %s = %s\n", Name, B? "true" : "false");
125 static void PrintNumVal (const char* Name, unsigned long V)
126 /* Print a numerical value for debugging */
128 Print (stdout, 2, " %s = 0x%lx\n", Name, V);
133 static void BinWriteMem (BinDesc* D, MemoryArea* M)
134 /* Write the segments of one memory area to a file */
136 /* Get the start address of this memory area */
137 unsigned long Addr = M->Start;
139 /* Walk over all segments in this memory area */
141 for (I = 0; I < CollCount (&M->SegList); ++I) {
145 /* Get the segment */
146 SegDesc* S = CollAtUnchecked (&M->SegList, I);
148 /* Keep the user happy */
149 Print (stdout, 1, " Writing `%s'\n", GetString (S->Name));
151 /* Writes do only occur in the load area and not for BSS segments */
152 DoWrite = (S->Flags & SF_BSS) == 0 && /* No BSS segment */
153 S->Load == M && /* LOAD segment */
154 S->Seg->Dumped == 0; /* Not already written */
156 /* Output debugging stuff */
157 PrintBoolVal ("bss", S->Flags & SF_BSS);
158 PrintBoolVal ("LoadArea", S->Load == M);
159 PrintBoolVal ("Dumped", S->Seg->Dumped);
160 PrintBoolVal ("DoWrite", DoWrite);
161 PrintNumVal ("Address", Addr);
162 PrintNumVal ("FileOffs", (unsigned long) ftell (D->F));
164 /* Check if we would need an alignment */
165 if (S->Seg->Align > S->Align) {
166 /* Segment itself requires larger alignment than configured
169 Warning ("Segment `%s' in module `%s' requires larger alignment",
170 GetString (S->Name), GetObjFileName (S->Seg->AlignObj));
173 /* If this is the run memory area, we must apply run alignment. If
174 * this is not the run memory area but the load memory area (which
175 * means that both are different), we must apply load alignment.
176 * Beware: DoWrite may be true even if this is the run memory area,
177 * because it may be also the load memory area.
181 /* Handle ALIGN and OFFSET/START */
182 if (S->Flags & SF_ALIGN) {
183 /* Align the address */
184 unsigned long Val = (0x01UL << S->Align) - 1;
185 unsigned long NewAddr = (Addr + Val) & ~Val;
186 if (DoWrite || (M->Flags & MF_FILL) != 0) {
187 WriteMult (D->F, M->FillVal, NewAddr - Addr);
188 PrintNumVal ("SF_ALIGN", NewAddr - Addr);
191 } else if (S->Flags & (SF_OFFSET | SF_START)) {
192 unsigned long NewAddr = S->Addr;
193 if (S->Flags & SF_OFFSET) {
194 /* It's an offset, not a fixed address, make an address */
197 if (DoWrite || (M->Flags & MF_FILL) != 0) {
198 WriteMult (D->F, M->FillVal, NewAddr-Addr);
199 PrintNumVal ("SF_OFFSET", NewAddr - Addr);
204 /* Relocate line information for this segment */
205 RelocLineInfo (S->Seg);
207 } else if (S->Load == M) {
209 /* Handle ALIGN_LOAD */
210 if (S->Flags & SF_ALIGN_LOAD) {
211 /* Align the address */
212 unsigned long Val = (0x01UL << S->AlignLoad) - 1;
213 unsigned long NewAddr = (Addr + Val) & ~Val;
214 if (DoWrite || (M->Flags & MF_FILL) != 0) {
215 WriteMult (D->F, M->FillVal, NewAddr-Addr);
216 PrintNumVal ("SF_ALIGN_LOAD", NewAddr - Addr);
223 /* Now write the segment to disk if it is not a BSS type segment and
224 * if the memory area is the load area.
227 unsigned long P = ftell (D->F);
228 S->Seg->FillVal = M->FillVal;
229 SegWrite (D->Filename, D->F, S->Seg, BinWriteExpr, D);
230 PrintNumVal ("Wrote", (unsigned long) (ftell (D->F) - P));
231 } else if (M->Flags & MF_FILL) {
232 WriteMult (D->F, M->FillVal, S->Seg->Size);
233 PrintNumVal ("Filled", (unsigned long) S->Seg->Size);
236 /* If this was the load memory area, mark the segment as dumped */
241 /* Calculate the new address */
242 Addr += S->Seg->Size;
245 /* If a fill was requested, fill the remaining space */
246 if ((M->Flags & MF_FILL) != 0 && M->FillLevel < M->Size) {
247 unsigned long ToFill = M->Size - M->FillLevel;
248 Print (stdout, 2, " Filling 0x%lx bytes with 0x%02x\n",
250 WriteMult (D->F, M->FillVal, ToFill);
251 M->FillLevel = M->Size;
257 static int BinUnresolved (unsigned Name attribute ((unused)), void* D)
258 /* Called if an unresolved symbol is encountered */
260 /* Unresolved symbols are an error in binary format. Bump the counter
261 * and return zero telling the caller that the symbol is indeed
264 ((BinDesc*) D)->Undef++;
270 void BinWriteTarget (BinDesc* D, struct File* F)
271 /* Write a binary output file */
275 /* Place the filename in the control structure */
276 D->Filename = GetString (F->Name);
278 /* Check for unresolved symbols. The function BinUnresolved is called
279 * if we get an unresolved symbol.
281 D->Undef = 0; /* Reset the counter */
282 CheckUnresolvedImports (BinUnresolved, D);
284 /* We had unresolved symbols, cannot create output file */
285 Error ("%u unresolved external(s) found - cannot create output file", D->Undef);
289 D->F = fopen (D->Filename, "wb");
291 Error ("Cannot open `%s': %s", D->Filename, strerror (errno));
294 /* Keep the user happy */
295 Print (stdout, 1, "Opened `%s'...\n", D->Filename);
297 /* Dump all memory areas */
298 for (I = 0; I < CollCount (&F->MemoryAreas); ++I) {
300 MemoryArea* M = CollAtUnchecked (&F->MemoryAreas, I);
301 Print (stdout, 1, " Dumping `%s'\n", GetString (M->Name));
306 if (fclose (D->F) != 0) {
307 Error ("Cannot write to `%s': %s", D->Filename, strerror (errno));
310 /* Reset the file and filename */