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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                  main.c                                   */
   4 /*                                                                           */
   5 /*                     Main program for the ld65 linker                      */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2003 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 #include <stdio.h>
  37 #include <stdlib.h>
  38 #include <string.h>
  39 #include <errno.h>
  40
  41 /* common */
  42 #include "cmdline.h"
  43 #include "filetype.h"
  44 #include "libdefs.h"
  45 #include "objdefs.h"
  46 #include "print.h"
  47 #include "target.h"
  48 #include "version.h"
  49 #include "xmalloc.h"
  50
  51 /* ld65 */
  52 #include "asserts.h"
  53 #include "binfmt.h"
  54 #include "condes.h"
  55 #include "config.h"
  56 #include "error.h"
  57 #include "exports.h"
  58 #include "fileio.h"
  59 #include "filepath.h"
  60 #include "global.h"
  61 #include "library.h"
  62 #include "mapfile.h"
  63 #include "objfile.h"
  64 #include "scanner.h"
  65 #include "segments.h"
  66 #include "spool.h"
  67 #include "tgtcfg.h"
  68
  69
  70
  71 /*****************************************************************************/
  72 /*                                   Data                                    */
  73 /*****************************************************************************/
  74
  75
  76
  77 static unsigned         ObjFiles   = 0; /* Count of object files linked */
  78 static unsigned         LibFiles   = 0; /* Count of library files linked */
  79
  80
  81
  82 /*****************************************************************************/
  83 /*                                   Code                                    */
  84 /*****************************************************************************/
  85
  86
  87
  88 static void Usage (void)
  89 /* Print usage information and exit */
  90 {
  91     fprintf (stderr,
  92              "Usage: %s [options] module ...\n"
  93              "Short options:\n"
  94              "  -C name\t\tUse linker config file\n"
  95              "  -L path\t\tSpecify a library search path\n"
  96              "  -Ln name\t\tCreate a VICE label file\n"
  97              "  -Lp\t\t\tMark write protected segments as such (VICE)\n"
  98              "  -S addr\t\tSet the default start address\n"
  99              "  -V\t\t\tPrint the linker version\n"
 100              "  -h\t\t\tHelp (this text)\n"
 101              "  -m name\t\tCreate a map file\n"
 102              "  -o name\t\tName the default output file\n"
 103              "  -t sys\t\tSet the target system\n"
 104              "  -v\t\t\tVerbose mode\n"
 105              "  -vm\t\t\tVerbose map file\n"
 106              "\n"
 107              "Long options:\n"
 108              "  --cfg-path path\tSpecify a config file search path\n"
 109              "  --config name\t\tUse linker config file\n"
 110              "  --dump-config name\tDump a builtin configuration\n"
 111              "  --help\t\tHelp (this text)\n"
 112              "  --lib file\t\tLink this library\n"
 113              "  --lib-path path\tSpecify a library search path\n"
 114              "  --mapfile name\tCreate a map file\n"
 115              "  --module-id id\tSpecify a module id\n"
 116              "  --obj file\t\tLink this object file\n"
 117              "  --obj-path path\tSpecify an object file search path\n"
 118              "  --start-addr addr\tSet the default start address\n"
 119              "  --target sys\t\tSet the target system\n"
 120              "  --version\t\tPrint the linker version\n",
 121              ProgName);
 122 }
 123
 124
 125
 126 static unsigned long CvtNumber (const char* Arg, const char* Number)
 127 /* Convert a number from a string. Allow '$' and '0x' prefixes for hex
 128  * numbers.
 129  */
 130 {
 131     unsigned long Val;
 132     int           Converted;
 133
 134     /* Convert */
 135     if (*Number == '$') {
 136         ++Number;
 137         Converted = sscanf (Number, "%lx", &Val);
 138     } else {
 139         Converted = sscanf (Number, "%li", (long*)&Val);
 140     }
 141
 142     /* Check if we do really have a number */
 143     if (Converted != 1) {
 144         Error ("Invalid number given in argument: %s\n", Arg);
 145     }
 146
 147     /* Return the result */
 148     return Val;
 149 }
 150
 151
 152
 153 static void LinkFile (const char* Name, FILETYPE Type)
 154 /* Handle one file */
 155 {
 156     char*         PathName;
 157     FILE*         F;
 158     unsigned long Magic;
 159
 160
 161     /* If we don't know the file type, determine it from the extension */
 162     if (Type == FILETYPE_UNKNOWN) {
 163         Type = GetFileType (Name);
 164     }
 165
 166     /* For known file types, search the file in the directory list */
 167     switch (Type) {
 168
 169         case FILETYPE_LIB:
 170             PathName = SearchFile (Name, SEARCH_LIB);
 171             break;
 172
 173         case FILETYPE_OBJ:
 174             PathName = SearchFile (Name, SEARCH_OBJ);
 175             break;
 176
 177         default:
 178             PathName = xstrdup (Name);   /* Use the name as is */
 179             break;
 180     }
 181
 182     /* We must have a valid name now */
 183     if (PathName == 0) {
 184         Error ("Input file `%s' not found", Name);
 185     }
 186
 187     /* Try to open the file */
 188     F = fopen (PathName, "rb");
 189     if (F == 0) {
 190         Error ("Cannot open `%s': %s", PathName, strerror (errno));
 191     }
 192
 193     /* Read the magic word */
 194     Magic = Read32 (F);
 195
 196     /* Check the magic for known file types. The handling is somewhat weird
 197      * since we may have given a file with a ".lib" extension, which was
 198      * searched and found in a directory for library files, but we now find
 199      * out (by looking at the magic) that it's indeed an object file. We just
 200      * ignore the problem and hope no one will notice...
 201      */
 202     switch (Magic) {
 203
 204         case OBJ_MAGIC:
 205             ObjAdd (F, PathName);
 206             ++ObjFiles;
 207             break;
 208
 209         case LIB_MAGIC:
 210             LibAdd (F, PathName);
 211             ++LibFiles;
 212             break;
 213
 214         default:
 215             fclose (F);
 216             Error ("File `%s' has unknown type", PathName);
 217
 218     }
 219
 220     /* Free allocated memory. */
 221     xfree (PathName);
 222 }
 223
 224
 225
 226 static void OptCfgPath (const char* Opt attribute ((unused)), const char* Arg)
 227 /* Specify a config file search path */
 228 {
 229     AddSearchPath (Arg, SEARCH_CFG);
 230 }
 231
 232
 233
 234 static void OptConfig (const char* Opt attribute ((unused)), const char* Arg)
 235 /* Define the config file */
 236 {
 237     char* PathName;
 238
 239     if (CfgAvail ()) {
 240         Error ("Cannot use -C/-t twice");
 241     }
 242     /* Search for the file */
 243     PathName = SearchFile (Arg, SEARCH_CFG);
 244     if (PathName == 0) {
 245         Error ("Cannot find config file `%s'", Arg);
 246     } else {
 247         CfgSetName (PathName);
 248         xfree (PathName);
 249     }
 250 }
 251
 252
 253
 254 static void OptDbgFile (const char* Opt attribute ((unused)), const char* Arg)
 255 /* Give the name of the debug file */
 256 {
 257     DbgFileName = Arg;
 258 }
 259
 260
 261
 262 static void OptDumpConfig (const char* Opt attribute ((unused)), const char* Arg)
 263 /* Dump a builtin linker configuration */
 264 {
 265     /* Map the given target name to its id */
 266     target_t T = FindTarget (Arg);
 267     if (T == TGT_UNKNOWN) {
 268         Error ("Target system `%s' is unknown", Arg);
 269     }
 270
 271     /* Dump the builtin configuration */
 272     DumpBuiltinConfig (stdout, T);
 273 }
 274
 275
 276
 277 static void OptHelp (const char* Opt attribute ((unused)),
 278                      const char* Arg attribute ((unused)))
 279 /* Print usage information and exit */
 280 {
 281     Usage ();
 282     exit (EXIT_SUCCESS);
 283 }
 284
 285
 286
 287 static void OptLib (const char* Opt attribute ((unused)), const char* Arg)
 288 /* Link a library */
 289 {
 290     LinkFile (Arg, FILETYPE_LIB);
 291 }
 292
 293
 294
 295 static void OptLibPath (const char* Opt attribute ((unused)), const char* Arg)
 296 /* Specify a library file search path */
 297 {
 298     AddSearchPath (Arg, SEARCH_LIB);
 299 }
 300
 301
 302
 303 static void OptMapFile (const char* Opt attribute ((unused)), const char* Arg)
 304 /* Give the name of the map file */
 305 {
 306     MapFileName = Arg;
 307 }
 308
 309
 310
 311 static void OptModuleId (const char* Opt, const char* Arg)
 312 /* Specify a module id */
 313 {
 314     unsigned long Id = CvtNumber (Opt, Arg);
 315     if (Id > 0xFFFFUL) {
 316         Error ("Range error in module id");
 317     }
 318     ModuleId = (unsigned) Id;
 319 }
 320
 321
 322
 323 static void OptObj (const char* Opt attribute ((unused)), const char* Arg)
 324 /* Link an object file */
 325 {
 326     LinkFile (Arg, FILETYPE_OBJ);
 327 }
 328
 329
 330
 331 static void OptObjPath (const char* Opt attribute ((unused)), const char* Arg)
 332 /* Specify an object file search path */
 333 {
 334     AddSearchPath (Arg, SEARCH_OBJ);
 335 }
 336
 337
 338
 339 static void OptStartAddr (const char* Opt, const char* Arg)
 340 /* Set the default start address */
 341 {
 342     StartAddr = CvtNumber (Opt, Arg);
 343     HaveStartAddr = 1;
 344 }
 345
 346
 347
 348 static void OptTarget (const char* Opt attribute ((unused)), const char* Arg)
 349 /* Set the target system */
 350 {
 351     const TargetDesc* D;
 352
 353     /* Map the target name to a target id */
 354     Target = FindTarget (Arg);
 355     if (Target == TGT_UNKNOWN) {
 356         Error ("Invalid target name: `%s'", Arg);
 357     }
 358
 359     /* Get the target description record */
 360     D = &Targets[Target];
 361
 362     /* Set the target data */
 363     DefaultBinFmt = D->BinFmt;
 364     CfgSetBuf (D->Cfg);
 365 }
 366
 367
 368
 369 static void OptVersion (const char* Opt attribute ((unused)),
 370                         const char* Arg attribute ((unused)))
 371 /* Print the assembler version */
 372 {
 373     fprintf (stderr,
 374              "ld65 V%u.%u.%u - (C) Copyright 1998-2002 Ullrich von Bassewitz\n",
 375              VER_MAJOR, VER_MINOR, VER_PATCH);
 376 }
 377
 378
 379
 380 int main (int argc, char* argv [])
 381 /* Assembler main program */
 382 {
 383     /* Program long options */
 384     static const LongOpt OptTab[] = {
 385         { "--cfg-path",         1,      OptCfgPath              },
 386         { "--config",           1,      OptConfig               },
 387         { "--dbgfile",          1,      OptDbgFile              },
 388         { "--dump-config",      1,      OptDumpConfig           },
 389         { "--help",             0,      OptHelp                 },
 390         { "--lib",              1,      OptLib                  },
 391         { "--lib-path",         1,      OptLibPath              },
 392         { "--mapfile",          1,      OptMapFile              },
 393         { "--module-id",        1,      OptModuleId             },
 394         { "--obj",              1,      OptObj                  },
 395         { "--obj-path",         1,      OptObjPath              },
 396         { "--start-addr",       1,      OptStartAddr            },
 397         { "--target",           1,      OptTarget               },
 398         { "--version",          0,      OptVersion              },
 399     };
 400
 401     unsigned I;
 402
 403     /* Initialize the cmdline module */
 404     InitCmdLine (&argc, &argv, "ld65");
 405
 406     /* Initialize the input file search paths */
 407     InitSearchPaths ();
 408
 409     /* Initialize the string pool */
 410     InitStrPool ();
 411
 412     /* Check the parameters */
 413     I = 1;
 414     while (I < ArgCount) {
 415
 416         /* Get the argument */
 417         const char* Arg = ArgVec[I];
 418
 419         /* Check for an option */
 420         if (Arg [0] == '-') {
 421
 422             /* An option */
 423             switch (Arg [1]) {
 424
 425                 case '-':
 426                     LongOption (&I, OptTab, sizeof(OptTab)/sizeof(OptTab[0]));
 427                     break;
 428
 429                 case 'h':
 430                 case '?':
 431                     OptHelp (Arg, 0);
 432                     break;
 433
 434                 case 'm':
 435                     OptMapFile (Arg, GetArg (&I, 2));
 436                     break;
 437
 438                 case 'o':
 439                     OutputName = GetArg (&I, 2);
 440                     break;
 441
 442                 case 't':
 443                     if (CfgAvail ()) {
 444                         Error ("Cannot use -C/-t twice");
 445                     }
 446                     OptTarget (Arg, GetArg (&I, 2));
 447                     break;
 448
 449                 case 'v':
 450                     switch (Arg [2]) {
 451                         case 'm':   VerboseMap = 1;     break;
 452                         case '\0':  ++Verbosity;        break;
 453                         default:    UnknownOption (Arg);
 454                     }
 455                     break;
 456
 457                 case 'C':
 458                     OptConfig (Arg, GetArg (&I, 2));
 459                     break;
 460
 461                 case 'L':
 462                     switch (Arg [2]) {
 463                         /* ## The first two are obsolete and will go */
 464                         case 'n': LabelFileName = GetArg (&I, 3);   break;
 465                         case 'p': WProtSegs = 1;                    break;
 466                         default:  OptLibPath (Arg, GetArg (&I, 2)); break;
 467                     }
 468                     break;
 469
 470                 case 'S':
 471                     OptStartAddr (Arg, GetArg (&I, 2));
 472                     break;
 473
 474                 case 'V':
 475                     OptVersion (Arg, 0);
 476                     break;
 477
 478                 default:
 479                     UnknownOption (Arg);
 480                     break;
 481             }
 482
 483         } else {
 484
 485             /* A filename */
 486             LinkFile (Arg, FILETYPE_UNKNOWN);
 487
 488         }
 489
 490         /* Next argument */
 491         ++I;
 492     }
 493
 494     /* Check if we had any object files */
 495     if (ObjFiles == 0) {
 496         Error ("No object files to link");
 497     }
 498
 499     /* Check if we have a valid configuration */
 500     if (!CfgAvail ()) {
 501         Error ("Memory configuration missing");
 502     }
 503
 504     /* Read the config file */
 505     CfgRead ();
 506
 507     /* Create the condes tables if requested */
 508     ConDesCreate ();
 509
 510     /* Assign start addresses for the segments, define linker symbols */
 511     CfgAssignSegments ();
 512
 513     /* Check module assertions */
 514     CheckAssertions ();
 515
 516     /* Create the output file */
 517     CfgWriteTarget ();
 518
 519     /* Check for segments not written to the output file */
 520     CheckSegments ();
 521
 522     /* If requested, create a map file and a label file for VICE */
 523     if (MapFileName) {
 524         CreateMapFile ();
 525     }
 526     if (LabelFileName) {
 527         CreateLabelFile ();
 528     }
 529     if (DbgFileName) {
 530         CreateDbgFile ();
 531     }
 532
 533     /* Dump the data for debugging */
 534     if (Verbosity > 1) {
 535         SegDump ();
 536         ConDesDump ();
 537     }
 538
 539     /* Return an apropriate exit code */
 540     return EXIT_SUCCESS;
 541 }
 542
 543
 544
 545