git.sur5r.net Git - cc65/blob - src/ld65/bin.c

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                   bin.c                                   */
   4 /*                                                                           */
   5 /*                  Module to handle the raw binary format                   */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1999-2011, Ullrich von Bassewitz                                      */
  10 /*                Roemerstrasse 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 #include <stdio.h>
  37 #include <string.h>
  38 #include <errno.h>
  39
  40 /* common */
  41 #include "alignment.h"
  42 #include "print.h"
  43 #include "xmalloc.h"
  44
  45 /* ld65 */
  46 #include "bin.h"
  47 #include "config.h"
  48 #include "exports.h"
  49 #include "expr.h"
  50 #include "error.h"
  51 #include "global.h"
  52 #include "fileio.h"
  53 #include "lineinfo.h"
  54 #include "memarea.h"
  55 #include "segments.h"
  56 #include "spool.h"
  57
  58
  59
  60 /*****************************************************************************/
  61 /*                                   Data                                    */
  62 /*****************************************************************************/
  63
  64
  65
  66 struct BinDesc {
  67     unsigned    Undef;          /* Count of undefined externals */
  68     FILE*       F;              /* Output file */
  69     const char* Filename;       /* Name of output file */
  70 };
  71
  72
  73
  74 /*****************************************************************************/
  75 /*                                   Code                                    */
  76 /*****************************************************************************/
  77
  78
  79
  80 BinDesc* NewBinDesc (void)
  81 /* Create a new binary format descriptor */
  82 {
  83     /* Allocate memory for a new BinDesc struct */
  84     BinDesc* D = xmalloc (sizeof (BinDesc));
  85
  86     /* Initialize the fields */
  87     D->Undef    = 0;
  88     D->F        = 0;
  89     D->Filename = 0;
  90
  91     /* Return the created struct */
  92     return D;
  93 }
  94
  95
  96
  97 void FreeBinDesc (BinDesc* D)
  98 /* Free a binary format descriptor */
  99 {
 100     xfree (D);
 101 }
 102
 103
 104
 105 static unsigned BinWriteExpr (ExprNode* E, int Signed, unsigned Size,
 106                               unsigned long Offs attribute ((unused)),
 107                               void* Data)
 108 /* Called from SegWrite for an expression. Evaluate the expression, check the
 109  * range and write the expression value to the file.
 110  */
 111 {
 112     /* There's a predefined function to handle constant expressions */
 113     return SegWriteConstExpr (((BinDesc*)Data)->F, E, Signed, Size);
 114 }
 115
 116
 117
 118 static void PrintBoolVal (const char* Name, int B)
 119 /* Print a boolean value for debugging */
 120 {
 121     Print (stdout, 2, "      %s = %s\n", Name, B? "true" : "false");
 122 }
 123
 124
 125
 126 static void PrintNumVal (const char* Name, unsigned long V)
 127 /* Print a numerical value for debugging */
 128 {
 129     Print (stdout, 2, "      %s = 0x%lx\n", Name, V);
 130 }
 131
 132
 133
 134 static void BinWriteMem (BinDesc* D, MemoryArea* M)
 135 /* Write the segments of one memory area to a file */
 136 {
 137     /* Get the start address of this memory area */
 138     unsigned long Addr = M->Start;
 139
 140     /* Walk over all segments in this memory area */
 141     unsigned I;
 142     for (I = 0; I < CollCount (&M->SegList); ++I) {
 143
 144         int DoWrite;
 145
 146         /* Get the segment */
 147         SegDesc* S = CollAtUnchecked (&M->SegList, I);
 148
 149         /* Keep the user happy */
 150         Print (stdout, 1, "    Writing `%s'\n", GetString (S->Name));
 151
 152         /* Writes do only occur in the load area and not for BSS segments */
 153         DoWrite = (S->Flags & SF_BSS) == 0      &&      /* No BSS segment */
 154                    S->Load == M                 &&      /* LOAD segment */
 155                    S->Seg->Dumped == 0;                 /* Not already written */
 156
 157         /* Output debugging stuff */
 158         PrintBoolVal ("bss", S->Flags & SF_BSS);
 159         PrintBoolVal ("LoadArea", S->Load == M);
 160         PrintBoolVal ("Dumped", S->Seg->Dumped);
 161         PrintBoolVal ("DoWrite", DoWrite);
 162         PrintNumVal  ("Address", Addr);
 163         PrintNumVal  ("FileOffs", (unsigned long) ftell (D->F));
 164
 165         /* Check if the alignment for the segment from the linker config is
 166          * a multiple for that of the segment.
 167          */
 168         if ((S->RunAlignment % S->Seg->Alignment) != 0) {
 169             /* Segment requires another alignment than configured
 170              * in the linker.
 171              */
 172             Warning ("Segment `%s' is not aligned properly. Resulting "
 173                      "executable may not be functional.",
 174                      GetString (S->Name));
 175         }
 176
 177         /* If this is the run memory area, we must apply run alignment. If
 178          * this is not the run memory area but the load memory area (which
 179          * means that both are different), we must apply load alignment.
 180          * Beware: DoWrite may be true even if this is the run memory area,
 181          * because it may be also the load memory area.
 182          */
 183         if (S->Run == M) {
 184
 185             /* Handle ALIGN and OFFSET/START */
 186             if (S->Flags & SF_ALIGN) {
 187                 /* Align the address */
 188                 unsigned long NewAddr = AlignAddr (Addr, S->RunAlignment);
 189                 if (DoWrite || (M->Flags & MF_FILL) != 0) {
 190                     WriteMult (D->F, M->FillVal, NewAddr - Addr);
 191                     PrintNumVal ("SF_ALIGN", NewAddr - Addr);
 192                 }
 193                 Addr = NewAddr;
 194             } else if (S->Flags & (SF_OFFSET | SF_START)) {
 195                 unsigned long NewAddr = S->Addr;
 196                 if (S->Flags & SF_OFFSET) {
 197                     /* It's an offset, not a fixed address, make an address */
 198                     NewAddr += M->Start;
 199                 }
 200                 if (DoWrite || (M->Flags & MF_FILL) != 0) {
 201                     WriteMult (D->F, M->FillVal, NewAddr-Addr);
 202                     PrintNumVal ("SF_OFFSET", NewAddr - Addr);
 203                 }
 204                 Addr = NewAddr;
 205             }
 206
 207         } else if (S->Load == M) {
 208
 209             /* Handle ALIGN_LOAD */
 210             if (S->Flags & SF_ALIGN_LOAD) {
 211                 /* Align the address */
 212                 unsigned long NewAddr = AlignAddr (Addr, S->LoadAlignment);
 213                 if (DoWrite || (M->Flags & MF_FILL) != 0) {
 214                     WriteMult (D->F, M->FillVal, NewAddr - Addr);
 215                     PrintNumVal ("SF_ALIGN_LOAD", NewAddr - Addr);
 216                 }
 217                 Addr = NewAddr;
 218             }
 219
 220         }
 221
 222         /* Now write the segment to disk if it is not a BSS type segment and
 223          * if the memory area is the load area.
 224          */
 225         if (DoWrite) {
 226             unsigned long P = ftell (D->F);
 227             S->Seg->FillVal = M->FillVal;
 228             SegWrite (D->Filename, D->F, S->Seg, BinWriteExpr, D);
 229             PrintNumVal ("Wrote", (unsigned long) (ftell (D->F) - P));
 230         } else if (M->Flags & MF_FILL) {
 231             WriteMult (D->F, M->FillVal, S->Seg->Size);
 232             PrintNumVal ("Filled", (unsigned long) S->Seg->Size);
 233         }
 234
 235         /* If this was the load memory area, mark the segment as dumped */
 236         if (S->Load == M) {
 237             S->Seg->Dumped = 1;
 238         }
 239
 240         /* Calculate the new address */
 241         Addr += S->Seg->Size;
 242     }
 243
 244     /* If a fill was requested, fill the remaining space */
 245     if ((M->Flags & MF_FILL) != 0 && M->FillLevel < M->Size) {
 246         unsigned long ToFill = M->Size - M->FillLevel;
 247         Print (stdout, 2, "    Filling 0x%lx bytes with 0x%02x\n",
 248                ToFill, M->FillVal);
 249         WriteMult (D->F, M->FillVal, ToFill);
 250         M->FillLevel = M->Size;
 251     }
 252 }
 253
 254
 255
 256 static int BinUnresolved (unsigned Name attribute ((unused)), void* D)
 257 /* Called if an unresolved symbol is encountered */
 258 {
 259     /* Unresolved symbols are an error in binary format. Bump the counter
 260      * and return zero telling the caller that the symbol is indeed
 261      * unresolved.
 262      */
 263     ((BinDesc*) D)->Undef++;
 264     return 0;
 265 }
 266
 267
 268
 269 void BinWriteTarget (BinDesc* D, struct File* F)
 270 /* Write a binary output file */
 271 {
 272     unsigned I;
 273
 274     /* Place the filename in the control structure */
 275     D->Filename = GetString (F->Name);
 276
 277     /* Check for unresolved symbols. The function BinUnresolved is called
 278      * if we get an unresolved symbol.
 279      */
 280     D->Undef = 0;               /* Reset the counter */
 281     CheckUnresolvedImports (BinUnresolved, D);
 282     if (D->Undef > 0) {
 283         /* We had unresolved symbols, cannot create output file */
 284         Error ("%u unresolved external(s) found - cannot create output file", D->Undef);
 285     }
 286
 287     /* Open the file */
 288     D->F = fopen (D->Filename, "wb");
 289     if (D->F == 0) {
 290         Error ("Cannot open `%s': %s", D->Filename, strerror (errno));
 291     }
 292
 293     /* Keep the user happy */
 294     Print (stdout, 1, "Opened `%s'...\n", D->Filename);
 295
 296     /* Dump all memory areas */
 297     for (I = 0; I < CollCount (&F->MemoryAreas); ++I) {
 298         /* Get this entry */
 299         MemoryArea* M = CollAtUnchecked (&F->MemoryAreas, I);
 300         Print (stdout, 1, "  Dumping `%s'\n", GetString (M->Name));
 301         BinWriteMem (D, M);
 302     }
 303
 304     /* Close the file */
 305     if (fclose (D->F) != 0) {
 306         Error ("Cannot write to `%s': %s", D->Filename, strerror (errno));
 307     }
 308
 309     /* Reset the file and filename */
 310     D->F        = 0;
 311     D->Filename = 0;
 312 }
 313
 314
 315
 316
 317