1 /*****************************************************************************/
5 /* Main program for the ca65 macroassembler */
9 /* (C) 1998-2013, 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 /*****************************************************************************/
45 #include "debugflag.h"
48 #include "scopedefs.h"
84 /*****************************************************************************/
86 /*****************************************************************************/
90 static void Usage (void)
91 /* Print usage information and exit */
93 printf ("Usage: %s [options] file\n"
95 " -D name[=value]\t\tDefine a symbol\n"
96 " -I dir\t\t\tSet an include directory search path\n"
97 " -U\t\t\t\tMark unresolved symbols as import\n"
98 " -V\t\t\t\tPrint the assembler version\n"
99 " -W n\t\t\t\tSet warning level n\n"
100 " -d\t\t\t\tDebug mode\n"
101 " -g\t\t\t\tAdd debug info to object file\n"
102 " -h\t\t\t\tHelp (this text)\n"
103 " -i\t\t\t\tIgnore case of symbols\n"
104 " -l name\t\t\tCreate a listing file if assembly was ok\n"
105 " -mm model\t\t\tSet the memory model\n"
106 " -o name\t\t\tName the output file\n"
107 " -s\t\t\t\tEnable smart mode\n"
108 " -t sys\t\t\tSet the target system\n"
109 " -v\t\t\t\tIncrease verbosity\n"
112 " --auto-import\t\t\tMark unresolved symbols as import\n"
113 " --bin-include-dir dir\t\tSet a search path for binary includes\n"
114 " --cpu type\t\t\tSet cpu type\n"
115 " --create-dep name\t\tCreate a make dependency file\n"
116 " --create-full-dep name\tCreate a full make dependency file\n"
117 " --debug\t\t\tDebug mode\n"
118 " --debug-info\t\t\tAdd debug info to object file\n"
119 " --feature name\t\tSet an emulation feature\n"
120 " --help\t\t\tHelp (this text)\n"
121 " --ignore-case\t\t\tIgnore case of symbols\n"
122 " --include-dir dir\t\tSet an include directory search path\n"
123 " --large-alignment\t\tDon't warn about large alignments\n"
124 " --listing name\t\tCreate a listing file if assembly was ok\n"
125 " --list-bytes n\t\tMaximum number of bytes per listing line\n"
126 " --macpack-dir dir\t\tSet a macro package directory\n"
127 " --memory-model model\t\tSet the memory model\n"
128 " --pagelength n\t\tSet the page length for the listing\n"
129 " --relax-checks\t\tRelax some checks (see docs)\n"
130 " --smart\t\t\tEnable smart mode\n"
131 " --target sys\t\t\tSet the target system\n"
132 " --verbose\t\t\tIncrease verbosity\n"
133 " --version\t\t\tPrint the assembler version\n",
139 static void SetOptions (void)
140 /* Set the option for the translator */
142 StrBuf Buf = STATIC_STRBUF_INITIALIZER;
144 /* Set the translator */
145 SB_Printf (&Buf, "ca65 V%s", GetVersionAsString ());
146 OptTranslator (&Buf);
148 /* Set date and time */
149 OptDateTime ((unsigned long) time(0));
151 /* Release memory for the string */
157 static void NewSymbol (const char* SymName, long Val)
158 /* Define a symbol with a fixed numeric value in the current scope */
163 /* Convert the name to a string buffer */
164 StrBuf SymBuf = STATIC_STRBUF_INITIALIZER;
165 SB_CopyStr (&SymBuf, SymName);
167 /* Search for the symbol, allocate a new one if it doesn't exist */
168 Sym = SymFind (CurrentScope, &SymBuf, SYM_ALLOC_NEW);
170 /* Check if have already a symbol with this name */
171 if (SymIsDef (Sym)) {
172 AbEnd ("`%s' is already defined", SymName);
175 /* Generate an expression for the symbol */
176 Expr = GenLiteralExpr (Val);
178 /* Mark the symbol as defined */
179 SymDef (Sym, Expr, ADDR_SIZE_DEFAULT, SF_NONE);
181 /* Free string buffer memory */
187 static void CBMSystem (const char* Sys)
188 /* Define a CBM system */
190 NewSymbol ("__CBM__", 1);
196 static void SetSys (const char* Sys)
197 /* Define a target system */
199 switch (Target = FindTarget (Sys)) {
205 AbEnd ("Cannot use `module' as a target for the assembler");
209 NewSymbol ("__ATARI2600__", 1);
213 NewSymbol ("__ATARI5200__", 1);
217 NewSymbol ("__ATARI__", 1);
221 NewSymbol ("__ATARI__", 1);
222 NewSymbol ("__ATARIXL__", 1);
226 CBMSystem ("__C16__");
230 CBMSystem ("__C64__");
234 CBMSystem ("__C65__");
238 CBMSystem ("__VIC20__");
242 CBMSystem ("__C128__");
246 CBMSystem ("__C16__");
247 NewSymbol ("__PLUS4__", 1);
251 CBMSystem ("__CBM510__");
255 CBMSystem ("__CBM610__");
259 CBMSystem ("__PET__");
263 NewSymbol ("__BBC__", 1);
267 NewSymbol ("__APPLE2__", 1);
271 NewSymbol ("__APPLE2__", 1);
272 NewSymbol ("__APPLE2ENH__", 1);
276 NewSymbol ("__GAMATE__", 1);
280 /* Do not handle as a CBM system */
281 NewSymbol ("__GEOS__", 1);
282 NewSymbol ("__GEOS_CBM__", 1);
285 case TGT_CREATIVISION:
286 NewSymbol ("__CREATIVISION__", 1);
290 NewSymbol ("__GEOS__", 1);
291 NewSymbol ("__GEOS_APPLE__", 1);
295 NewSymbol ("__LUNIX__", 1);
299 NewSymbol ("__ATMOS__", 1);
303 NewSymbol ("__TELESTRAT__", 1);
307 NewSymbol ("__NES__", 1);
310 case TGT_SUPERVISION:
311 NewSymbol ("__SUPERVISION__", 1);
315 NewSymbol ("__LYNX__", 1);
319 NewSymbol ("__SIM6502__", 1);
323 NewSymbol ("__SIM65C02__", 1);
327 NewSymbol ("__OSIC1P__", 1);
331 NewSymbol ("__PCE__", 1);
335 AbEnd ("Invalid target name: `%s'", Sys);
339 /* Initialize the translation tables for the target system */
345 static void FileNameOption (const char* Opt, const char* Arg, StrBuf* Name)
346 /* Handle an option that remembers a file name for later */
348 /* Cannot have the option twice */
349 if (SB_NotEmpty (Name)) {
350 AbEnd ("Cannot use option `%s' twice", Opt);
352 /* Remember the file name for later */
353 SB_CopyStr (Name, Arg);
359 static void DefineSymbol (const char* Def)
360 /* Define a symbol from the command line */
364 StrBuf SymName = AUTO_STRBUF_INITIALIZER;
367 /* The symbol must start with a character or underline */
368 if (!IsIdStart (Def [0])) {
373 /* Copy the symbol, checking the rest */
374 while (IsIdChar (*P)) {
375 SB_AppendChar (&SymName, *P++);
377 SB_Terminate (&SymName);
379 /* Do we have a value given? */
386 /* We have a value */
390 if (sscanf (P, "%lx", &Val) != 1) {
394 if (sscanf (P, "%li", &Val) != 1) {
400 /* Define the new symbol */
401 NewSymbol (SB_GetConstBuf (&SymName), Val);
403 /* Release string memory */
409 static void OptAutoImport (const char* Opt attribute ((unused)),
410 const char* Arg attribute ((unused)))
411 /* Mark unresolved symbols as imported */
418 static void OptBinIncludeDir (const char* Opt attribute ((unused)), const char* Arg)
419 /* Add an include search path for binaries */
421 AddSearchPath (BinSearchPath, Arg);
426 static void OptCPU (const char* Opt attribute ((unused)), const char* Arg)
427 /* Handle the --cpu option */
429 cpu_t CPU = FindCPU (Arg);
430 if (CPU == CPU_UNKNOWN) {
431 AbEnd ("Invalid CPU: `%s'", Arg);
439 static void OptCreateDep (const char* Opt, const char* Arg)
440 /* Handle the --create-dep option */
442 FileNameOption (Opt, Arg, &DepName);
447 static void OptCreateFullDep (const char* Opt attribute ((unused)),
449 /* Handle the --create-full-dep option */
451 FileNameOption (Opt, Arg, &FullDepName);
456 static void OptDebug (const char* Opt attribute ((unused)),
457 const char* Arg attribute ((unused)))
458 /* Compiler debug mode */
465 static void OptDebugInfo (const char* Opt attribute ((unused)),
466 const char* Arg attribute ((unused)))
467 /* Add debug info to the object file */
474 static void OptFeature (const char* Opt attribute ((unused)), const char* Arg)
475 /* Set an emulation feature */
477 /* Make a string buffer from Arg */
480 /* Set the feature, check for errors */
481 if (SetFeature (SB_InitFromString (&Feature, Arg)) == FEAT_UNKNOWN) {
482 AbEnd ("Illegal emulation feature: `%s'", Arg);
488 static void OptHelp (const char* Opt attribute ((unused)),
489 const char* Arg attribute ((unused)))
490 /* Print usage information and exit */
498 static void OptIgnoreCase (const char* Opt attribute ((unused)),
499 const char* Arg attribute ((unused)))
500 /* Ignore case on symbols */
507 static void OptIncludeDir (const char* Opt attribute ((unused)), const char* Arg)
508 /* Add an include search path */
510 AddSearchPath (IncSearchPath, Arg);
515 static void OptLargeAlignment (const char* Opt attribute ((unused)),
516 const char* Arg attribute ((unused)))
517 /* Don't warn about large alignments */
524 static void OptListBytes (const char* Opt, const char* Arg)
525 /* Set the maximum number of bytes per listing line */
530 /* Convert the argument to a number */
531 if (sscanf (Arg, "%u%c", &Num, &Check) != 1) {
535 /* Check the bounds */
536 if (Num != 0 && (Num < MIN_LIST_BYTES || Num > MAX_LIST_BYTES)) {
537 AbEnd ("Argument for option `%s' is out of range", Opt);
546 static void OptListing (const char* Opt, const char* Arg)
547 /* Create a listing file */
549 /* Since the meaning of -l and --listing has changed, print an error if
550 ** the filename is empty or begins with the option char.
552 if (Arg == 0 || *Arg == '\0' || *Arg == '-') {
553 Fatal ("The meaning of `%s' has changed. It does now "
554 "expect a file name as argument.", Opt);
557 /* Get the file name */
558 FileNameOption (Opt, Arg, &ListingName);
563 static void OptMemoryModel (const char* Opt, const char* Arg)
564 /* Set the memory model */
568 /* Check the current memory model */
569 if (MemoryModel != MMODEL_UNKNOWN) {
570 AbEnd ("Cannot use option `%s' twice", Opt);
573 /* Translate the memory model name and check it */
574 M = FindMemoryModel (Arg);
575 if (M == MMODEL_UNKNOWN) {
576 AbEnd ("Unknown memory model: %s", Arg);
577 } else if (M == MMODEL_HUGE) {
578 AbEnd ("Unsupported memory model: %s", Arg);
581 /* Set the memory model */
587 static void OptPageLength (const char* Opt attribute ((unused)), const char* Arg)
588 /* Handle the --pagelength option */
590 int Len = atoi (Arg);
591 if (Len != -1 && (Len < MIN_PAGE_LEN || Len > MAX_PAGE_LEN)) {
592 AbEnd ("Invalid page length: %d", Len);
599 static void OptRelaxChecks (const char* Opt attribute ((unused)),
600 const char* Arg attribute ((unused)))
601 /* Handle the --relax-checks options */
608 static void OptSmart (const char* Opt attribute ((unused)),
609 const char* Arg attribute ((unused)))
610 /* Handle the -s/--smart options */
617 static void OptTarget (const char* Opt attribute ((unused)), const char* Arg)
618 /* Set the target system */
625 static void OptVerbose (const char* Opt attribute ((unused)),
626 const char* Arg attribute ((unused)))
627 /* Increase verbosity */
634 static void OptVersion (const char* Opt attribute ((unused)),
635 const char* Arg attribute ((unused)))
636 /* Print the assembler version */
638 fprintf (stderr, "%s V%s\n", ProgName, GetVersionAsString ());
644 static void DoPCAssign (void)
645 /* Start absolute code */
647 long PC = ConstExpression ();
648 if (PC < 0 || PC > 0xFFFFFF) {
649 Error ("Range error");
651 EnterAbsoluteMode (PC);
657 static void OneLine (void)
658 /* Assemble one line */
661 unsigned long PC = 0;
666 /* Initialize the new listing line if we are actually reading from file
667 ** and not from internally pushed input.
669 if (!HavePushedInput ()) {
673 /* Single colon means unnamed label */
674 if (CurTok.Tok == TOK_COLON) {
679 /* If the first token on the line is an identifier, check for a macro or
682 if (CurTok.Tok == TOK_IDENT) {
683 if (UbiquitousIdents) {
684 /* Macros CAN be instructions, so check for them first */
685 Mac = FindMacro (&CurTok.SVal);
687 Instr = FindInstruction (&CurTok.SVal);
690 /* Macros and symbols may NOT use the names of instructions */
691 Instr = FindInstruction (&CurTok.SVal);
693 Mac = FindMacro (&CurTok.SVal);
698 /* Handle an identifier. This may be a cheap local symbol, or a fully
699 ** scoped identifier which may start with a namespace token (for global
702 if (CurTok.Tok == TOK_LOCAL_IDENT ||
703 CurTok.Tok == TOK_NAMESPACE ||
704 (CurTok.Tok == TOK_IDENT && Instr < 0 && Mac == 0)) {
706 /* Did we have whitespace before the ident? */
707 int HadWS = CurTok.WS;
709 /* Generate the symbol table entry, then skip the name */
710 Sym = ParseAnySymName (SYM_ALLOC_NEW);
712 /* If a colon follows, this is a label definition. If there
713 ** is no colon, it's an assignment.
715 if (CurTok.Tok == TOK_EQ || CurTok.Tok == TOK_ASSIGN) {
717 /* Determine the symbol flags from the assignment token */
718 unsigned Flags = (CurTok.Tok == TOK_ASSIGN)? SF_LABEL : SF_NONE;
723 /* Define the symbol with the expression following the '=' */
724 SymDef (Sym, Expression(), ADDR_SIZE_DEFAULT, Flags);
726 /* Don't allow anything after a symbol definition */
730 } else if (CurTok.Tok == TOK_SET) {
734 /* .SET defines variables (= redefinable symbols) */
737 /* Read the assignment expression, which must be constant */
738 Expr = GenLiteralExpr (ConstExpression ());
740 /* Define the symbol with the constant expression following
743 SymDef (Sym, Expr, ADDR_SIZE_DEFAULT, SF_VAR);
745 /* Don't allow anything after a symbol definition */
751 /* A label. Remember the current segment, so we can later
752 ** determine the size of the data stored under the label.
757 /* Define the label */
758 SymDef (Sym, GenCurrentPC (), ADDR_SIZE_DEFAULT, SF_LABEL);
760 /* Skip the colon. If NoColonLabels is enabled, allow labels
761 ** without a colon if there is no whitespace before the
764 if (CurTok.Tok != TOK_COLON) {
765 if (HadWS || !NoColonLabels) {
766 Error ("`:' expected");
767 /* Try some smart error recovery */
768 if (CurTok.Tok == TOK_NAMESPACE) {
777 /* If we come here, a new identifier may be waiting, which may
778 ** be a macro or instruction.
780 if (CurTok.Tok == TOK_IDENT) {
781 if (UbiquitousIdents) {
782 /* Macros CAN be instructions, so check for them first */
783 Mac = FindMacro (&CurTok.SVal);
785 Instr = FindInstruction (&CurTok.SVal);
788 /* Macros and symbols may NOT use the names of instructions */
789 Instr = FindInstruction (&CurTok.SVal);
791 Mac = FindMacro (&CurTok.SVal);
798 /* We've handled a possible label, now handle the remainder of the line */
799 if (CurTok.Tok >= TOK_FIRSTPSEUDO && CurTok.Tok <= TOK_LASTPSEUDO) {
800 /* A control command */
802 } else if (Mac != 0) {
803 /* A macro expansion */
804 MacExpandStart (Mac);
805 } else if (Instr >= 0) {
806 /* A mnemonic - assemble one instruction */
807 HandleInstruction (Instr);
808 } else if (PCAssignment && (CurTok.Tok == TOK_STAR || CurTok.Tok == TOK_PC)) {
810 if (CurTok.Tok != TOK_EQ) {
811 Error ("`=' expected");
814 /* Skip the equal sign */
816 /* Enter absolute mode */
821 /* If we have defined a label, remember its size. Sym is also set by
822 ** a symbol assignment, but in this case Done is false, so we don't
827 if (Seg == ActiveSeg) {
829 Size = GetPC () - PC;
831 /* The line has switched the segment */
834 DefSizeOfSymbol (Sym, Size);
837 /* Line separator must come here */
843 static void Assemble (void)
844 /* Start the ball rolling ... */
849 /* Assemble lines until end of file */
850 while (CurTok.Tok != TOK_EOF) {
857 static void CreateObjFile (void)
858 /* Create the object file */
860 /* Open the object, write the header */
863 /* Write the object file options */
866 /* Write the list of input files */
869 /* Write the segment data to the file */
872 /* Write the import list */
875 /* Write the export list */
878 /* Write debug symbols if requested */
881 /* Write the scopes if requested */
884 /* Write line infos if requested */
887 /* Write the string pool */
890 /* Write the assertions */
893 /* Write the spans */
896 /* Write an updated header and close the file */
902 int main (int argc, char* argv [])
903 /* Assembler main program */
905 /* Program long options */
906 static const LongOpt OptTab[] = {
907 { "--auto-import", 0, OptAutoImport },
908 { "--bin-include-dir", 1, OptBinIncludeDir },
909 { "--cpu", 1, OptCPU },
910 { "--create-dep", 1, OptCreateDep },
911 { "--create-full-dep", 1, OptCreateFullDep },
912 { "--debug", 0, OptDebug },
913 { "--debug-info", 0, OptDebugInfo },
914 { "--feature", 1, OptFeature },
915 { "--help", 0, OptHelp },
916 { "--ignore-case", 0, OptIgnoreCase },
917 { "--include-dir", 1, OptIncludeDir },
918 { "--large-alignment", 0, OptLargeAlignment },
919 { "--list-bytes", 1, OptListBytes },
920 { "--listing", 1, OptListing },
921 { "--memory-model", 1, OptMemoryModel },
922 { "--pagelength", 1, OptPageLength },
923 { "--relax-checks", 0, OptRelaxChecks },
924 { "--smart", 0, OptSmart },
925 { "--target", 1, OptTarget },
926 { "--verbose", 0, OptVerbose },
927 { "--version", 0, OptVersion },
930 /* Name of the global name space */
931 static const StrBuf GlobalNameSpace = STATIC_STRBUF_INITIALIZER;
935 /* Initialize the cmdline module */
936 InitCmdLine (&argc, &argv, "ca65");
938 /* Initialize the string pool */
941 /* Initialize the include search paths */
944 /* Create the predefined segments */
947 /* Enter the base lexical level. We must do that here, since we may
948 ** define symbols using -D.
950 SymEnterLevel (&GlobalNameSpace, SCOPE_FILE, ADDR_SIZE_DEFAULT, 0);
952 /* Initialize the line infos. Must be done here, since we need line infos
953 ** for symbol definitions.
957 /* Check the parameters */
959 while (I < ArgCount) {
961 /* Get the argument */
962 const char* Arg = ArgVec [I];
964 /* Check for an option */
969 LongOption (&I, OptTab, sizeof(OptTab)/sizeof(OptTab[0]));
977 OptDebugInfo (Arg, 0);
985 OptIgnoreCase (Arg, 0);
989 OptListing (Arg, GetArg (&I, 2));
994 OptMemoryModel (Arg, GetArg (&I, 3));
1001 OutFile = GetArg (&I, 2);
1009 OptTarget (Arg, GetArg (&I, 2));
1013 OptVerbose (Arg, 0);
1017 DefineSymbol (GetArg (&I, 2));
1021 OptIncludeDir (Arg, GetArg (&I, 2));
1025 OptAutoImport (Arg, 0);
1029 OptVersion (Arg, 0);
1033 WarnLevel = atoi (GetArg (&I, 2));
1037 UnknownOption (Arg);
1042 /* Filename. Check if we already had one */
1044 fprintf (stderr, "%s: Don't know what to do with `%s'\n",
1046 exit (EXIT_FAILURE);
1056 /* Do we have an input file? */
1058 fprintf (stderr, "%s: No input files\n", ProgName);
1059 exit (EXIT_FAILURE);
1062 /* Add the default include search paths. */
1063 FinishIncludePaths ();
1065 /* If no CPU given, use the default CPU for the target */
1066 if (GetCPU () == CPU_UNKNOWN) {
1067 if (Target != TGT_UNKNOWN) {
1068 SetCPU (GetTargetProperties (Target)->DefaultCPU);
1074 /* If no memory model was given, use the default */
1075 if (MemoryModel == MMODEL_UNKNOWN) {
1076 SetMemoryModel (MMODEL_NEAR);
1079 /* Set the default segment sizes according to the memory model */
1082 /* Initialize the scanner, open the input file */
1083 InitScanner (InFile);
1085 /* Define the default options */
1088 /* Assemble the input */
1091 /* If we didn't have any errors, check the pseudo insn stacks */
1092 if (ErrorCount == 0) {
1096 /* If we didn't have any errors, check and cleanup the unnamed labels */
1097 if (ErrorCount == 0) {
1101 /* If we didn't have any errors, check the symbol table */
1102 if (ErrorCount == 0) {
1106 /* If we didn't have any errors, check the hll debug symbols */
1107 if (ErrorCount == 0) {
1111 /* If we didn't have any errors, close the file scope lexical level */
1112 if (ErrorCount == 0) {
1116 /* If we didn't have any errors, check and resolve the segment data */
1117 if (ErrorCount == 0) {
1121 /* If we didn't have any errors, check the assertions */
1122 if (ErrorCount == 0) {
1127 if (Verbosity >= 2) {
1132 /* If we didn't have an errors, finish off the line infos */
1135 /* If we didn't have any errors, create the object, listing and
1138 if (ErrorCount == 0) {
1140 if (SB_GetLen (&ListingName) > 0) {
1143 CreateDependencies ();
1146 /* Close the input file */
1149 /* Return an apropriate exit code */
1150 return (ErrorCount == 0)? EXIT_SUCCESS : EXIT_FAILURE;