1 /*****************************************************************************/
5 /* Main program for the ld65 linker */
9 /* (C) 1998-2009, 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 /*****************************************************************************/
74 /*****************************************************************************/
76 /*****************************************************************************/
80 static unsigned ObjFiles = 0; /* Count of object files linked */
81 static unsigned LibFiles = 0; /* Count of library files linked */
85 /*****************************************************************************/
87 /*****************************************************************************/
91 static void Usage (void)
92 /* Print usage information and exit */
94 printf ("Usage: %s [options] module ...\n"
96 " -(\t\t\tStart a library group\n"
97 " -)\t\t\tEnd a library group\n"
98 " -C name\t\tUse linker config file\n"
99 " -D sym=val\t\tDefine a symbol\n"
100 " -L path\t\tSpecify a library search path\n"
101 " -Ln name\t\tCreate a VICE label file\n"
102 " -S addr\t\tSet the default start address\n"
103 " -V\t\t\tPrint the linker version\n"
104 " -h\t\t\tHelp (this text)\n"
105 " -m name\t\tCreate a map file\n"
106 " -o name\t\tName the default output file\n"
107 " -t sys\t\tSet the target system\n"
108 " -v\t\t\tVerbose mode\n"
109 " -vm\t\t\tVerbose map file\n"
112 " --cfg-path path\tSpecify a config file search path\n"
113 " --config name\t\tUse linker config file\n"
114 " --dbgfile name\tGenerate debug information\n"
115 " --define sym=val\tDefine a symbol\n"
116 " --dump-config name\tDump a builtin configuration\n"
117 " --end-group\t\tEnd a library group\n"
118 " --force-import sym\tForce an import of symbol `sym'\n"
119 " --help\t\tHelp (this text)\n"
120 " --lib file\t\tLink this library\n"
121 " --lib-path path\tSpecify a library search path\n"
122 " --mapfile name\tCreate a map file\n"
123 " --module-id id\tSpecify a module id\n"
124 " --obj file\t\tLink this object file\n"
125 " --obj-path path\tSpecify an object file search path\n"
126 " --start-addr addr\tSet the default start address\n"
127 " --start-group\t\tStart a library group\n"
128 " --target sys\t\tSet the target system\n"
129 " --version\t\tPrint the linker version\n",
135 static unsigned long CvtNumber (const char* Arg, const char* Number)
136 /* Convert a number from a string. Allow '$' and '0x' prefixes for hex
144 if (*Number == '$') {
146 Converted = sscanf (Number, "%lx", &Val);
148 Converted = sscanf (Number, "%li", (long*)&Val);
151 /* Check if we do really have a number */
152 if (Converted != 1) {
153 Error ("Invalid number given in argument: %s\n", Arg);
156 /* Return the result */
162 static void LinkFile (const char* Name, FILETYPE Type)
163 /* Handle one file */
170 /* If we don't know the file type, determine it from the extension */
171 if (Type == FILETYPE_UNKNOWN) {
172 Type = GetFileType (Name);
175 /* For known file types, search the file in the directory list */
179 PathName = SearchFile (Name, SEARCH_LIB);
183 PathName = SearchFile (Name, SEARCH_OBJ);
187 PathName = xstrdup (Name); /* Use the name as is */
191 /* We must have a valid name now */
193 Error ("Input file `%s' not found", Name);
196 /* Try to open the file */
197 F = fopen (PathName, "rb");
199 Error ("Cannot open `%s': %s", PathName, strerror (errno));
202 /* Read the magic word */
205 /* Check the magic for known file types. The handling is somewhat weird
206 * since we may have given a file with a ".lib" extension, which was
207 * searched and found in a directory for library files, but we now find
208 * out (by looking at the magic) that it's indeed an object file. We just
209 * ignore the problem and hope no one will notice...
214 ObjAdd (F, PathName);
219 LibAdd (F, PathName);
225 Error ("File `%s' has unknown type", PathName);
229 /* Free allocated memory. */
235 static void DefineSymbol (const char* Def)
236 /* Define a symbol from the command line */
241 StrBuf SymName = AUTO_STRBUF_INITIALIZER;
244 /* The symbol must start with a character or underline */
245 if (Def [0] != '_' && !IsAlpha (Def [0])) {
250 /* Copy the symbol, checking the remainder */
252 while (IsAlNum (*P) || *P == '_') {
253 SB_AppendChar (&SymName, *P++);
255 SB_Terminate (&SymName);
257 /* Do we have a value given? */
261 /* We have a value */
265 if (sscanf (P, "%lx", &Val) != 1) {
269 if (sscanf (P, "%li", &Val) != 1) {
275 /* Define the new symbol */
276 CreateConstExport (GetStringId (SB_GetConstBuf (&SymName)), Val);
281 static void OptCfgPath (const char* Opt attribute ((unused)), const char* Arg)
282 /* Specify a config file search path */
284 AddSearchPath (Arg, SEARCH_CFG);
289 static void OptConfig (const char* Opt attribute ((unused)), const char* Arg)
290 /* Define the config file */
295 Error ("Cannot use -C/-t twice");
297 /* Search for the file */
298 PathName = SearchFile (Arg, SEARCH_CFG);
300 Error ("Cannot find config file `%s'", Arg);
302 CfgSetName (PathName);
308 static void OptDbgFile (const char* Opt attribute ((unused)), const char* Arg)
309 /* Give the name of the debug file */
316 static void OptDefine (const char* Opt attribute ((unused)), const char* Arg)
317 /* Define a symbol on the command line */
324 static void OptDumpConfig (const char* Opt attribute ((unused)), const char* Arg)
325 /* Dump a builtin linker configuration */
327 /* Map the given target name to its id */
328 target_t T = FindTarget (Arg);
329 if (T == TGT_UNKNOWN) {
330 Error ("Target system `%s' is unknown", Arg);
333 /* Dump the builtin configuration */
334 DumpBuiltinConfig (stdout, T);
339 static void OptEndGroup (const char* Opt attribute ((unused)),
340 const char* Arg attribute ((unused)))
341 /* End a library group */
348 static void OptForceImport (const char* Opt attribute ((unused)), const char* Arg)
349 /* Force an import of a symbol */
351 /* An optional address size may be specified */
352 const char* ColPos = strchr (Arg, ':');
355 /* Use default address size (which for now is always absolute
358 InsertImport (GenImport (Arg, ADDR_SIZE_ABS));
364 /* Get the address size and check it */
365 unsigned char AddrSize = AddrSizeFromStr (ColPos+1);
366 if (AddrSize == ADDR_SIZE_INVALID) {
367 Error ("Invalid address size `%s'", ColPos+1);
370 /* Create a copy of the argument */
373 /* We need just the symbol */
374 A[ColPos - Arg] = '\0';
376 /* Generate the import */
377 InsertImport (GenImport (A, AddrSize));
379 /* Delete the copy of the argument */
386 static void OptHelp (const char* Opt attribute ((unused)),
387 const char* Arg attribute ((unused)))
388 /* Print usage information and exit */
396 static void OptLib (const char* Opt attribute ((unused)), const char* Arg)
399 LinkFile (Arg, FILETYPE_LIB);
404 static void OptLibPath (const char* Opt attribute ((unused)), const char* Arg)
405 /* Specify a library file search path */
407 AddSearchPath (Arg, SEARCH_LIB);
412 static void OptMapFile (const char* Opt attribute ((unused)), const char* Arg)
413 /* Give the name of the map file */
420 static void OptModuleId (const char* Opt, const char* Arg)
421 /* Specify a module id */
423 unsigned long Id = CvtNumber (Opt, Arg);
425 Error ("Range error in module id");
427 ModuleId = (unsigned) Id;
432 static void OptObj (const char* Opt attribute ((unused)), const char* Arg)
433 /* Link an object file */
435 LinkFile (Arg, FILETYPE_OBJ);
440 static void OptObjPath (const char* Opt attribute ((unused)), const char* Arg)
441 /* Specify an object file search path */
443 AddSearchPath (Arg, SEARCH_OBJ);
448 static void OptStartAddr (const char* Opt, const char* Arg)
449 /* Set the default start address */
451 StartAddr = CvtNumber (Opt, Arg);
457 static void OptStartGroup (const char* Opt attribute ((unused)),
458 const char* Arg attribute ((unused)))
459 /* Start a library group */
466 static void OptTarget (const char* Opt attribute ((unused)), const char* Arg)
467 /* Set the target system */
471 /* Map the target name to a target id */
472 Target = FindTarget (Arg);
473 if (Target == TGT_UNKNOWN) {
474 Error ("Invalid target name: `%s'", Arg);
477 /* Get the target description record */
478 D = &Targets[Target];
480 /* Set the target data */
481 DefaultBinFmt = D->BinFmt;
487 static void OptVersion (const char* Opt attribute ((unused)),
488 const char* Arg attribute ((unused)))
489 /* Print the assembler version */
492 "ld65 V%u.%u.%u - (C) Copyright 1998-2005 Ullrich von Bassewitz\n",
493 VER_MAJOR, VER_MINOR, VER_PATCH);
498 int main (int argc, char* argv [])
499 /* Assembler main program */
501 /* Program long options */
502 static const LongOpt OptTab[] = {
503 { "--cfg-path", 1, OptCfgPath },
504 { "--config", 1, OptConfig },
505 { "--dbgfile", 1, OptDbgFile },
506 { "--define", 1, OptDefine },
507 { "--dump-config", 1, OptDumpConfig },
508 { "--end-group", 0, OptEndGroup },
509 { "--force-import", 1, OptForceImport },
510 { "--help", 0, OptHelp },
511 { "--lib", 1, OptLib },
512 { "--lib-path", 1, OptLibPath },
513 { "--mapfile", 1, OptMapFile },
514 { "--module-id", 1, OptModuleId },
515 { "--obj", 1, OptObj },
516 { "--obj-path", 1, OptObjPath },
517 { "--start-addr", 1, OptStartAddr },
518 { "--start-group", 0, OptStartGroup },
519 { "--target", 1, OptTarget },
520 { "--version", 0, OptVersion },
524 unsigned MemoryAreaOverflows;
526 /* Initialize the cmdline module */
527 InitCmdLine (&argc, &argv, "ld65");
529 /* Initialize the input file search paths */
532 /* Initialize the string pool */
535 /* Check the parameters */
537 while (I < ArgCount) {
539 /* Get the argument */
540 const char* Arg = ArgVec[I];
542 /* Check for an option */
543 if (Arg [0] == '-') {
549 LongOption (&I, OptTab, sizeof(OptTab)/sizeof(OptTab[0]));
553 OptStartGroup (Arg, 0);
557 OptEndGroup (Arg, 0);
566 OptMapFile (Arg, GetArg (&I, 2));
570 OutputName = GetArg (&I, 2);
575 Error ("Cannot use -C/-t twice");
577 OptTarget (Arg, GetArg (&I, 2));
582 case 'm': VerboseMap = 1; break;
583 case '\0': ++Verbosity; break;
584 default: UnknownOption (Arg);
589 OptConfig (Arg, GetArg (&I, 2));
593 OptDefine (Arg, GetArg (&I, 2));
598 /* ## The first one is obsolete and will go */
599 case 'n': LabelFileName = GetArg (&I, 3); break;
600 default: OptLibPath (Arg, GetArg (&I, 2)); break;
605 OptStartAddr (Arg, GetArg (&I, 2));
620 LinkFile (Arg, FILETYPE_UNKNOWN);
628 /* Check if we had any object files */
630 Error ("No object files to link");
633 /* Check if we have a valid configuration */
635 Error ("Memory configuration missing");
638 /* Check if we have open library groups */
641 /* Read the config file */
644 /* Create the condes tables if requested */
647 /* Assign start addresses for the segments, define linker symbols. The
648 * function will return the number of memory area overflows (zero on
651 MemoryAreaOverflows = CfgAssignSegments ();
653 /* Check module assertions */
656 /* Check for import/export mismatches */
659 /* If we had a memory area overflow before, we cannot generate the output
660 * file. However, we will generate a short map file if requested, since
661 * this will help the user to rearrange segments and fix the overflow.
663 if (MemoryAreaOverflows) {
665 CreateMapFile (SHORT_MAPFILE);
667 Error ("Cannot generate output due to memory area overflow%s",
668 (MemoryAreaOverflows > 1)? "s" : "");
671 /* Create the output file */
674 /* Check for segments not written to the output file */
677 /* If requested, create a map file and a label file for VICE */
679 CreateMapFile (LONG_MAPFILE);
688 /* Dump the data for debugging */
694 /* Return an apropriate exit code */