1 /* ----------------------------------------------------------------------- *
3 * Copyright 1996-2009 The NASM Authors - All Rights Reserved
4 * See the file AUTHORS included with the NASM distribution for
5 * the specific copyright holders.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 * ----------------------------------------------------------------------- */
35 * The Netwide Assembler main program module
61 #include "output/outform.h"
64 struct forwrefinfo { /* info held on forward refs. */
69 static int get_bits(char *value);
70 static uint32_t get_cpu(char *cpu_str);
71 static void parse_cmdline(int, char **);
72 static void assemble_file(char *, StrList **);
73 static void register_output_formats(void);
74 static void report_error_gnu(int severity, const char *fmt, ...);
75 static void report_error_vc(int severity, const char *fmt, ...);
76 static void report_error_common(int severity, const char *fmt,
78 static bool is_suppressed_warning(int severity);
79 static void usage(void);
80 static efunc report_error;
82 static int using_debug_info, opt_verbose_info;
83 bool tasm_compatible_mode = false;
88 time_t official_compile_time;
90 static char inname[FILENAME_MAX];
91 static char outname[FILENAME_MAX];
92 static char listname[FILENAME_MAX];
93 static char errname[FILENAME_MAX];
94 static int globallineno; /* for forward-reference tracking */
95 /* static int pass = 0; */
96 static struct ofmt *ofmt = NULL;
98 static FILE *error_file; /* Where to write error messages */
100 static FILE *ofile = NULL;
101 int optimizing = -1; /* number of optimization passes to take */
102 static int sb, cmd_sb = 16; /* by default */
103 static uint32_t cmd_cpu = IF_PLEVEL; /* highest level by default */
104 static uint32_t cpu = IF_PLEVEL; /* passed to insn_size & assemble.c */
105 int64_t global_offset_changed; /* referenced in labels.c */
106 int64_t prev_offset_changed;
109 static struct location location;
110 int in_abs_seg; /* Flag we are in ABSOLUTE seg */
111 int32_t abs_seg; /* ABSOLUTE segment basis */
112 int32_t abs_offset; /* ABSOLUTE offset */
114 static struct RAA *offsets;
116 static struct SAA *forwrefs; /* keep track of forward references */
117 static const struct forwrefinfo *forwref;
119 static Preproc *preproc;
121 op_normal, /* Preprocess and assemble */
122 op_preprocess, /* Preprocess only */
123 op_depend, /* Generate dependencies */
125 static enum op_type operating_mode;
126 /* Dependency flags */
127 static bool depend_emit_phony = false;
128 static bool depend_missing_ok = false;
129 static const char *depend_target = NULL;
130 static const char *depend_file = NULL;
133 * Which of the suppressible warnings are suppressed. Entry zero
134 * isn't an actual warning, but it used for -w+error/-Werror.
137 static bool warning_on[ERR_WARN_MAX+1]; /* Current state */
138 static bool warning_on_global[ERR_WARN_MAX+1]; /* Command-line state */
140 static const struct warning {
144 } warnings[ERR_WARN_MAX+1] = {
145 {"error", "treat warnings as errors", false},
146 {"macro-params", "macro calls with wrong parameter count", true},
147 {"macro-selfref", "cyclic macro references", false},
148 {"macro-defaults", "macros with more default than optional parameters", true},
149 {"orphan-labels", "labels alone on lines without trailing `:'", true},
150 {"number-overflow", "numeric constant does not fit", true},
151 {"gnu-elf-extensions", "using 8- or 16-bit relocation in ELF32, a GNU extension", false},
152 {"float-overflow", "floating point overflow", true},
153 {"float-denorm", "floating point denormal", false},
154 {"float-underflow", "floating point underflow", false},
155 {"float-toolong", "too many digits in floating-point number", true},
156 {"user", "%warning directives", true},
160 * This is a null preprocessor which just copies lines from input
161 * to output. It's used when someone explicitly requests that NASM
162 * not preprocess their source file.
165 static void no_pp_reset(char *, int, efunc, evalfunc, ListGen *, StrList **);
166 static char *no_pp_getline(void);
167 static void no_pp_cleanup(int);
168 static Preproc no_pp = {
175 * get/set current offset...
177 #define GET_CURR_OFFS (in_abs_seg?abs_offset:\
178 raa_read(offsets,location.segment))
179 #define SET_CURR_OFFS(x) (in_abs_seg?(void)(abs_offset=(x)):\
180 (void)(offsets=raa_write(offsets,location.segment,(x))))
182 static bool want_usage;
183 static bool terminate_after_phase;
184 int user_nolist = 0; /* fbk 9/2/00 */
186 static void nasm_fputs(const char *line, FILE * outfile)
189 fputs(line, outfile);
195 /* Convert a struct tm to a POSIX-style time constant */
196 static int64_t posix_mktime(struct tm *tm)
199 int64_t y = tm->tm_year;
201 /* See IEEE 1003.1:2004, section 4.14 */
203 t = (y-70)*365 + (y-69)/4 - (y-1)/100 + (y+299)/400;
215 static void define_macros_early(void)
218 struct tm lt, *lt_p, gm, *gm_p;
221 lt_p = localtime(&official_compile_time);
225 strftime(temp, sizeof temp, "__DATE__=\"%Y-%m-%d\"", <);
227 strftime(temp, sizeof temp, "__DATE_NUM__=%Y%m%d", <);
229 strftime(temp, sizeof temp, "__TIME__=\"%H:%M:%S\"", <);
231 strftime(temp, sizeof temp, "__TIME_NUM__=%H%M%S", <);
235 gm_p = gmtime(&official_compile_time);
239 strftime(temp, sizeof temp, "__UTC_DATE__=\"%Y-%m-%d\"", &gm);
241 strftime(temp, sizeof temp, "__UTC_DATE_NUM__=%Y%m%d", &gm);
243 strftime(temp, sizeof temp, "__UTC_TIME__=\"%H:%M:%S\"", &gm);
245 strftime(temp, sizeof temp, "__UTC_TIME_NUM__=%H%M%S", &gm);
250 posix_time = posix_mktime(&gm);
252 posix_time = posix_mktime(<);
257 snprintf(temp, sizeof temp, "__POSIX_TIME__=%"PRId64, posix_time);
262 static void define_macros_late(void)
266 snprintf(temp, sizeof(temp), "__OUTPUT_FORMAT__=%s\n",
271 static void emit_dependencies(StrList *list)
277 if (depend_file && strcmp(depend_file, "-")) {
278 deps = fopen(depend_file, "w");
280 report_error(ERR_NONFATAL|ERR_NOFILE|ERR_USAGE,
281 "unable to write dependency file `%s'", depend_file);
288 linepos = fprintf(deps, "%s:", depend_target);
289 for (l = list; l; l = l->next) {
290 len = strlen(l->str);
291 if (linepos + len > 62) {
292 fprintf(deps, " \\\n ");
295 fprintf(deps, " %s", l->str);
298 fprintf(deps, "\n\n");
300 for (l = list; l; l = nl) {
301 if (depend_emit_phony)
302 fprintf(deps, "%s:\n\n", l->str);
312 int main(int argc, char **argv)
314 StrList *depend_list = NULL, **depend_ptr;
316 time(&official_compile_time);
319 want_usage = terminate_after_phase = false;
320 report_error = report_error_gnu;
326 nasm_set_malloc_error(report_error);
327 offsets = raa_init();
328 forwrefs = saa_init((int32_t)sizeof(struct forwrefinfo));
331 operating_mode = op_normal;
335 register_output_formats();
337 /* Define some macros dependent on the runtime, but not
338 on the command line. */
339 define_macros_early();
341 parse_cmdline(argc, argv);
343 if (terminate_after_phase) {
349 /* If debugging info is disabled, suppress any debug calls */
350 if (!using_debug_info)
351 ofmt->current_dfmt = &null_debug_form;
354 pp_extra_stdmac(ofmt->stdmac);
355 parser_global_info(ofmt, &location);
356 eval_global_info(ofmt, lookup_label, &location);
358 /* define some macros dependent of command-line */
359 define_macros_late();
361 depend_ptr = (depend_file || (operating_mode == op_depend))
362 ? &depend_list : NULL;
364 depend_target = outname;
366 switch (operating_mode) {
371 if (depend_missing_ok)
372 pp_include_path(NULL); /* "assume generated" */
374 preproc->reset(inname, 0, report_error, evaluate, &nasmlist,
376 if (outname[0] == '\0')
377 ofmt->filename(inname, outname, report_error);
379 while ((line = preproc->getline()))
388 char *file_name = NULL;
389 int32_t prior_linnum = 0;
393 ofile = fopen(outname, "w");
395 report_error(ERR_FATAL | ERR_NOFILE,
396 "unable to open output file `%s'",
401 location.known = false;
404 preproc->reset(inname, 3, report_error, evaluate, &nasmlist,
407 while ((line = preproc->getline())) {
409 * We generate %line directives if needed for later programs
411 int32_t linnum = prior_linnum += lineinc;
412 int altline = src_get(&linnum, &file_name);
414 if (altline == 1 && lineinc == 1)
415 nasm_fputs("", ofile);
417 lineinc = (altline != -1 || lineinc != 1);
418 fprintf(ofile ? ofile : stdout,
419 "%%line %"PRId32"+%d %s\n", linnum, lineinc,
422 prior_linnum = linnum;
424 nasm_fputs(line, ofile);
427 nasm_free(file_name);
431 if (ofile && terminate_after_phase)
440 * We must call ofmt->filename _anyway_, even if the user
441 * has specified their own output file, because some
442 * formats (eg OBJ and COFF) use ofmt->filename to find out
443 * the name of the input file and then put that inside the
446 ofmt->filename(inname, outname, report_error);
448 ofile = fopen(outname, (ofmt->flags & OFMT_TEXT) ? "w" : "wb");
450 report_error(ERR_FATAL | ERR_NOFILE,
451 "unable to open output file `%s'", outname);
455 * We must call init_labels() before ofmt->init() since
456 * some object formats will want to define labels in their
457 * init routines. (eg OS/2 defines the FLAT group)
461 ofmt->init(ofile, report_error, define_label, evaluate);
462 ofmt->current_dfmt->init(ofmt, NULL, ofile, report_error);
464 assemble_file(inname, depend_ptr);
466 if (!terminate_after_phase) {
467 ofmt->cleanup(using_debug_info);
471 report_error(ERR_NONFATAL|ERR_NOFILE,
472 "write error on output file `%s'", outname);
477 if (ofile && terminate_after_phase)
484 if (depend_list && !terminate_after_phase)
485 emit_dependencies(depend_list);
495 return terminate_after_phase;
499 * Get a parameter for a command line option.
500 * First arg must be in the form of e.g. -f...
502 static char *get_param(char *p, char *q, bool *advance)
505 if (p[2]) { /* the parameter's in the option */
507 while (nasm_isspace(*p))
515 report_error(ERR_NONFATAL | ERR_NOFILE | ERR_USAGE,
516 "option `-%c' requires an argument", p[1]);
523 static void copy_filename(char *dst, const char *src)
525 size_t len = strlen(src);
527 if (len >= (size_t)FILENAME_MAX) {
528 report_error(ERR_FATAL | ERR_NOFILE, "file name too long");
531 strncpy(dst, src, FILENAME_MAX);
535 * Convert a string to Make-safe form
537 static char *quote_for_make(const char *str)
542 size_t n = 1; /* Terminating zero */
548 for (p = str; *p; p++) {
552 /* Convert N backslashes + ws -> 2N+1 backslashes + ws */
572 /* Convert N backslashes at the end of filename to 2N backslashes */
576 os = q = nasm_malloc(n);
579 for (p = str; *p; p++) {
622 #define OPT_POSTFIX 1
623 struct textargs textopts[] = {
624 {"prefix", OPT_PREFIX},
625 {"postfix", OPT_POSTFIX},
629 static bool stopoptions = false;
630 static bool process_arg(char *p, char *q)
634 bool advance = false;
640 if (p[0] == '-' && !stopoptions) {
641 if (strchr("oOfpPdDiIlFXuUZwW", p[1])) {
642 /* These parameters take values */
643 if (!(param = get_param(p, q, &advance)))
652 case 'o': /* output file */
653 copy_filename(outname, param);
656 case 'f': /* output format */
657 ofmt = ofmt_find(param);
659 report_error(ERR_FATAL | ERR_NOFILE | ERR_USAGE,
660 "unrecognised output format `%s' - "
661 "use -hf for a list", param);
665 case 'O': /* Optimization level */
670 /* Naked -O == -Ox */
671 optimizing = INT_MAX >> 1; /* Almost unlimited */
675 case '0': case '1': case '2': case '3': case '4':
676 case '5': case '6': case '7': case '8': case '9':
677 opt = strtoul(param, ¶m, 10);
679 /* -O0 -> optimizing == -1, 0.98 behaviour */
680 /* -O1 -> optimizing == 0, 0.98.09 behaviour */
682 optimizing = opt - 1;
690 opt_verbose_info = true;
695 optimizing = INT_MAX >> 1; /* Almost unlimited */
699 report_error(ERR_FATAL,
700 "unknown optimization option -O%c\n",
709 case 'p': /* pre-include */
711 pp_pre_include(param);
714 case 'd': /* pre-define */
716 pp_pre_define(param);
719 case 'u': /* un-define */
721 pp_pre_undefine(param);
724 case 'i': /* include search path */
726 pp_include_path(param);
729 case 'l': /* listing file */
730 copy_filename(listname, param);
733 case 'Z': /* error messages file */
734 strcpy(errname, param);
737 case 'F': /* specify debug format */
738 ofmt->current_dfmt = dfmt_find(ofmt, param);
739 if (!ofmt->current_dfmt) {
740 report_error(ERR_FATAL | ERR_NOFILE | ERR_USAGE,
741 "unrecognized debug format `%s' for"
742 " output format `%s'",
743 param, ofmt->shortname);
745 using_debug_info = true;
748 case 'X': /* specify error reporting format */
749 if (nasm_stricmp("vc", param) == 0)
750 report_error = report_error_vc;
751 else if (nasm_stricmp("gnu", param) == 0)
752 report_error = report_error_gnu;
754 report_error(ERR_FATAL | ERR_NOFILE | ERR_USAGE,
755 "unrecognized error reporting format `%s'",
760 using_debug_info = true;
765 ("usage: nasm [-@ response file] [-o outfile] [-f format] "
767 " [options...] [--] filename\n"
768 " or nasm -v for version info\n\n"
769 " -t assemble in SciTech TASM compatible mode\n"
770 " -g generate debug information in selected format.\n");
772 (" -E (or -e) preprocess only (writes output to stdout by default)\n"
773 " -a don't preprocess (assemble only)\n"
774 " -M generate Makefile dependencies on stdout\n"
775 " -MG d:o, missing files assumed generated\n\n"
776 " -Z<file> redirect error messages to file\n"
777 " -s redirect error messages to stdout\n\n"
778 " -F format select a debugging format\n\n"
779 " -I<path> adds a pathname to the include file path\n");
781 (" -O<digit> optimize branch offsets (-O0 disables, default)\n"
782 " -P<file> pre-includes a file\n"
783 " -D<macro>[=<value>] pre-defines a macro\n"
784 " -U<macro> undefines a macro\n"
785 " -X<format> specifies error reporting format (gnu or vc)\n"
786 " -w+foo enables warning foo (equiv. -Wfoo)\n"
787 " -w-foo disable warning foo (equiv. -Wno-foo)\n"
789 for (i = 0; i <= ERR_WARN_MAX; i++)
790 printf(" %-23s %s (default %s)\n",
791 warnings[i].name, warnings[i].help,
792 warnings[i].enabled ? "on" : "off");
794 ("\nresponse files should contain command line parameters"
795 ", one per line.\n");
797 printf("\nvalid output formats for -f are"
798 " (`*' denotes default):\n");
799 ofmt_list(ofmt, stdout);
801 printf("\nFor a list of valid output formats, use -hf.\n");
802 printf("For a list of debug formats, use -f <form> -y.\n");
804 exit(0); /* never need usage message here */
808 printf("\nvalid debug formats for '%s' output format are"
809 " ('*' denotes default):\n", ofmt->shortname);
810 dfmt_list(ofmt, stdout);
815 tasm_compatible_mode = true;
819 printf("NASM version %s compiled on %s%s\n",
820 nasm_version, nasm_date, nasm_compile_options);
821 exit(0); /* never need usage message here */
824 case 'e': /* preprocess only */
826 operating_mode = op_preprocess;
829 case 'a': /* assemble only - don't preprocess */
834 if (param[0] == 'n' && param[1] == 'o' && param[2] == '-') {
843 if (param[0] != '+' && param[0] != '-') {
844 report_error(ERR_NONFATAL | ERR_NOFILE | ERR_USAGE,
845 "invalid option to `-w'");
848 do_warn = (param[0] == '+');
852 for (i = 0; i <= ERR_WARN_MAX; i++)
853 if (!nasm_stricmp(param, warnings[i].name))
855 if (i <= ERR_WARN_MAX)
856 warning_on_global[i] = do_warn;
857 else if (!nasm_stricmp(param, "all"))
858 for (i = 1; i <= ERR_WARN_MAX; i++)
859 warning_on_global[i] = do_warn;
860 else if (!nasm_stricmp(param, "none"))
861 for (i = 1; i <= ERR_WARN_MAX; i++)
862 warning_on_global[i] = !do_warn;
864 report_error(ERR_NONFATAL | ERR_NOFILE | ERR_USAGE,
865 "invalid warning `%s'", param);
871 operating_mode = op_depend;
874 operating_mode = op_depend;
875 depend_missing_ok = true;
878 depend_emit_phony = true;
889 depend_target = quote_for_make(q);
893 report_error(ERR_NONFATAL|ERR_NOFILE|ERR_USAGE,
894 "unknown dependency option `-M%c'", p[2]);
897 if (advance && (!q || !q[0])) {
898 report_error(ERR_NONFATAL|ERR_NOFILE|ERR_USAGE,
899 "option `-M%c' requires a parameter", p[2]);
908 if (p[2] == 0) { /* -- => stop processing options */
912 for (s = 0; textopts[s].label; s++) {
913 if (!nasm_stricmp(p + 2, textopts[s].label)) {
924 report_error(ERR_NONFATAL | ERR_NOFILE |
926 "option `--%s' requires an argument",
930 advance = 1, param = q;
933 if (s == OPT_PREFIX) {
934 strncpy(lprefix, param, PREFIX_MAX - 1);
935 lprefix[PREFIX_MAX - 1] = 0;
938 if (s == OPT_POSTFIX) {
939 strncpy(lpostfix, param, POSTFIX_MAX - 1);
940 lpostfix[POSTFIX_MAX - 1] = 0;
947 report_error(ERR_NONFATAL | ERR_NOFILE | ERR_USAGE,
948 "unrecognised option `--%s'", p + 2);
956 if (!ofmt->setinfo(GI_SWITCH, &p))
957 report_error(ERR_NONFATAL | ERR_NOFILE | ERR_USAGE,
958 "unrecognised option `-%c'", p[1]);
963 report_error(ERR_NONFATAL | ERR_NOFILE | ERR_USAGE,
964 "more than one input file specified");
966 copy_filename(inname, p);
973 #define ARG_BUF_DELTA 128
975 static void process_respfile(FILE * rfile)
977 char *buffer, *p, *q, *prevarg;
978 int bufsize, prevargsize;
980 bufsize = prevargsize = ARG_BUF_DELTA;
981 buffer = nasm_malloc(ARG_BUF_DELTA);
982 prevarg = nasm_malloc(ARG_BUF_DELTA);
985 while (1) { /* Loop to handle all lines in file */
987 while (1) { /* Loop to handle long lines */
988 q = fgets(p, bufsize - (p - buffer), rfile);
992 if (p > buffer && p[-1] == '\n')
994 if (p - buffer > bufsize - 10) {
997 bufsize += ARG_BUF_DELTA;
998 buffer = nasm_realloc(buffer, bufsize);
1003 if (!q && p == buffer) {
1005 process_arg(prevarg, NULL);
1012 * Play safe: remove CRs, LFs and any spurious ^Zs, if any of
1013 * them are present at the end of the line.
1015 *(p = &buffer[strcspn(buffer, "\r\n\032")]) = '\0';
1017 while (p > buffer && nasm_isspace(p[-1]))
1021 while (nasm_isspace(*p))
1024 if (process_arg(prevarg, p))
1027 if ((int) strlen(p) > prevargsize - 10) {
1028 prevargsize += ARG_BUF_DELTA;
1029 prevarg = nasm_realloc(prevarg, prevargsize);
1031 strncpy(prevarg, p, prevargsize);
1035 /* Function to process args from a string of args, rather than the
1036 * argv array. Used by the environment variable and response file
1039 static void process_args(char *args)
1041 char *p, *q, *arg, *prevarg;
1042 char separator = ' ';
1045 if (*p && *p != '-')
1050 while (*p && *p != separator)
1052 while (*p == separator)
1056 if (process_arg(prevarg, arg))
1060 process_arg(arg, NULL);
1063 static void process_response_file(const char *file)
1066 FILE *f = fopen(file, "r");
1071 while (fgets(str, sizeof str, f)) {
1077 static void parse_cmdline(int argc, char **argv)
1080 char *envreal, *envcopy = NULL, *p, *arg;
1083 *inname = *outname = *listname = *errname = '\0';
1084 for (i = 0; i <= ERR_WARN_MAX; i++)
1085 warning_on_global[i] = warnings[i].enabled;
1088 * First, process the NASMENV environment variable.
1090 envreal = getenv("NASMENV");
1093 envcopy = nasm_strdup(envreal);
1094 process_args(envcopy);
1099 * Now process the actual command line.
1104 if (argv[0][0] == '@') {
1105 /* We have a response file, so process this as a set of
1106 * arguments like the environment variable. This allows us
1107 * to have multiple arguments on a single line, which is
1108 * different to the -@resp file processing below for regular
1111 process_response_file(argv[0]+1);
1115 if (!stopoptions && argv[0][0] == '-' && argv[0][1] == '@') {
1116 p = get_param(argv[0], argc > 1 ? argv[1] : NULL, &advance);
1118 rfile = fopen(p, "r");
1120 process_respfile(rfile);
1123 report_error(ERR_NONFATAL | ERR_NOFILE | ERR_USAGE,
1124 "unable to open response file `%s'", p);
1127 advance = process_arg(argv[0], argc > 1 ? argv[1] : NULL);
1128 argv += advance, argc -= advance;
1131 /* Look for basic command line typos. This definitely doesn't
1132 catch all errors, but it might help cases of fumbled fingers. */
1134 report_error(ERR_NONFATAL | ERR_NOFILE | ERR_USAGE,
1135 "no input file specified");
1136 else if (!strcmp(inname, errname) ||
1137 !strcmp(inname, outname) ||
1138 !strcmp(inname, listname) ||
1139 (depend_file && !strcmp(inname, depend_file)))
1140 report_error(ERR_FATAL | ERR_NOFILE | ERR_USAGE,
1141 "file `%s' is both input and output file",
1145 error_file = fopen(errname, "w");
1147 error_file = stderr; /* Revert to default! */
1148 report_error(ERR_FATAL | ERR_NOFILE | ERR_USAGE,
1149 "cannot open file `%s' for error messages",
1155 static enum directives getkw(char **directive, char **value);
1157 static void assemble_file(char *fname, StrList **depend_ptr)
1159 char *directive, *value, *p, *q, *special, *line, debugid[80];
1165 struct tokenval tokval;
1169 if (cmd_sb == 32 && cmd_cpu < IF_386)
1170 report_error(ERR_FATAL, "command line: "
1171 "32-bit segment size requires a higher cpu");
1173 pass_max = prev_offset_changed = (INT_MAX >> 1) + 2; /* Almost unlimited */
1174 for (passn = 1; pass0 <= 2; passn++) {
1178 pass1 = pass0 == 2 ? 2 : 1; /* 1, 1, 1, ..., 1, 2 */
1179 pass2 = passn > 1 ? 2 : 1; /* 1, 2, 2, ..., 2, 2 */
1180 /* pass0 0, 0, 0, ..., 1, 2 */
1182 def_label = passn > 1 ? redefine_label : define_label;
1184 globalbits = sb = cmd_sb; /* set 'bits' to command line default */
1188 nasmlist.init(listname, report_error);
1191 global_offset_changed = 0; /* set by redefine_label */
1192 location.segment = ofmt->section(NULL, pass2, &sb);
1195 saa_rewind(forwrefs);
1196 forwref = saa_rstruct(forwrefs);
1198 offsets = raa_init();
1200 preproc->reset(fname, pass1, report_error, evaluate, &nasmlist,
1201 pass1 == 2 ? depend_ptr : NULL);
1202 memcpy(warning_on, warning_on_global, (ERR_WARN_MAX+1) * sizeof(bool));
1206 location.known = true;
1207 location.offset = offs = GET_CURR_OFFS;
1209 while ((line = preproc->getline())) {
1214 * Here we parse our directives; this is not handled by the
1215 * 'real' parser. This really should be a separate function.
1218 d = getkw(&directive, &value);
1223 case D_SEGMENT: /* [SEGMENT n] */
1225 seg = ofmt->section(value, pass2, &sb);
1226 if (seg == NO_SEG) {
1227 report_error(pass1 == 1 ? ERR_NONFATAL : ERR_PANIC,
1228 "segment name `%s' not recognized",
1232 location.segment = seg;
1235 case D_EXTERN: /* [EXTERN label:special] */
1237 value++; /* skip initial $ if present */
1240 while (*q && *q != ':')
1244 ofmt->symdef(value, 0L, 0L, 3, q);
1246 } else if (passn == 1) {
1251 while (*q && *q != ':') {
1257 report_error(ERR_NONFATAL,
1258 "identifier expected after EXTERN");
1266 if (!is_extern(value)) { /* allow re-EXTERN to be ignored */
1268 pass0 = 1; /* fake pass 1 in labels.c */
1269 declare_as_global(value, special,
1271 define_label(value, seg_alloc(), 0L, NULL,
1272 false, true, ofmt, report_error);
1275 } /* else pass0 == 1 */
1277 case D_BITS: /* [BITS bits] */
1278 globalbits = sb = get_bits(value);
1280 case D_GLOBAL: /* [GLOBAL symbol:special] */
1282 value++; /* skip initial $ if present */
1283 if (pass0 == 2) { /* pass 2 */
1285 while (*q && *q != ':')
1289 ofmt->symdef(value, 0L, 0L, 3, q);
1291 } else if (pass2 == 1) { /* pass == 1 */
1296 while (*q && *q != ':') {
1302 report_error(ERR_NONFATAL,
1303 "identifier expected after GLOBAL");
1311 declare_as_global(value, special, report_error);
1314 case D_COMMON: /* [COMMON symbol size:special] */
1319 value++; /* skip initial $ if present */
1324 while (*p && !nasm_isspace(*p)) {
1330 report_error(ERR_NONFATAL,
1331 "identifier expected after COMMON");
1335 while (*p && nasm_isspace(*p))
1338 while (*q && *q != ':')
1346 size = readnum(p, &rn_error);
1348 report_error(ERR_NONFATAL,
1349 "invalid size specified"
1350 " in COMMON declaration");
1354 report_error(ERR_NONFATAL,
1355 "no size specified in"
1356 " COMMON declaration");
1361 define_common(value, seg_alloc(), size,
1362 special, ofmt, report_error);
1363 } else if (pass0 == 2) {
1364 ofmt->symdef(value, 0L, 0L, 3, special);
1368 case D_ABSOLUTE: /* [ABSOLUTE address] */
1370 stdscan_bufptr = value;
1371 tokval.t_type = TOKEN_INVALID;
1372 e = evaluate(stdscan, NULL, &tokval, NULL, pass2,
1373 report_error, NULL);
1376 report_error(pass0 ==
1377 1 ? ERR_NONFATAL : ERR_PANIC,
1378 "cannot use non-relocatable expression as "
1379 "ABSOLUTE address");
1381 abs_seg = reloc_seg(e);
1382 abs_offset = reloc_value(e);
1384 } else if (passn == 1)
1385 abs_offset = 0x100; /* don't go near zero in case of / */
1387 report_error(ERR_PANIC, "invalid ABSOLUTE address "
1390 location.segment = NO_SEG;
1392 case D_DEBUG: /* [DEBUG] */
1398 while (*p && !nasm_isspace(*p)) {
1405 report_error(passn == 1 ? ERR_NONFATAL : ERR_PANIC,
1406 "identifier expected after DEBUG");
1409 while (*p && nasm_isspace(*p))
1412 ofmt->current_dfmt->debug_directive(debugid, p);
1414 case D_WARNING: /* [WARNING {+|-|*}warn-name] */
1415 while (*value && nasm_isspace(*value))
1419 case '-': validid = 0; value++; break;
1420 case '+': validid = 1; value++; break;
1421 case '*': validid = 2; value++; break;
1422 default: validid = 1; break;
1425 for (i = 1; i <= ERR_WARN_MAX; i++)
1426 if (!nasm_stricmp(value, warnings[i].name))
1428 if (i <= ERR_WARN_MAX) {
1431 warning_on[i] = false;
1434 warning_on[i] = true;
1437 warning_on[i] = warning_on_global[i];
1442 report_error(ERR_NONFATAL,
1443 "invalid warning id in WARNING directive");
1445 case D_CPU: /* [CPU] */
1446 cpu = get_cpu(value);
1448 case D_LIST: /* [LIST {+|-}] */
1449 while (*value && nasm_isspace(*value))
1452 if (*value == '+') {
1455 if (*value == '-') {
1462 case D_DEFAULT: /* [DEFAULT] */
1464 stdscan_bufptr = value;
1465 tokval.t_type = TOKEN_INVALID;
1466 if (stdscan(NULL, &tokval) == TOKEN_SPECIAL) {
1467 switch ((int)tokval.t_integer) {
1483 if (float_option(value)) {
1484 report_error(pass1 == 1 ? ERR_NONFATAL : ERR_PANIC,
1485 "unknown 'float' directive: %s",
1490 if (!d || !ofmt->directive(d, value, pass2))
1491 report_error(pass1 == 1 ? ERR_NONFATAL : ERR_PANIC,
1492 "unrecognised directive [%s]",
1497 report_error(ERR_NONFATAL,
1498 "invalid parameter to [%s] directive",
1501 } else { /* it isn't a directive */
1503 parse_line(pass1, line, &output_ins,
1504 report_error, evaluate, def_label);
1506 if (optimizing > 0) {
1507 if (forwref != NULL && globallineno == forwref->lineno) {
1508 output_ins.forw_ref = true;
1510 output_ins.oprs[forwref->operand].opflags |=
1512 forwref = saa_rstruct(forwrefs);
1513 } while (forwref != NULL
1514 && forwref->lineno == globallineno);
1516 output_ins.forw_ref = false;
1518 if (output_ins.forw_ref) {
1520 for (i = 0; i < output_ins.operands; i++) {
1521 if (output_ins.oprs[i].
1522 opflags & OPFLAG_FORWARD) {
1523 struct forwrefinfo *fwinf =
1524 (struct forwrefinfo *)
1525 saa_wstruct(forwrefs);
1526 fwinf->lineno = globallineno;
1535 if (output_ins.opcode == I_EQU) {
1538 * Special `..' EQUs get processed in pass two,
1539 * except `..@' macro-processor EQUs which are done
1540 * in the normal place.
1542 if (!output_ins.label)
1543 report_error(ERR_NONFATAL,
1544 "EQU not preceded by label");
1546 else if (output_ins.label[0] != '.' ||
1547 output_ins.label[1] != '.' ||
1548 output_ins.label[2] == '@') {
1549 if (output_ins.operands == 1 &&
1550 (output_ins.oprs[0].type & IMMEDIATE) &&
1551 output_ins.oprs[0].wrt == NO_SEG) {
1552 bool isext = !!(output_ins.oprs[0].opflags
1554 def_label(output_ins.label,
1555 output_ins.oprs[0].segment,
1556 output_ins.oprs[0].offset, NULL,
1559 } else if (output_ins.operands == 2
1560 && (output_ins.oprs[0].type & IMMEDIATE)
1561 && (output_ins.oprs[0].type & COLON)
1562 && output_ins.oprs[0].segment == NO_SEG
1563 && output_ins.oprs[0].wrt == NO_SEG
1564 && (output_ins.oprs[1].type & IMMEDIATE)
1565 && output_ins.oprs[1].segment == NO_SEG
1566 && output_ins.oprs[1].wrt == NO_SEG) {
1567 def_label(output_ins.label,
1568 output_ins.oprs[0].offset | SEG_ABS,
1569 output_ins.oprs[1].offset,
1570 NULL, false, false, ofmt,
1573 report_error(ERR_NONFATAL,
1574 "bad syntax for EQU");
1578 * Special `..' EQUs get processed here, except
1579 * `..@' macro processor EQUs which are done above.
1581 if (output_ins.label[0] == '.' &&
1582 output_ins.label[1] == '.' &&
1583 output_ins.label[2] != '@') {
1584 if (output_ins.operands == 1 &&
1585 (output_ins.oprs[0].type & IMMEDIATE)) {
1586 define_label(output_ins.label,
1587 output_ins.oprs[0].segment,
1588 output_ins.oprs[0].offset,
1589 NULL, false, false, ofmt,
1591 } else if (output_ins.operands == 2
1592 && (output_ins.oprs[0].
1594 && (output_ins.oprs[0].type & COLON)
1595 && output_ins.oprs[0].segment ==
1597 && (output_ins.oprs[1].
1599 && output_ins.oprs[1].segment ==
1601 define_label(output_ins.label,
1604 output_ins.oprs[1].offset,
1605 NULL, false, false, ofmt,
1608 report_error(ERR_NONFATAL,
1609 "bad syntax for EQU");
1612 } else { /* instruction isn't an EQU */
1616 int64_t l = insn_size(location.segment, offs, sb, cpu,
1617 &output_ins, report_error);
1619 /* if (using_debug_info) && output_ins.opcode != -1) */
1620 if (using_debug_info)
1621 { /* fbk 03/25/01 */
1622 /* this is done here so we can do debug type info */
1624 TYS_ELEMENTS(output_ins.operands);
1625 switch (output_ins.opcode) {
1628 TYS_ELEMENTS(output_ins.oprs[0].
1633 TYS_ELEMENTS(output_ins.oprs[0].
1638 TYS_ELEMENTS(output_ins.oprs[0].
1643 TYS_ELEMENTS(output_ins.oprs[0].
1648 TYS_ELEMENTS(output_ins.oprs[0].
1653 TYS_ELEMENTS(output_ins.oprs[0].
1658 TYS_ELEMENTS(output_ins.oprs[0].
1662 typeinfo |= TY_BYTE;
1665 typeinfo |= TY_WORD;
1668 if (output_ins.eops_float)
1669 typeinfo |= TY_FLOAT;
1671 typeinfo |= TY_DWORD;
1674 typeinfo |= TY_QWORD;
1677 typeinfo |= TY_TBYTE;
1680 typeinfo |= TY_OWORD;
1683 typeinfo |= TY_YWORD;
1686 typeinfo = TY_LABEL;
1690 ofmt->current_dfmt->debug_typevalue(typeinfo);
1695 SET_CURR_OFFS(offs);
1698 * else l == -1 => invalid instruction, which will be
1699 * flagged as an error on pass 2
1703 offs += assemble(location.segment, offs, sb, cpu,
1704 &output_ins, ofmt, report_error,
1706 SET_CURR_OFFS(offs);
1710 cleanup_insn(&output_ins);
1713 location.offset = offs = GET_CURR_OFFS;
1714 } /* end while (line = preproc->getline... */
1716 if (pass0 == 2 && global_offset_changed && !terminate_after_phase)
1717 report_error(ERR_NONFATAL,
1718 "phase error detected at end of assembly.");
1721 preproc->cleanup(1);
1723 if ((passn > 1 && !global_offset_changed) || pass0 == 2) {
1725 } else if (global_offset_changed &&
1726 global_offset_changed < prev_offset_changed) {
1727 prev_offset_changed = global_offset_changed;
1733 if (terminate_after_phase)
1736 if ((stall_count > 997) || (passn >= pass_max)) {
1737 /* We get here if the labels don't converge
1738 * Example: FOO equ FOO + 1
1740 report_error(ERR_NONFATAL,
1741 "Can't find valid values for all labels "
1742 "after %d passes, giving up.", passn);
1743 report_error(ERR_NONFATAL,
1744 "Possible causes: recursive EQUs, macro abuse.");
1749 preproc->cleanup(0);
1751 if (!terminate_after_phase && opt_verbose_info) {
1752 /* -On and -Ov switches */
1753 fprintf(stdout, "info: assembly required 1+%d+1 passes\n", passn-3);
1757 static enum directives getkw(char **directive, char **value)
1763 /* allow leading spaces or tabs */
1764 while (*buf == ' ' || *buf == '\t')
1772 while (*p && *p != ']')
1780 while (*p && *p != ';') {
1781 if (!nasm_isspace(*p))
1787 *directive = p = buf + 1;
1788 while (*buf && *buf != ' ' && *buf != ']' && *buf != '\t')
1795 while (nasm_isspace(*buf))
1796 buf++; /* beppu - skip leading whitespace */
1803 return find_directive(*directive);
1807 * gnu style error reporting
1808 * This function prints an error message to error_file in the
1809 * style used by GNU. An example would be:
1810 * file.asm:50: error: blah blah blah
1811 * where file.asm is the name of the file, 50 is the line number on
1812 * which the error occurs (or is detected) and "error:" is one of
1813 * the possible optional diagnostics -- it can be "error" or "warning"
1814 * or something else. Finally the line terminates with the actual
1817 * @param severity the severity of the warning or error
1818 * @param fmt the printf style format string
1820 static void report_error_gnu(int severity, const char *fmt, ...)
1823 char *currentfile = NULL;
1826 if (is_suppressed_warning(severity))
1829 if (!(severity & ERR_NOFILE))
1830 src_get(&lineno, ¤tfile);
1833 fprintf(error_file, "%s:%"PRId32": ", currentfile, lineno);
1834 nasm_free(currentfile);
1836 fputs("nasm: ", error_file);
1840 report_error_common(severity, fmt, ap);
1845 * MS style error reporting
1846 * This function prints an error message to error_file in the
1847 * style used by Visual C and some other Microsoft tools. An example
1849 * file.asm(50) : error: blah blah blah
1850 * where file.asm is the name of the file, 50 is the line number on
1851 * which the error occurs (or is detected) and "error:" is one of
1852 * the possible optional diagnostics -- it can be "error" or "warning"
1853 * or something else. Finally the line terminates with the actual
1856 * @param severity the severity of the warning or error
1857 * @param fmt the printf style format string
1859 static void report_error_vc(int severity, const char *fmt, ...)
1862 char *currentfile = NULL;
1865 if (is_suppressed_warning(severity))
1868 if (!(severity & ERR_NOFILE))
1869 src_get(&lineno, ¤tfile);
1872 fprintf(error_file, "%s(%"PRId32") : ", currentfile, lineno);
1873 nasm_free(currentfile);
1875 fputs("nasm: ", error_file);
1879 report_error_common(severity, fmt, ap);
1884 * check for supressed warning
1885 * checks for suppressed warning or pass one only warning and we're
1888 * @param severity the severity of the warning or error
1889 * @return true if we should abort error/warning printing
1891 static bool is_suppressed_warning(int severity)
1894 * See if it's a suppressed warning.
1896 return (severity & ERR_MASK) == ERR_WARNING &&
1897 (((severity & ERR_WARN_MASK) != 0 &&
1898 !warning_on[(severity & ERR_WARN_MASK) >> ERR_WARN_SHR]) ||
1899 /* See if it's a pass-one only warning and we're not in pass one. */
1900 ((severity & ERR_PASS1) && pass0 != 1) ||
1901 ((severity & ERR_PASS2) && pass0 != 2));
1905 * common error reporting
1906 * This is the common back end of the error reporting schemes currently
1907 * implemented. It prints the nature of the warning and then the
1908 * specific error message to error_file and may or may not return. It
1909 * doesn't return if the error severity is a "panic" or "debug" type.
1911 * @param severity the severity of the warning or error
1912 * @param fmt the printf style format string
1914 static void report_error_common(int severity, const char *fmt,
1920 switch (severity & (ERR_MASK|ERR_NO_SEVERITY)) {
1941 vsnprintf(msg, sizeof msg, fmt, args);
1943 fprintf(error_file, "%s%s\n", pfx, msg);
1946 nasmlist.error(severity, pfx, msg);
1948 if (severity & ERR_USAGE)
1951 switch (severity & ERR_MASK) {
1953 /* no further action, by definition */
1956 if (warning_on[0]) /* Treat warnings as errors */
1957 terminate_after_phase = true;
1960 terminate_after_phase = true;
1970 exit(1); /* instantly die */
1971 break; /* placate silly compilers */
1974 /* abort(); *//* halt, catch fire, and dump core */
1980 static void usage(void)
1982 fputs("type `nasm -h' for help\n", error_file);
1985 static void register_output_formats(void)
1987 ofmt = ofmt_register(report_error);
1990 #define BUF_DELTA 512
1992 static FILE *no_pp_fp;
1993 static efunc no_pp_err;
1994 static ListGen *no_pp_list;
1995 static int32_t no_pp_lineinc;
1997 static void no_pp_reset(char *file, int pass, efunc error, evalfunc eval,
1998 ListGen * listgen, StrList **deplist)
2000 src_set_fname(nasm_strdup(file));
2004 no_pp_fp = fopen(file, "r");
2006 no_pp_err(ERR_FATAL | ERR_NOFILE,
2007 "unable to open input file `%s'", file);
2008 no_pp_list = listgen;
2009 (void)pass; /* placate compilers */
2010 (void)eval; /* placate compilers */
2013 StrList *sl = nasm_malloc(strlen(file)+1+sizeof sl->next);
2015 strcpy(sl->str, file);
2020 static char *no_pp_getline(void)
2022 char *buffer, *p, *q;
2025 bufsize = BUF_DELTA;
2026 buffer = nasm_malloc(BUF_DELTA);
2027 src_set_linnum(src_get_linnum() + no_pp_lineinc);
2029 while (1) { /* Loop to handle %line */
2032 while (1) { /* Loop to handle long lines */
2033 q = fgets(p, bufsize - (p - buffer), no_pp_fp);
2037 if (p > buffer && p[-1] == '\n')
2039 if (p - buffer > bufsize - 10) {
2041 offset = p - buffer;
2042 bufsize += BUF_DELTA;
2043 buffer = nasm_realloc(buffer, bufsize);
2044 p = buffer + offset;
2048 if (!q && p == buffer) {
2054 * Play safe: remove CRs, LFs and any spurious ^Zs, if any of
2055 * them are present at the end of the line.
2057 buffer[strcspn(buffer, "\r\n\032")] = '\0';
2059 if (!nasm_strnicmp(buffer, "%line", 5)) {
2062 char *nm = nasm_malloc(strlen(buffer));
2063 if (sscanf(buffer + 5, "%"PRId32"+%d %s", &ln, &li, nm) == 3) {
2064 nasm_free(src_set_fname(nm));
2074 no_pp_list->line(LIST_READ, buffer);
2079 static void no_pp_cleanup(int pass)
2081 (void)pass; /* placate GCC */
2085 static uint32_t get_cpu(char *value)
2087 if (!strcmp(value, "8086"))
2089 if (!strcmp(value, "186"))
2091 if (!strcmp(value, "286"))
2093 if (!strcmp(value, "386"))
2095 if (!strcmp(value, "486"))
2097 if (!strcmp(value, "586") || !nasm_stricmp(value, "pentium"))
2099 if (!strcmp(value, "686") ||
2100 !nasm_stricmp(value, "ppro") ||
2101 !nasm_stricmp(value, "pentiumpro") || !nasm_stricmp(value, "p2"))
2103 if (!nasm_stricmp(value, "p3") || !nasm_stricmp(value, "katmai"))
2105 if (!nasm_stricmp(value, "p4") || /* is this right? -- jrc */
2106 !nasm_stricmp(value, "willamette"))
2107 return IF_WILLAMETTE;
2108 if (!nasm_stricmp(value, "prescott"))
2110 if (!nasm_stricmp(value, "x64") ||
2111 !nasm_stricmp(value, "x86-64"))
2113 if (!nasm_stricmp(value, "ia64") ||
2114 !nasm_stricmp(value, "ia-64") ||
2115 !nasm_stricmp(value, "itanium") ||
2116 !nasm_stricmp(value, "itanic") || !nasm_stricmp(value, "merced"))
2119 report_error(pass0 < 2 ? ERR_NONFATAL : ERR_FATAL,
2120 "unknown 'cpu' type");
2122 return IF_PLEVEL; /* the maximum level */
2125 static int get_bits(char *value)
2129 if ((i = atoi(value)) == 16)
2130 return i; /* set for a 16-bit segment */
2133 report_error(ERR_NONFATAL,
2134 "cannot specify 32-bit segment on processor below a 386");
2137 } else if (i == 64) {
2138 if (cpu < IF_X86_64) {
2139 report_error(ERR_NONFATAL,
2140 "cannot specify 64-bit segment on processor below an x86-64");
2144 report_error(ERR_NONFATAL,
2145 "%s output format does not support 64-bit code",
2150 report_error(pass0 < 2 ? ERR_NONFATAL : ERR_FATAL,
2151 "`%s' is not a valid segment size; must be 16, 32 or 64",