]> Shamusworld >> Repos - rmac/blob - rmac.c
Fixed WARNING macro to be system agnostic, added doco for -p switch.
[rmac] / rmac.c
1 //
2 // RMAC - Reboot's Macro Assembler for the Atari Jaguar Console System
3 // RMAC.C - Main Application Code
4 // Copyright (C) 199x Landon Dyer, 2011 Reboot and Friends
5 // RMAC derived from MADMAC v1.07 Written by Landon Dyer, 1986
6 // Source utilised with the kind permission of Landon Dyer
7 //
8
9 #include "rmac.h"
10 #include "error.h"
11 #include "listing.h"
12 #include "procln.h"
13 #include "token.h"
14 #include "expr.h"
15 #include "sect.h"
16 #include "mark.h"
17 #include "macro.h"
18 #include "riscasm.h"
19 #include "direct.h"
20 #include "version.h"
21 #include "debug.h"
22 #include "symbol.h"
23 #include "object.h"
24
25 int perm_verb_flag;                             // Permanently verbose, interactive mode
26 int list_flag;                                  // "-l" listing flag on command line
27 int verb_flag;                                  // Be verbose about what's going on
28 int as68_flag;                                  // as68 kludge mode
29 int glob_flag;                                  // Assume undefined symbols are global
30 int lsym_flag;                                  // Include local symbols in object file
31 int sbra_flag;                                  // Warn about possible short branches
32 int prg_flag;                                   // !=0, produce .PRG executable (2=symbols)
33 int legacy_flag;                                // Do stuff like insert code in RISC assembler
34 int obj_format;                                 // Object format flag
35 int debug;                                              // [1..9] Enable debugging levels
36 int err_flag;                                   // '-e' specified
37 int err_fd;                                             // File to write error messages to 
38 int rgpu, rdsp;                                 // Assembling Jaguar GPU or DSP code
39 int list_fd;                                    // File to write listing to
40 int regbank;                                    // RISC register bank
41 int segpadsize;                                 // Segment padding size
42 int endian;                                             // Host processor endianess
43 char * objfname;                                // Object filename pointer
44 char * firstfname;                              // First source filename
45 char * cmdlnexec;                               // Executable name, pointer to ARGV[0]
46 char * searchpath;                              // Search path for include files 
47 char defname[] = "noname.o";    // Default output filename
48
49
50 //
51 // Manipulate file extension.
52 //
53 // 'name' must be large enough to hold any possible filename. If 'stripp' is
54 // nonzero, any old extension is removed. If the file does not already have an
55 // extension, 'extension' is appended to the filename.
56 //
57 char * fext(char * name, char * extension, int stripp)
58 {
59         char * s;
60
61         // Find beginning of "real" name (strip off path)
62         char * beg = strrchr(name, SLASHCHAR);
63
64         if (beg == NULL)
65                 beg = name;
66
67         // Clobber any old extension, if requested
68         if (stripp)
69         {
70                 for(s=beg; *s && *s!='.'; ++s) 
71                         ;
72
73                 *s = '\0';
74         }
75
76         if (strrchr(beg, '.') == NULL)
77                 strcat(beg, extension);
78
79         return name;
80 }
81
82
83 //
84 // Return 'item'nth element of semicolon-seperated pathnames specified in the
85 // enviroment string 's'. Copy the pathname to 'buf'.  Return 0 if the 'item'
86 // nth path doesn't exist.
87 // 
88 // ['item' ranges from 0 to N-1, where N = #elements in search path]
89 //
90 int nthpath(char * env_var, int itemno, char * buf)
91 {
92         char * s = searchpath;
93
94         if (s == NULL)
95                 s = getenv(env_var);
96
97         if (s == NULL)
98                 return 0;
99
100         while (itemno--)
101                 while (*s != EOS && *s++ != ';')
102                         ;
103
104         if (*s == EOS)
105                 return 0;
106
107         while (*s != EOS && *s != ';')
108                 *buf++ = *s++;
109
110         *buf++ = EOS;
111
112         return 1;
113 }
114
115
116 //
117 // Display command line help
118 //
119 void DisplayHelp(void)
120 {
121         printf("Usage:\n"
122                 "    %s [options] srcfile\n"
123                 "\n"
124                 "Options:\n"
125                 "  -? or -h          Display usage information\n"
126                 "  -dsymbol[=value]  Define symbol\n"
127                 "  -e[errorfile]     Send error messages to file, not stdout\n"
128                 "  -f[format]        Output object file format\n"
129                 "                    a: ALCYON (use this for ST)\n"
130                 "                    b: BSD (use this for Jaguar)\n"
131                 "  -i[path]          Directory to search for include files\n"
132                 "  -l[filename]      Create an output listing file\n"
133                 "  -n                Don't do things behind your back in RISC assembler\n"
134                 "  -o file           Output file name\n"
135                 "  -p[n]             Create an ST .prg (1=normal, 2=w/symbols)\n"
136                 "  -r[size]          Pad segments to boundary size specified\n"
137                 "                    w: word (2 bytes, default alignment)\n"
138                 "                    l: long (4 bytes)\n"
139                 "                    p: phrase (8 bytes)\n"
140                 "                    d: double phrase (16 bytes)\n"
141                 "                    q: quad phrase (32 bytes)\n"
142                 "  -s                Warn about possible short branches\n"
143                 "  -u                Force referenced and undefined symbols global\n"
144                 "  -v                Set verbose mode\n"
145                 "  -y[pagelen]       Set page line length (default: 61)\n"
146                 "\n", cmdlnexec);
147 }
148
149
150 //
151 // Display version information
152 //
153 void DisplayVersion(void)
154 {
155         printf("\nReboot's Macro Assembler for Atari Jaguar\n"
156                 "Copyright (C) 199x Landon Dyer, 2011-2015 Reboot\n"
157                 "V%01i.%01i.%01i %s (%s)\n\n", MAJOR, MINOR, PATCH, __DATE__, PLATFORM);
158 }
159
160
161 // 
162 // Process command line arguments and do an assembly
163 //
164 int Process(int argc, char ** argv)
165 {
166         int argno;                                              // Argument number
167         SYM * sy;                                               // Pointer to a symbol record
168         char * s;                                               // String pointer
169         int fd;                                                 // File descriptor
170         char fnbuf[FNSIZ];                              // Filename buffer 
171         int i;                                                  // Iterator
172
173         errcnt = 0;                                             // Initialise error count
174         listing = 0;                                    // Initialise listing level
175         list_flag = 0;                                  // Initialise listing flag
176         verb_flag = perm_verb_flag;             // Initialise verbose flag
177         as68_flag = 0;                                  // Initialise as68 kludge mode
178         glob_flag = 0;                                  // Initialise .globl flag
179         sbra_flag = 0;                                  // Initialise short branch flag
180         debug = 0;                                              // Initialise debug flag
181         searchpath = NULL;                              // Initialise search path
182         objfname = NULL;                                // Initialise object filename
183         list_fname = NULL;                              // Initialise listing filename
184         err_fname = NULL;                               // Initialise error filename
185         obj_format = BSD;                               // Initialise object format
186         firstfname = NULL;                              // Initialise first filename
187         err_fd = ERROUT;                                // Initialise error file descriptor
188         err_flag = 0;                                   // Initialise error flag
189         rgpu = 0;                                               // Initialise GPU assembly flag
190         rdsp = 0;                                               // Initialise DSP assembly flag
191         lsym_flag = 1;                                  // Include local symbols in object file
192         regbank = BANK_N;                               // No RISC register bank specified
193         orgactive = 0;                                  // Not in RISC org section
194         orgwarning = 0;                                 // No ORG warning issued
195         segpadsize = 2;                                 // Initialise segment padding size
196
197         // Initialise modules
198         InitSymbolTable();                              // Symbol table
199         InitTokenizer();                                // Tokenizer
200         InitLineProcessor();                    // Line processor
201         InitExpression();                               // Expression analyzer
202         InitSection();                                  // Section manager / code generator
203         InitMark();                                             // Mark tape-recorder
204         InitMacro();                                    // Macro processor
205         InitListing();                                  // Listing generator
206
207         // Process command line arguments and assemble source files
208         for(argno=0; argno<argc; ++argno)
209         {
210                 if (*argv[argno] == '-')
211                 {
212                         switch (argv[argno][1])
213                         {
214                         case 'd':                               // Define symbol
215                         case 'D':
216                                 for(s=argv[argno]+2; *s!=EOS;)
217                                 {
218                                         if (*s++ == '=')
219                                         {
220                                                 s[-1] = EOS;
221                                                 break;
222                                         }
223                                 }
224
225                                 if (argv[argno][2] == EOS)
226                                 {
227                                         printf("-d: empty symbol\n");
228                                         errcnt++;
229                                         return errcnt;
230                                 }
231
232                                 sy = lookup(argv[argno] + 2, 0, 0);
233
234                                 if (sy == NULL)
235                                 {
236                                         sy = NewSymbol(argv[argno] + 2, LABEL, 0);
237                                         sy->svalue = 0;
238                                 }
239
240                                 sy->sattr = DEFINED | EQUATED | ABS;
241                                 sy->svalue = (*s ? (VALUE)atoi(s) : 0);
242                                 break;
243                         case 'e':                               // Redirect error message output
244                         case 'E':
245                                 err_fname = argv[argno] + 2;
246                                 break;
247                         case 'f':                               // -f<format>
248                         case 'F':
249                                 switch (argv[argno][2])
250                                 {
251                                 case EOS:
252                                 case 'a':                       // -fa = Alcyon [the default]
253                                 case 'A':
254                                         obj_format = ALCYON;
255                                         break;
256                                 case 'b':                       // -fb = BSD (Jaguar Recommended)
257                                 case 'B':
258                                         obj_format = BSD;
259                                         break;
260                                 default:
261                                         printf("-f: unknown object format specified\n");
262                                         errcnt++;
263                                         return errcnt;
264                                 }
265                                 break;
266                         case 'g':                               // Debugging flag
267                         case 'G':
268                                 printf("Debugging flag (-g) not yet implemented\n");
269                                 break;
270                         case 'i':                               // Set directory search path
271                         case 'I':
272                                 searchpath = argv[argno] + 2;
273                                 break;
274                         case 'l':                               // Produce listing file
275                         case 'L':
276                                 list_fname = argv[argno] + 2;
277                                 listing = 1;
278                                 list_flag = 1;
279                                 lnsave++;
280                                 break;
281                         case 'o':                               // Direct object file output
282                         case 'O':
283                                 if (argv[argno][2] != EOS)
284                                         objfname = argv[argno] + 2;
285                                 else
286                                 {
287                                         if (++argno >= argc)
288                                         {
289                                                 printf("Missing argument to -o");
290                                                 errcnt++;
291                                                 return errcnt;
292                                         }
293
294                                         objfname = argv[argno];
295                                 }
296
297                                 break;
298                         case 'p':               /* -p: generate ".PRG" executable output */
299                         case 'P':
300                                 /*
301                                  * -p           .PRG generation w/o symbols
302                                  * -ps  .PRG generation with symbols
303                                  */
304                                 switch (argv[argno][2])
305                                 {
306                                         case EOS:
307                                                 prg_flag = 1;
308                                                 break;
309
310                                         case 's':
311                                         case 'S':
312                                                 prg_flag = 2;
313                                                 break;
314
315                                         default:
316                                                 printf("-p: syntax error\n");
317                                                 ++errcnt;
318                                                 return errcnt;
319                                 }
320                                 break;
321                         case 'r':                               // Pad seg to requested boundary size
322                         case 'R':
323                                 switch(argv[argno][2])
324                                 {
325                                 case 'w': case 'W': segpadsize = 2;  break;  
326                                 case 'l': case 'L': segpadsize = 4;  break;
327                                 case 'p': case 'P': segpadsize = 8;  break;
328                                 case 'd': case 'D': segpadsize = 16; break;
329                                 case 'q': case 'Q': segpadsize = 32; break;
330                                 default: segpadsize = 2; break; // Effective autoeven();
331                                 }
332                                 break;
333                         case 's':                               // Warn about possible short branches
334                         case 'S':
335                                 sbra_flag = 1;
336                                 break;
337                         case 'u':                               // Make undefined symbols .globl
338                         case 'U':
339                                 glob_flag = 1;
340                                 break;
341                         case 'v':                               // Verbose flag
342                         case 'V':
343                                 verb_flag++;
344
345                                 if (verb_flag > 1)
346                                         DisplayVersion();
347
348                                 break;
349                         case 'x':                               // Turn on debugging
350                         case 'X':
351                                 debug = 1;
352                                 printf("~ Debugging ON\n");
353                                 break;
354                         case 'y':                               // -y<pagelen>
355                         case 'Y':
356                                 pagelen = atoi(argv[argno] + 2);
357
358                                 if (pagelen < 10)
359                                 {
360                                         printf("-y: bad page length\n");
361                                         ++errcnt;
362                                         return errcnt;
363                                 }
364
365                                 break;
366                         case EOS:                               // Input is stdin
367                                 if (firstfname == NULL) // Kludge first filename
368                                         firstfname = defname;
369
370                                 include(0, "(stdin)");
371                                 Assemble();
372                                 break;
373                         case 'h':                               // Display command line usage
374                         case 'H':
375                         case '?':
376                                 DisplayVersion();
377                                 DisplayHelp();
378                                 errcnt++;
379                                 break;
380                         case 'n':                               // Turn off legacy mode
381                         case 'N':
382                                 legacy_flag = 0;
383                                 printf("Legacy mode OFF\n");
384                                 break;
385                         default:
386                                 DisplayVersion();
387                                 printf("Unknown switch: %s\n\n", argv[argno]);
388                                 DisplayHelp();
389                                 errcnt++;
390                                 break;
391                         }
392                 }
393                 else
394                 {
395                         // Record first filename.
396                         if (firstfname == NULL)
397                                 firstfname = argv[argno];
398
399                         strcpy(fnbuf, argv[argno]);
400                         fext(fnbuf, ".s", 0);
401                         fd = open(fnbuf, 0);
402
403                         if (fd < 0)
404                         {
405                                 printf("Cannot open: %s\n", fnbuf);
406                                 errcnt++;
407                                 continue;
408                         }
409
410                         include(fd, fnbuf);
411                         Assemble();
412                 }
413         }
414
415         // Wind-up processing;
416         // o  save current section (no more code generation)
417         // o  do auto-even of all sections (or boundary alignment as requested
418         //    through '-r')
419         // o  determine name of object file:
420         //    -  "foo.o" for linkable output;
421         //    -  "foo.prg" for GEMDOS executable (-p flag).
422         SaveSection();
423
424         for(i=TEXT; i<=BSS; i<<=1)
425         {
426                 SwitchSection(i);
427
428                 switch(segpadsize)
429                 {
430                 case 2:  d_even();    break;
431                 case 4:  d_long();    break;
432                 case 8:  d_phrase();  break;
433                 case 16: d_dphrase(); break;
434                 case 32: d_qphrase(); break;
435                 }
436
437                 SaveSection();
438         }
439
440         if (objfname == NULL)
441         {
442                 if (firstfname == NULL)
443                         firstfname = defname;
444
445                 strcpy(fnbuf, firstfname);
446                 fext(fnbuf, (prg_flag ? ".prg" : ".o"), 1);
447                 fext(fnbuf, ".o", 1);
448                 objfname = fnbuf;
449         }
450
451         // With one pass finished, go back and:
452         // (1)   run through all the fixups and resolve forward references;
453         // (1.5) ensure that remaining fixups can be handled by the linker
454         //       (`lo68' format, extended (postfix) format....)
455         // (2)   generate the output file image and symbol table;
456         // (3)   generate relocation information from left-over fixups.
457         ResolveAllFixups();                                             // Do all fixups
458         StopMark();                                                             // Stop mark tape-recorder
459
460         if (errcnt == 0)
461         {
462                 if ((fd = open(objfname, _OPEN_FLAGS, _PERM_MODE)) < 0)
463                         cantcreat(objfname);
464
465                 if (verb_flag)
466                 {
467                         s = (prg_flag ? "executable" : "object");
468                         printf("[Writing %s file: %s]\n", s, objfname);
469                 }
470
471                 WriteObject(fd);
472                 close(fd);
473
474                 if (errcnt != 0)
475                         unlink(objfname);
476         }
477
478         if (list_flag)
479         {
480                 if (verb_flag)
481                         printf("[Wrapping-up listing file]\n");
482
483                 listing = 1;
484                 symtable();
485                 close(list_fd);
486         }
487
488         if (err_flag)
489                 close(err_fd);
490
491         DEBUG dump_everything();
492
493         return errcnt;
494 }
495
496
497 //
498 // Determine processor endianess
499 //
500 int GetEndianess(void)
501 {
502         int i = 1;
503         char * p = (char *)&i;
504
505         if (p[0] == 1)
506                 return 0;
507
508         return 1;
509 }
510
511
512 //
513 // Application entry point
514 //
515 int main(int argc, char ** argv)
516 {
517         perm_verb_flag = 0;                             // Clobber "permanent" verbose flag
518         legacy_flag = 1;                                // Default is legacy mode on (:-P)
519         cmdlnexec = argv[0];                    // Obtain executable name
520
521         endian = GetEndianess();                // Get processor endianess
522
523         // If commands were passed in, process them
524         if (argc > 1)
525                 return Process(argc - 1, argv + 1);              
526
527         DisplayVersion();
528         DisplayHelp();
529
530         return 0;
531 }
532