1 /*****************************************************************************/
5 /* Main program for the ld65 linker */
9 /* (C) 1998-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 /*****************************************************************************/
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 " -u sym\t\tForce an import of symbol `sym'\n"
109 " -v\t\t\tVerbose mode\n"
110 " -vm\t\t\tVerbose map file\n"
113 " --cfg-path path\tSpecify a config file search path\n"
114 " --config name\t\tUse linker config file\n"
115 " --dbgfile name\tGenerate debug information\n"
116 " --define sym=val\tDefine a symbol\n"
117 " --dump-config name\tDump a builtin configuration\n"
118 " --end-group\t\tEnd a library group\n"
119 " --force-import sym\tForce an import of symbol `sym'\n"
120 " --help\t\tHelp (this text)\n"
121 " --lib file\t\tLink this library\n"
122 " --lib-path path\tSpecify a library search path\n"
123 " --mapfile name\tCreate a map file\n"
124 " --module-id id\tSpecify a module id\n"
125 " --obj file\t\tLink this object file\n"
126 " --obj-path path\tSpecify an object file search path\n"
127 " --start-addr addr\tSet the default start address\n"
128 " --start-group\t\tStart a library group\n"
129 " --target sys\t\tSet the target system\n"
130 " --version\t\tPrint the linker version\n",
136 static unsigned long CvtNumber (const char* Arg, const char* Number)
137 /* Convert a number from a string. Allow '$' and '0x' prefixes for hex
145 if (*Number == '$') {
147 Converted = sscanf (Number, "%lx", &Val);
149 Converted = sscanf (Number, "%li", (long*)&Val);
152 /* Check if we do really have a number */
153 if (Converted != 1) {
154 Error ("Invalid number given in argument: %s\n", Arg);
157 /* Return the result */
163 static void LinkFile (const char* Name, FILETYPE Type)
164 /* Handle one file */
171 /* If we don't know the file type, determine it from the extension */
172 if (Type == FILETYPE_UNKNOWN) {
173 Type = GetFileType (Name);
176 /* For known file types, search the file in the directory list */
180 PathName = SearchFile (LibSearchPath, Name);
184 PathName = SearchFile (ObjSearchPath, Name);
188 PathName = xstrdup (Name); /* Use the name as is */
192 /* We must have a valid name now */
194 Error ("Input file `%s' not found", Name);
197 /* Try to open the file */
198 F = fopen (PathName, "rb");
200 Error ("Cannot open `%s': %s", PathName, strerror (errno));
203 /* Read the magic word */
206 /* Check the magic for known file types. The handling is somewhat weird
207 * since we may have given a file with a ".lib" extension, which was
208 * searched and found in a directory for library files, but we now find
209 * out (by looking at the magic) that it's indeed an object file. We just
210 * ignore the problem and hope no one will notice...
215 ObjAdd (F, PathName);
220 LibAdd (F, PathName);
226 Error ("File `%s' has unknown type", PathName);
230 /* Free allocated memory. */
236 static void DefineSymbol (const char* Def)
237 /* Define a symbol from the command line */
242 StrBuf SymName = AUTO_STRBUF_INITIALIZER;
245 /* The symbol must start with a character or underline */
246 if (Def [0] != '_' && !IsAlpha (Def [0])) {
251 /* Copy the symbol, checking the remainder */
253 while (IsAlNum (*P) || *P == '_') {
254 SB_AppendChar (&SymName, *P++);
256 SB_Terminate (&SymName);
258 /* Do we have a value given? */
262 /* We have a value */
266 if (sscanf (P, "%lx", &Val) != 1) {
270 if (sscanf (P, "%li", &Val) != 1) {
276 /* Define the new symbol */
277 CreateConstExport (GetStringId (SB_GetConstBuf (&SymName)), Val);
282 static void OptCfgPath (const char* Opt attribute ((unused)), const char* Arg)
283 /* Specify a config file search path */
285 AddSearchPath (CfgSearchPath, Arg);
290 static void OptConfig (const char* Opt attribute ((unused)), const char* Arg)
291 /* Define the config file */
296 Error ("Cannot use -C/-t twice");
298 /* Search for the file */
299 PathName = SearchFile (CfgSearchPath, Arg);
301 Error ("Cannot find config file `%s'", Arg);
303 CfgSetName (PathName);
306 /* Read the config */
312 static void OptDbgFile (const char* Opt attribute ((unused)), const char* Arg)
313 /* Give the name of the debug file */
320 static void OptDefine (const char* Opt attribute ((unused)), const char* Arg)
321 /* Define a symbol on the command line */
328 static void OptDumpConfig (const char* Opt attribute ((unused)), const char* Arg)
329 /* Dump a builtin linker configuration */
331 /* Map the given target name to its id */
332 target_t T = FindTarget (Arg);
333 if (T == TGT_UNKNOWN) {
334 Error ("Target system `%s' is unknown", Arg);
337 /* Dump the builtin configuration */
338 DumpBuiltinConfig (stdout, T);
343 static void OptEndGroup (const char* Opt attribute ((unused)),
344 const char* Arg attribute ((unused)))
345 /* End a library group */
352 static void OptForceImport (const char* Opt attribute ((unused)), const char* Arg)
353 /* Force an import of a symbol */
355 /* An optional address size may be specified */
356 const char* ColPos = strchr (Arg, ':');
359 /* Use default address size (which for now is always absolute
362 InsertImport (GenImport (GetStringId (Arg), ADDR_SIZE_ABS));
368 /* Get the address size and check it */
369 unsigned char AddrSize = AddrSizeFromStr (ColPos+1);
370 if (AddrSize == ADDR_SIZE_INVALID) {
371 Error ("Invalid address size `%s'", ColPos+1);
374 /* Create a copy of the argument */
377 /* We need just the symbol */
378 A[ColPos - Arg] = '\0';
380 /* Generate the import */
381 InsertImport (GenImport (GetStringId (A), AddrSize));
383 /* Delete the copy of the argument */
390 static void OptHelp (const char* Opt attribute ((unused)),
391 const char* Arg attribute ((unused)))
392 /* Print usage information and exit */
400 static void OptLib (const char* Opt attribute ((unused)), const char* Arg)
403 LinkFile (Arg, FILETYPE_LIB);
408 static void OptLibPath (const char* Opt attribute ((unused)), const char* Arg)
409 /* Specify a library file search path */
411 AddSearchPath (LibSearchPath, Arg);
416 static void OptMapFile (const char* Opt attribute ((unused)), const char* Arg)
417 /* Give the name of the map file */
424 static void OptModuleId (const char* Opt, const char* Arg)
425 /* Specify a module id */
427 unsigned long Id = CvtNumber (Opt, Arg);
429 Error ("Range error in module id");
431 ModuleId = (unsigned) Id;
436 static void OptObj (const char* Opt attribute ((unused)), const char* Arg)
437 /* Link an object file */
439 LinkFile (Arg, FILETYPE_OBJ);
444 static void OptObjPath (const char* Opt attribute ((unused)), const char* Arg)
445 /* Specify an object file search path */
447 AddSearchPath (ObjSearchPath, Arg);
452 static void OptOutputName (const char* Opt, const char* Arg)
453 /* Give the name of the output file */
455 /* If the name of the output file has been used in the config before
456 * (by using %O) we're actually changing it later, which - in most cases -
457 * gives unexpected results, so emit a warning in this case.
459 if (OutputNameUsed) {
460 Warning ("Option `%s' should preceede options `-t' or `-C'", Opt);
467 static void OptStartAddr (const char* Opt, const char* Arg)
468 /* Set the default start address */
470 StartAddr = CvtNumber (Opt, Arg);
476 static void OptStartGroup (const char* Opt attribute ((unused)),
477 const char* Arg attribute ((unused)))
478 /* Start a library group */
485 static void OptTarget (const char* Opt attribute ((unused)), const char* Arg)
486 /* Set the target system */
490 /* Map the target name to a target id */
491 Target = FindTarget (Arg);
492 if (Target == TGT_UNKNOWN) {
493 Error ("Invalid target name: `%s'", Arg);
496 /* Get the target description record */
497 D = &Targets[Target];
499 /* Set the target data */
500 DefaultBinFmt = D->BinFmt;
503 /* Read the target config */
509 static void OptVersion (const char* Opt attribute ((unused)),
510 const char* Arg attribute ((unused)))
511 /* Print the assembler version */
514 "ld65 V%s - (C) Copyright 1998-2009, Ullrich von Bassewitz\n",
515 GetVersionAsString ());
520 int main (int argc, char* argv [])
521 /* Assembler main program */
523 /* Program long options */
524 static const LongOpt OptTab[] = {
525 { "--cfg-path", 1, OptCfgPath },
526 { "--config", 1, OptConfig },
527 { "--dbgfile", 1, OptDbgFile },
528 { "--define", 1, OptDefine },
529 { "--dump-config", 1, OptDumpConfig },
530 { "--end-group", 0, OptEndGroup },
531 { "--force-import", 1, OptForceImport },
532 { "--help", 0, OptHelp },
533 { "--lib", 1, OptLib },
534 { "--lib-path", 1, OptLibPath },
535 { "--mapfile", 1, OptMapFile },
536 { "--module-id", 1, OptModuleId },
537 { "--obj", 1, OptObj },
538 { "--obj-path", 1, OptObjPath },
539 { "--start-addr", 1, OptStartAddr },
540 { "--start-group", 0, OptStartGroup },
541 { "--target", 1, OptTarget },
542 { "--version", 0, OptVersion },
546 unsigned MemoryAreaOverflows;
548 /* Initialize the cmdline module */
549 InitCmdLine (&argc, &argv, "ld65");
551 /* Initialize the input file search paths */
554 /* Initialize the string pool */
557 /* Check the parameters */
559 while (I < ArgCount) {
561 /* Get the argument */
562 const char* Arg = ArgVec[I];
564 /* Check for an option */
565 if (Arg [0] == '-') {
571 LongOption (&I, OptTab, sizeof(OptTab)/sizeof(OptTab[0]));
575 OptStartGroup (Arg, 0);
579 OptEndGroup (Arg, 0);
588 OptMapFile (Arg, GetArg (&I, 2));
592 OptOutputName (Arg, GetArg (&I, 2));
597 Error ("Cannot use -C/-t twice");
599 OptTarget (Arg, GetArg (&I, 2));
603 OptForceImport (Arg, GetArg (&I, 2));
608 case 'm': VerboseMap = 1; break;
609 case '\0': ++Verbosity; break;
610 default: UnknownOption (Arg);
615 OptConfig (Arg, GetArg (&I, 2));
619 OptDefine (Arg, GetArg (&I, 2));
624 /* ## The first one is obsolete and will go */
625 case 'n': LabelFileName = GetArg (&I, 3); break;
626 default: OptLibPath (Arg, GetArg (&I, 2)); break;
631 OptStartAddr (Arg, GetArg (&I, 2));
646 LinkFile (Arg, FILETYPE_UNKNOWN);
654 /* Check if we had any object files */
656 Error ("No object files to link");
659 /* Check if we have a valid configuration */
661 Error ("Memory configuration missing");
664 /* Check if we have open library groups */
667 /* Create the condes tables if requested */
670 /* Process data from the config file. Assign start addresses for the
671 * segments, define linker symbols. The function will return the number
672 * of memory area overflows (zero on success).
674 MemoryAreaOverflows = CfgProcess ();
676 /* Check module assertions */
679 /* Check for import/export mismatches */
682 /* If we had a memory area overflow before, we cannot generate the output
683 * file. However, we will generate a short map file if requested, since
684 * this will help the user to rearrange segments and fix the overflow.
686 if (MemoryAreaOverflows) {
688 CreateMapFile (SHORT_MAPFILE);
690 Error ("Cannot generate output due to memory area overflow%s",
691 (MemoryAreaOverflows > 1)? "s" : "");
694 /* Create the output file */
697 /* Check for segments not written to the output file */
700 /* If requested, create a map file and a label file for VICE */
702 CreateMapFile (LONG_MAPFILE);
711 /* Dump the data for debugging */
717 /* Return an apropriate exit code */