1 /* ----------------------------------------------------------------------- *
3 * Copyright 1996-2013 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"
65 * This is the maximum number of optimization passes to do. If we ever
66 * find a case where the optimizer doesn't naturally converge, we might
67 * have to drop this value so the assembler doesn't appear to just hang.
69 #define MAX_OPTIMIZE (INT_MAX >> 1)
71 struct forwrefinfo { /* info held on forward refs. */
76 static int get_bits(char *value);
77 static uint32_t get_cpu(char *cpu_str);
78 static void parse_cmdline(int, char **);
79 static void assemble_file(char *, StrList **);
80 static void nasm_verror_gnu(int severity, const char *fmt, va_list args);
81 static void nasm_verror_vc(int severity, const char *fmt, va_list args);
82 static void nasm_verror_common(int severity, const char *fmt, va_list args);
83 static bool is_suppressed_warning(int severity);
84 static void usage(void);
86 static int using_debug_info, opt_verbose_info;
87 bool tasm_compatible_mode = false;
92 static time_t official_compile_time;
94 static char inname[FILENAME_MAX];
95 static char outname[FILENAME_MAX];
96 static char listname[FILENAME_MAX];
97 static char errname[FILENAME_MAX];
98 static int globallineno; /* for forward-reference tracking */
99 /* static int pass = 0; */
100 struct ofmt *ofmt = &OF_DEFAULT;
101 struct ofmt_alias *ofmt_alias = NULL;
102 const struct dfmt *dfmt;
104 static FILE *error_file; /* Where to write error messages */
107 int optimizing = MAX_OPTIMIZE; /* number of optimization passes to take */
108 static int sb, cmd_sb = 16; /* by default */
109 static uint32_t cmd_cpu = IF_PLEVEL; /* highest level by default */
110 static uint32_t cpu = IF_PLEVEL; /* passed to insn_size & assemble.c */
111 int64_t global_offset_changed; /* referenced in labels.c */
112 int64_t prev_offset_changed;
115 static struct location location;
116 int in_abs_seg; /* Flag we are in ABSOLUTE seg */
117 int32_t abs_seg; /* ABSOLUTE segment basis */
118 int32_t abs_offset; /* ABSOLUTE offset */
120 static struct RAA *offsets;
122 static struct SAA *forwrefs; /* keep track of forward references */
123 static const struct forwrefinfo *forwref;
125 static struct preproc_ops *preproc;
128 op_normal, /* Preprocess and assemble */
129 op_preprocess, /* Preprocess only */
130 op_depend, /* Generate dependencies */
132 static enum op_type operating_mode;
133 /* Dependency flags */
134 static bool depend_emit_phony = false;
135 static bool depend_missing_ok = false;
136 static const char *depend_target = NULL;
137 static const char *depend_file = NULL;
140 * Which of the suppressible warnings are suppressed. Entry zero
141 * isn't an actual warning, but it used for -w+error/-Werror.
144 static bool warning_on[ERR_WARN_MAX+1]; /* Current state */
145 static bool warning_on_global[ERR_WARN_MAX+1]; /* Command-line state */
147 static const struct warning {
151 } warnings[ERR_WARN_MAX+1] = {
152 {"error", "treat warnings as errors", false},
153 {"macro-params", "macro calls with wrong parameter count", true},
154 {"macro-selfref", "cyclic macro references", false},
155 {"macro-defaults", "macros with more default than optional parameters", true},
156 {"orphan-labels", "labels alone on lines without trailing `:'", true},
157 {"number-overflow", "numeric constant does not fit", true},
158 {"gnu-elf-extensions", "using 8- or 16-bit relocation in ELF32, a GNU extension", false},
159 {"float-overflow", "floating point overflow", true},
160 {"float-denorm", "floating point denormal", false},
161 {"float-underflow", "floating point underflow", false},
162 {"float-toolong", "too many digits in floating-point number", true},
163 {"user", "%warning directives", true},
164 {"lock", "lock prefix on unlockable instructions", true},
165 {"hle", "invalid hle prefixes", true},
168 static bool want_usage;
169 static bool terminate_after_phase;
170 int user_nolist = 0; /* fbk 9/2/00 */
172 static char *quote_for_make(const char *str);
174 static int64_t get_curr_offs(void)
176 return in_abs_seg ? abs_offset : raa_read(offsets, location.segment);
179 static void set_curr_offs(int64_t l_off)
184 offsets = raa_write(offsets, location.segment, l_off);
187 static void nasm_fputs(const char *line, FILE * outfile)
190 fputs(line, outfile);
196 /* Convert a struct tm to a POSIX-style time constant */
197 static int64_t posix_mktime(struct tm *tm)
200 int64_t y = tm->tm_year;
202 /* See IEEE 1003.1:2004, section 4.14 */
204 t = (y-70)*365 + (y-69)/4 - (y-1)/100 + (y+299)/400;
216 static void define_macros_early(void)
219 struct tm lt, *lt_p, gm, *gm_p;
222 lt_p = localtime(&official_compile_time);
226 strftime(temp, sizeof temp, "__DATE__=\"%Y-%m-%d\"", <);
227 preproc->pre_define(temp);
228 strftime(temp, sizeof temp, "__DATE_NUM__=%Y%m%d", <);
229 preproc->pre_define(temp);
230 strftime(temp, sizeof temp, "__TIME__=\"%H:%M:%S\"", <);
231 preproc->pre_define(temp);
232 strftime(temp, sizeof temp, "__TIME_NUM__=%H%M%S", <);
233 preproc->pre_define(temp);
236 gm_p = gmtime(&official_compile_time);
240 strftime(temp, sizeof temp, "__UTC_DATE__=\"%Y-%m-%d\"", &gm);
241 preproc->pre_define(temp);
242 strftime(temp, sizeof temp, "__UTC_DATE_NUM__=%Y%m%d", &gm);
243 preproc->pre_define(temp);
244 strftime(temp, sizeof temp, "__UTC_TIME__=\"%H:%M:%S\"", &gm);
245 preproc->pre_define(temp);
246 strftime(temp, sizeof temp, "__UTC_TIME_NUM__=%H%M%S", &gm);
247 preproc->pre_define(temp);
251 posix_time = posix_mktime(&gm);
253 posix_time = posix_mktime(<);
258 snprintf(temp, sizeof temp, "__POSIX_TIME__=%"PRId64, posix_time);
259 preproc->pre_define(temp);
263 static void define_macros_late(void)
268 * In case if output format is defined by alias
269 * we have to put shortname of the alias itself here
270 * otherwise ABI backward compatibility gets broken.
272 snprintf(temp, sizeof(temp), "__OUTPUT_FORMAT__=%s",
273 ofmt_alias ? ofmt_alias->shortname : ofmt->shortname);
274 preproc->pre_define(temp);
277 static void emit_dependencies(StrList *list)
283 if (depend_file && strcmp(depend_file, "-")) {
284 deps = fopen(depend_file, "w");
286 nasm_error(ERR_NONFATAL|ERR_NOFILE|ERR_USAGE,
287 "unable to write dependency file `%s'", depend_file);
294 linepos = fprintf(deps, "%s:", depend_target);
295 list_for_each(l, list) {
296 char *file = quote_for_make(l->str);
298 if (linepos + len > 62 && linepos > 1) {
299 fprintf(deps, " \\\n ");
302 fprintf(deps, " %s", file);
306 fprintf(deps, "\n\n");
308 list_for_each_safe(l, nl, list) {
309 if (depend_emit_phony)
310 fprintf(deps, "%s:\n\n", l->str);
318 int main(int argc, char **argv)
320 StrList *depend_list = NULL, **depend_ptr;
322 time(&official_compile_time);
325 want_usage = terminate_after_phase = false;
326 nasm_set_verror(nasm_verror_gnu);
332 nasm_init_malloc_error();
333 offsets = raa_init();
334 forwrefs = saa_init((int32_t)sizeof(struct forwrefinfo));
337 operating_mode = op_normal;
341 /* Define some macros dependent on the runtime, but not
342 on the command line. */
343 define_macros_early();
345 parse_cmdline(argc, argv);
347 if (terminate_after_phase) {
353 /* If debugging info is disabled, suppress any debug calls */
354 if (!using_debug_info)
355 ofmt->current_dfmt = &null_debug_form;
358 preproc->extra_stdmac(ofmt->stdmac);
359 parser_global_info(&location);
360 eval_global_info(ofmt, lookup_label, &location);
362 /* define some macros dependent of command-line */
363 define_macros_late();
365 depend_ptr = (depend_file || (operating_mode == op_depend)) ? &depend_list : NULL;
367 depend_target = quote_for_make(outname);
369 switch (operating_mode) {
374 if (depend_missing_ok)
375 preproc->include_path(NULL); /* "assume generated" */
377 preproc->reset(inname, 0, &nasmlist, depend_ptr);
378 if (outname[0] == '\0')
379 ofmt->filename(inname, outname);
381 while ((line = preproc->getline()))
390 char *file_name = NULL;
391 int32_t prior_linnum = 0;
395 ofile = fopen(outname, "w");
397 nasm_error(ERR_FATAL | ERR_NOFILE,
398 "unable to open output file `%s'",
403 location.known = false;
406 preproc->reset(inname, 3, &nasmlist, depend_ptr);
407 memcpy(warning_on, warning_on_global, (ERR_WARN_MAX+1) * sizeof(bool));
409 while ((line = preproc->getline())) {
411 * We generate %line directives if needed for later programs
413 int32_t linnum = prior_linnum += lineinc;
414 int altline = src_get(&linnum, &file_name);
416 if (altline == 1 && lineinc == 1)
417 nasm_fputs("", ofile);
419 lineinc = (altline != -1 || lineinc != 1);
420 fprintf(ofile ? ofile : stdout,
421 "%%line %"PRId32"+%d %s\n", linnum, lineinc,
424 prior_linnum = linnum;
426 nasm_fputs(line, ofile);
429 nasm_free(file_name);
433 if (ofile && terminate_after_phase)
442 * We must call ofmt->filename _anyway_, even if the user
443 * has specified their own output file, because some
444 * formats (eg OBJ and COFF) use ofmt->filename to find out
445 * the name of the input file and then put that inside the
448 ofmt->filename(inname, outname);
450 ofile = fopen(outname, (ofmt->flags & OFMT_TEXT) ? "w" : "wb");
452 nasm_error(ERR_FATAL | ERR_NOFILE,
453 "unable to open output file `%s'", outname);
457 * We must call init_labels() before ofmt->init() since
458 * some object formats will want to define labels in their
459 * init routines. (eg OS/2 defines the FLAT group)
464 dfmt = ofmt->current_dfmt;
467 assemble_file(inname, depend_ptr);
469 if (!terminate_after_phase) {
470 ofmt->cleanup(using_debug_info);
474 nasm_error(ERR_NONFATAL|ERR_NOFILE,
475 "write error on output file `%s'", outname);
481 if (terminate_after_phase)
489 if (depend_list && !terminate_after_phase)
490 emit_dependencies(depend_list);
500 return terminate_after_phase;
504 * Get a parameter for a command line option.
505 * First arg must be in the form of e.g. -f...
507 static char *get_param(char *p, char *q, bool *advance)
510 if (p[2]) /* the parameter's in the option */
511 return nasm_skip_spaces(p + 2);
516 nasm_error(ERR_NONFATAL | ERR_NOFILE | ERR_USAGE,
517 "option `-%c' requires an argument", p[1]);
524 static void copy_filename(char *dst, const char *src)
526 size_t len = strlen(src);
528 if (len >= (size_t)FILENAME_MAX) {
529 nasm_error(ERR_FATAL | ERR_NOFILE, "file name too long");
532 strncpy(dst, src, FILENAME_MAX);
536 * Convert a string to Make-safe form
538 static char *quote_for_make(const char *str)
543 size_t n = 1; /* Terminating zero */
549 for (p = str; *p; p++) {
553 /* Convert N backslashes + ws -> 2N+1 backslashes + ws */
573 /* Convert N backslashes at the end of filename to 2N backslashes */
577 os = q = nasm_malloc(n);
580 for (p = str; *p; p++) {
623 #define OPT_POSTFIX 1
624 struct textargs textopts[] = {
625 {"prefix", OPT_PREFIX},
626 {"postfix", OPT_POSTFIX},
630 static bool stopoptions = false;
631 static bool process_arg(char *p, char *q)
635 bool advance = false;
641 if (p[0] == '-' && !stopoptions) {
642 if (strchr("oOfpPdDiIlFXuUZwW", p[1])) {
643 /* These parameters take values */
644 if (!(param = get_param(p, q, &advance)))
653 case 'o': /* output file */
654 copy_filename(outname, param);
657 case 'f': /* output format */
658 ofmt = ofmt_find(param, &ofmt_alias);
660 nasm_error(ERR_FATAL | ERR_NOFILE | ERR_USAGE,
661 "unrecognised output format `%s' - "
662 "use -hf for a list", param);
666 case 'O': /* Optimization level */
671 /* Naked -O == -Ox */
672 optimizing = MAX_OPTIMIZE;
676 case '0': case '1': case '2': case '3': case '4':
677 case '5': case '6': case '7': case '8': case '9':
678 opt = strtoul(param, ¶m, 10);
680 /* -O0 -> optimizing == -1, 0.98 behaviour */
681 /* -O1 -> optimizing == 0, 0.98.09 behaviour */
683 optimizing = opt - 1;
691 opt_verbose_info = true;
696 optimizing = MAX_OPTIMIZE;
700 nasm_error(ERR_FATAL,
701 "unknown optimization option -O%c\n",
706 if (optimizing > MAX_OPTIMIZE)
707 optimizing = MAX_OPTIMIZE;
712 case 'p': /* pre-include */
714 preproc->pre_include(param);
717 case 'd': /* pre-define */
719 preproc->pre_define(param);
722 case 'u': /* un-define */
724 preproc->pre_undefine(param);
727 case 'i': /* include search path */
729 preproc->include_path(param);
732 case 'l': /* listing file */
733 copy_filename(listname, param);
736 case 'Z': /* error messages file */
737 copy_filename(errname, param);
740 case 'F': /* specify debug format */
741 ofmt->current_dfmt = dfmt_find(ofmt, param);
742 if (!ofmt->current_dfmt) {
743 nasm_error(ERR_FATAL | ERR_NOFILE | ERR_USAGE,
744 "unrecognized debug format `%s' for"
745 " output format `%s'",
746 param, ofmt->shortname);
748 using_debug_info = true;
751 case 'X': /* specify error reporting format */
752 if (nasm_stricmp("vc", param) == 0)
753 nasm_set_verror(nasm_verror_vc);
754 else if (nasm_stricmp("gnu", param) == 0)
755 nasm_set_verror(nasm_verror_gnu);
757 nasm_error(ERR_FATAL | ERR_NOFILE | ERR_USAGE,
758 "unrecognized error reporting format `%s'",
763 using_debug_info = true;
768 ("usage: nasm [-@ response file] [-o outfile] [-f format] "
770 " [options...] [--] filename\n"
771 " or nasm -v for version info\n\n"
772 " -t assemble in SciTech TASM compatible mode\n"
773 " -g generate debug information in selected format\n");
775 (" -E (or -e) preprocess only (writes output to stdout by default)\n"
776 " -a don't preprocess (assemble only)\n"
777 " -M generate Makefile dependencies on stdout\n"
778 " -MG d:o, missing files assumed generated\n"
779 " -MF <file> set Makefile dependency file\n"
780 " -MD <file> assemble and generate dependencies\n"
781 " -MT <file> dependency target name\n"
782 " -MQ <file> dependency target name (quoted)\n"
783 " -MP emit phony target\n\n"
784 " -Z<file> redirect error messages to file\n"
785 " -s redirect error messages to stdout\n\n"
786 " -F format select a debugging format\n\n"
787 " -I<path> adds a pathname to the include file path\n");
789 (" -O<digit> optimize branch offsets\n"
790 " -O0: No optimization\n"
791 " -O1: Minimal optimization\n"
792 " -Ox: Multipass optimization (default)\n\n"
793 " -P<file> pre-includes a file\n"
794 " -D<macro>[=<value>] pre-defines a macro\n"
795 " -U<macro> undefines a macro\n"
796 " -X<format> specifies error reporting format (gnu or vc)\n"
797 " -w+foo enables warning foo (equiv. -Wfoo)\n"
798 " -w-foo disable warning foo (equiv. -Wno-foo)\n\n"
799 "--prefix,--postfix\n"
800 " this options prepend or append the given argument to all\n"
801 " extern and global variables\n\n"
803 for (i = 0; i <= ERR_WARN_MAX; i++)
804 printf(" %-23s %s (default %s)\n",
805 warnings[i].name, warnings[i].help,
806 warnings[i].enabled ? "on" : "off");
808 ("\nresponse files should contain command line parameters"
809 ", one per line.\n");
811 printf("\nvalid output formats for -f are"
812 " (`*' denotes default):\n");
813 ofmt_list(ofmt, stdout);
815 printf("\nFor a list of valid output formats, use -hf.\n");
816 printf("For a list of debug formats, use -f <form> -y.\n");
818 exit(0); /* never need usage message here */
822 printf("\nvalid debug formats for '%s' output format are"
823 " ('*' denotes default):\n", ofmt->shortname);
824 dfmt_list(ofmt, stdout);
829 tasm_compatible_mode = true;
833 printf("NASM version %s compiled on %s%s\n",
834 nasm_version, nasm_date, nasm_compile_options);
835 exit(0); /* never need usage message here */
838 case 'e': /* preprocess only */
840 operating_mode = op_preprocess;
843 case 'a': /* assemble only - don't preprocess */
844 preproc = &preproc_nop;
848 if (param[0] == 'n' && param[1] == 'o' && param[2] == '-') {
857 if (param[0] != '+' && param[0] != '-') {
858 nasm_error(ERR_NONFATAL | ERR_NOFILE | ERR_USAGE,
859 "invalid option to `-w'");
862 do_warn = (param[0] == '+');
866 for (i = 0; i <= ERR_WARN_MAX; i++) {
867 if (!nasm_stricmp(param, warnings[i].name))
870 if (i <= ERR_WARN_MAX) {
871 warning_on_global[i] = do_warn;
872 } else if (!nasm_stricmp(param, "all")) {
873 for (i = 1; i <= ERR_WARN_MAX; i++)
874 warning_on_global[i] = do_warn;
875 } else if (!nasm_stricmp(param, "none")) {
876 for (i = 1; i <= ERR_WARN_MAX; i++)
877 warning_on_global[i] = !do_warn;
879 nasm_error(ERR_NONFATAL | ERR_NOFILE | ERR_USAGE,
880 "invalid warning `%s'", param);
887 operating_mode = op_depend;
890 operating_mode = op_depend;
891 depend_missing_ok = true;
894 depend_emit_phony = true;
905 depend_target = quote_for_make(q);
909 nasm_error(ERR_NONFATAL|ERR_NOFILE|ERR_USAGE,
910 "unknown dependency option `-M%c'", p[2]);
913 if (advance && (!q || !q[0])) {
914 nasm_error(ERR_NONFATAL|ERR_NOFILE|ERR_USAGE,
915 "option `-M%c' requires a parameter", p[2]);
924 if (p[2] == 0) { /* -- => stop processing options */
928 for (s = 0; textopts[s].label; s++) {
929 if (!nasm_stricmp(p + 2, textopts[s].label)) {
940 nasm_error(ERR_NONFATAL | ERR_NOFILE |
942 "option `--%s' requires an argument",
946 advance = 1, param = q;
949 if (s == OPT_PREFIX) {
950 strncpy(lprefix, param, PREFIX_MAX - 1);
951 lprefix[PREFIX_MAX - 1] = 0;
954 if (s == OPT_POSTFIX) {
955 strncpy(lpostfix, param, POSTFIX_MAX - 1);
956 lpostfix[POSTFIX_MAX - 1] = 0;
963 nasm_error(ERR_NONFATAL | ERR_NOFILE | ERR_USAGE,
964 "unrecognised option `--%s'", p + 2);
972 if (!ofmt->setinfo(GI_SWITCH, &p))
973 nasm_error(ERR_NONFATAL | ERR_NOFILE | ERR_USAGE,
974 "unrecognised option `-%c'", p[1]);
979 nasm_error(ERR_NONFATAL | ERR_NOFILE | ERR_USAGE,
980 "more than one input file specified");
982 copy_filename(inname, p);
989 #define ARG_BUF_DELTA 128
991 static void process_respfile(FILE * rfile)
993 char *buffer, *p, *q, *prevarg;
994 int bufsize, prevargsize;
996 bufsize = prevargsize = ARG_BUF_DELTA;
997 buffer = nasm_malloc(ARG_BUF_DELTA);
998 prevarg = nasm_malloc(ARG_BUF_DELTA);
1001 while (1) { /* Loop to handle all lines in file */
1003 while (1) { /* Loop to handle long lines */
1004 q = fgets(p, bufsize - (p - buffer), rfile);
1008 if (p > buffer && p[-1] == '\n')
1010 if (p - buffer > bufsize - 10) {
1012 offset = p - buffer;
1013 bufsize += ARG_BUF_DELTA;
1014 buffer = nasm_realloc(buffer, bufsize);
1015 p = buffer + offset;
1019 if (!q && p == buffer) {
1021 process_arg(prevarg, NULL);
1028 * Play safe: remove CRs, LFs and any spurious ^Zs, if any of
1029 * them are present at the end of the line.
1031 *(p = &buffer[strcspn(buffer, "\r\n\032")]) = '\0';
1033 while (p > buffer && nasm_isspace(p[-1]))
1036 p = nasm_skip_spaces(buffer);
1038 if (process_arg(prevarg, p))
1041 if ((int) strlen(p) > prevargsize - 10) {
1042 prevargsize += ARG_BUF_DELTA;
1043 prevarg = nasm_realloc(prevarg, prevargsize);
1045 strncpy(prevarg, p, prevargsize);
1049 /* Function to process args from a string of args, rather than the
1050 * argv array. Used by the environment variable and response file
1053 static void process_args(char *args)
1055 char *p, *q, *arg, *prevarg;
1056 char separator = ' ';
1059 if (*p && *p != '-')
1064 while (*p && *p != separator)
1066 while (*p == separator)
1070 if (process_arg(prevarg, arg))
1074 process_arg(arg, NULL);
1077 static void process_response_file(const char *file)
1080 FILE *f = fopen(file, "r");
1085 while (fgets(str, sizeof str, f)) {
1091 static void parse_cmdline(int argc, char **argv)
1094 char *envreal, *envcopy = NULL, *p;
1097 *inname = *outname = *listname = *errname = '\0';
1099 for (i = 0; i <= ERR_WARN_MAX; i++)
1100 warning_on_global[i] = warnings[i].enabled;
1103 * First, process the NASMENV environment variable.
1105 envreal = getenv("NASMENV");
1107 envcopy = nasm_strdup(envreal);
1108 process_args(envcopy);
1113 * Now process the actual command line.
1118 if (argv[0][0] == '@') {
1120 * We have a response file, so process this as a set of
1121 * arguments like the environment variable. This allows us
1122 * to have multiple arguments on a single line, which is
1123 * different to the -@resp file processing below for regular
1126 process_response_file(argv[0]+1);
1130 if (!stopoptions && argv[0][0] == '-' && argv[0][1] == '@') {
1131 p = get_param(argv[0], argc > 1 ? argv[1] : NULL, &advance);
1133 rfile = fopen(p, "r");
1135 process_respfile(rfile);
1138 nasm_error(ERR_NONFATAL | ERR_NOFILE | ERR_USAGE,
1139 "unable to open response file `%s'", p);
1142 advance = process_arg(argv[0], argc > 1 ? argv[1] : NULL);
1143 argv += advance, argc -= advance;
1147 * Look for basic command line typos. This definitely doesn't
1148 * catch all errors, but it might help cases of fumbled fingers.
1151 nasm_error(ERR_NONFATAL | ERR_NOFILE | ERR_USAGE,
1152 "no input file specified");
1153 else if (!strcmp(inname, errname) ||
1154 !strcmp(inname, outname) ||
1155 !strcmp(inname, listname) ||
1156 (depend_file && !strcmp(inname, depend_file)))
1157 nasm_error(ERR_FATAL | ERR_NOFILE | ERR_USAGE,
1158 "file `%s' is both input and output file",
1162 error_file = fopen(errname, "w");
1164 error_file = stderr; /* Revert to default! */
1165 nasm_error(ERR_FATAL | ERR_NOFILE | ERR_USAGE,
1166 "cannot open file `%s' for error messages",
1172 static enum directives getkw(char **directive, char **value);
1174 static void assemble_file(char *fname, StrList **depend_ptr)
1176 char *directive, *value, *p, *q, *special, *line;
1182 struct tokenval tokval;
1186 if (cmd_sb == 32 && cmd_cpu < IF_386)
1187 nasm_error(ERR_FATAL, "command line: "
1188 "32-bit segment size requires a higher cpu");
1190 pass_max = prev_offset_changed = (INT_MAX >> 1) + 2; /* Almost unlimited */
1191 for (passn = 1; pass0 <= 2; passn++) {
1195 pass1 = pass0 == 2 ? 2 : 1; /* 1, 1, 1, ..., 1, 2 */
1196 pass2 = passn > 1 ? 2 : 1; /* 1, 2, 2, ..., 2, 2 */
1197 /* pass0 0, 0, 0, ..., 1, 2 */
1199 def_label = passn > 1 ? redefine_label : define_label;
1201 globalbits = sb = cmd_sb; /* set 'bits' to command line default */
1205 nasmlist.init(listname, nasm_error);
1208 global_offset_changed = 0; /* set by redefine_label */
1209 location.segment = ofmt->section(NULL, pass2, &sb);
1212 saa_rewind(forwrefs);
1213 forwref = saa_rstruct(forwrefs);
1215 offsets = raa_init();
1217 preproc->reset(fname, pass1, &nasmlist,
1218 pass1 == 2 ? depend_ptr : NULL);
1219 memcpy(warning_on, warning_on_global, (ERR_WARN_MAX+1) * sizeof(bool));
1223 location.known = true;
1224 location.offset = offs = get_curr_offs();
1226 while ((line = preproc->getline())) {
1231 * Here we parse our directives; this is not handled by the
1232 * 'real' parser. This really should be a separate function.
1235 d = getkw(&directive, &value);
1240 case D_SEGMENT: /* [SEGMENT n] */
1242 seg = ofmt->section(value, pass2, &sb);
1243 if (seg == NO_SEG) {
1244 nasm_error(pass1 == 1 ? ERR_NONFATAL : ERR_PANIC,
1245 "segment name `%s' not recognized",
1249 location.segment = seg;
1252 case D_SECTALIGN: /* [SECTALIGN n] */
1256 tokval.t_type = TOKEN_INVALID;
1257 e = evaluate(stdscan, NULL, &tokval, NULL, pass2, nasm_error, NULL);
1259 unsigned int align = (unsigned int)e->value;
1260 if ((uint64_t)e->value > 0x7fffffff) {
1262 * FIXME: Please make some sane message here
1263 * ofmt should have some 'check' method which
1264 * would report segment alignment bounds.
1266 nasm_error(ERR_FATAL,
1267 "incorrect segment alignment `%s'", value);
1268 } else if (!is_power2(align)) {
1269 nasm_error(ERR_NONFATAL,
1270 "segment alignment `%s' is not power of two",
1273 /* callee should be able to handle all details */
1274 ofmt->sectalign(location.segment, align);
1278 case D_EXTERN: /* [EXTERN label:special] */
1280 value++; /* skip initial $ if present */
1283 while (*q && *q != ':')
1287 ofmt->symdef(value, 0L, 0L, 3, q);
1289 } else if (passn == 1) {
1294 while (*q && *q != ':') {
1300 nasm_error(ERR_NONFATAL,
1301 "identifier expected after EXTERN");
1309 if (!is_extern(value)) { /* allow re-EXTERN to be ignored */
1311 pass0 = 1; /* fake pass 1 in labels.c */
1312 declare_as_global(value, special);
1313 define_label(value, seg_alloc(), 0L, NULL,
1317 } /* else pass0 == 1 */
1319 case D_BITS: /* [BITS bits] */
1320 globalbits = sb = get_bits(value);
1322 case D_GLOBAL: /* [GLOBAL symbol:special] */
1324 value++; /* skip initial $ if present */
1325 if (pass0 == 2) { /* pass 2 */
1327 while (*q && *q != ':')
1331 ofmt->symdef(value, 0L, 0L, 3, q);
1333 } else if (pass2 == 1) { /* pass == 1 */
1338 while (*q && *q != ':') {
1344 nasm_error(ERR_NONFATAL,
1345 "identifier expected after GLOBAL");
1353 declare_as_global(value, special);
1356 case D_COMMON: /* [COMMON symbol size:special] */
1361 value++; /* skip initial $ if present */
1366 while (*p && !nasm_isspace(*p)) {
1372 nasm_error(ERR_NONFATAL,
1373 "identifier expected after COMMON");
1377 p = nasm_zap_spaces_fwd(p);
1379 while (*q && *q != ':')
1387 size = readnum(p, &rn_error);
1389 nasm_error(ERR_NONFATAL,
1390 "invalid size specified"
1391 " in COMMON declaration");
1395 nasm_error(ERR_NONFATAL,
1396 "no size specified in"
1397 " COMMON declaration");
1402 define_common(value, seg_alloc(), size, special);
1403 } else if (pass0 == 2) {
1405 ofmt->symdef(value, 0L, 0L, 3, special);
1409 case D_ABSOLUTE: /* [ABSOLUTE address] */
1412 tokval.t_type = TOKEN_INVALID;
1413 e = evaluate(stdscan, NULL, &tokval, NULL, pass2,
1418 1 ? ERR_NONFATAL : ERR_PANIC,
1419 "cannot use non-relocatable expression as "
1420 "ABSOLUTE address");
1422 abs_seg = reloc_seg(e);
1423 abs_offset = reloc_value(e);
1425 } else if (passn == 1)
1426 abs_offset = 0x100; /* don't go near zero in case of / */
1428 nasm_error(ERR_PANIC, "invalid ABSOLUTE address "
1431 location.segment = NO_SEG;
1433 case D_DEBUG: /* [DEBUG] */
1436 bool badid, overlong;
1440 badid = overlong = false;
1441 if (!isidstart(*p)) {
1444 while (*p && !nasm_isspace(*p)) {
1445 if (q >= debugid + sizeof debugid - 1) {
1456 nasm_error(passn == 1 ? ERR_NONFATAL : ERR_PANIC,
1457 "identifier expected after DEBUG");
1461 nasm_error(passn == 1 ? ERR_NONFATAL : ERR_PANIC,
1462 "DEBUG identifier too long");
1465 p = nasm_skip_spaces(p);
1467 dfmt->debug_directive(debugid, p);
1470 case D_WARNING: /* [WARNING {+|-|*}warn-name] */
1471 value = nasm_skip_spaces(value);
1473 case '-': validid = 0; value++; break;
1474 case '+': validid = 1; value++; break;
1475 case '*': validid = 2; value++; break;
1476 default: validid = 1; break;
1479 for (i = 1; i <= ERR_WARN_MAX; i++)
1480 if (!nasm_stricmp(value, warnings[i].name))
1482 if (i <= ERR_WARN_MAX) {
1485 warning_on[i] = false;
1488 warning_on[i] = true;
1491 warning_on[i] = warning_on_global[i];
1495 nasm_error(ERR_NONFATAL,
1496 "invalid warning id in WARNING directive");
1498 case D_CPU: /* [CPU] */
1499 cpu = get_cpu(value);
1501 case D_LIST: /* [LIST {+|-}] */
1502 value = nasm_skip_spaces(value);
1503 if (*value == '+') {
1506 if (*value == '-') {
1513 case D_DEFAULT: /* [DEFAULT] */
1516 tokval.t_type = TOKEN_INVALID;
1517 if (stdscan(NULL, &tokval) == TOKEN_SPECIAL) {
1518 switch ((int)tokval.t_integer) {
1534 if (float_option(value)) {
1535 nasm_error(pass1 == 1 ? ERR_NONFATAL : ERR_PANIC,
1536 "unknown 'float' directive: %s",
1541 if (ofmt->directive(d, value, pass2))
1543 /* else fall through */
1545 nasm_error(pass1 == 1 ? ERR_NONFATAL : ERR_PANIC,
1546 "unrecognised directive [%s]",
1551 nasm_error(ERR_NONFATAL,
1552 "invalid parameter to [%s] directive",
1555 } else { /* it isn't a directive */
1556 parse_line(pass1, line, &output_ins, def_label);
1558 if (optimizing > 0) {
1559 if (forwref != NULL && globallineno == forwref->lineno) {
1560 output_ins.forw_ref = true;
1562 output_ins.oprs[forwref->operand].opflags |= OPFLAG_FORWARD;
1563 forwref = saa_rstruct(forwrefs);
1564 } while (forwref != NULL
1565 && forwref->lineno == globallineno);
1567 output_ins.forw_ref = false;
1569 if (output_ins.forw_ref) {
1571 for (i = 0; i < output_ins.operands; i++) {
1572 if (output_ins.oprs[i].opflags & OPFLAG_FORWARD) {
1573 struct forwrefinfo *fwinf = (struct forwrefinfo *)saa_wstruct(forwrefs);
1574 fwinf->lineno = globallineno;
1583 if (output_ins.opcode == I_EQU) {
1586 * Special `..' EQUs get processed in pass two,
1587 * except `..@' macro-processor EQUs which are done
1588 * in the normal place.
1590 if (!output_ins.label)
1591 nasm_error(ERR_NONFATAL,
1592 "EQU not preceded by label");
1594 else if (output_ins.label[0] != '.' ||
1595 output_ins.label[1] != '.' ||
1596 output_ins.label[2] == '@') {
1597 if (output_ins.operands == 1 &&
1598 (output_ins.oprs[0].type & IMMEDIATE) &&
1599 output_ins.oprs[0].wrt == NO_SEG) {
1600 bool isext = !!(output_ins.oprs[0].opflags & OPFLAG_EXTERN);
1601 def_label(output_ins.label,
1602 output_ins.oprs[0].segment,
1603 output_ins.oprs[0].offset, NULL,
1605 } else if (output_ins.operands == 2
1606 && (output_ins.oprs[0].type & IMMEDIATE)
1607 && (output_ins.oprs[0].type & COLON)
1608 && output_ins.oprs[0].segment == NO_SEG
1609 && output_ins.oprs[0].wrt == NO_SEG
1610 && (output_ins.oprs[1].type & IMMEDIATE)
1611 && output_ins.oprs[1].segment == NO_SEG
1612 && output_ins.oprs[1].wrt == NO_SEG) {
1613 def_label(output_ins.label,
1614 output_ins.oprs[0].offset | SEG_ABS,
1615 output_ins.oprs[1].offset,
1616 NULL, false, false);
1618 nasm_error(ERR_NONFATAL,
1619 "bad syntax for EQU");
1623 * Special `..' EQUs get processed here, except
1624 * `..@' macro processor EQUs which are done above.
1626 if (output_ins.label[0] == '.' &&
1627 output_ins.label[1] == '.' &&
1628 output_ins.label[2] != '@') {
1629 if (output_ins.operands == 1 &&
1630 (output_ins.oprs[0].type & IMMEDIATE)) {
1631 define_label(output_ins.label,
1632 output_ins.oprs[0].segment,
1633 output_ins.oprs[0].offset,
1634 NULL, false, false);
1635 } else if (output_ins.operands == 2
1636 && (output_ins.oprs[0].type & IMMEDIATE)
1637 && (output_ins.oprs[0].type & COLON)
1638 && output_ins.oprs[0].segment == NO_SEG
1639 && (output_ins.oprs[1].type & IMMEDIATE)
1640 && output_ins.oprs[1].segment == NO_SEG) {
1641 define_label(output_ins.label,
1642 output_ins.oprs[0].offset | SEG_ABS,
1643 output_ins.oprs[1].offset,
1644 NULL, false, false);
1646 nasm_error(ERR_NONFATAL,
1647 "bad syntax for EQU");
1650 } else { /* instruction isn't an EQU */
1654 int64_t l = insn_size(location.segment, offs, sb, cpu,
1655 &output_ins, nasm_error);
1657 /* if (using_debug_info) && output_ins.opcode != -1) */
1658 if (using_debug_info)
1659 { /* fbk 03/25/01 */
1660 /* this is done here so we can do debug type info */
1662 TYS_ELEMENTS(output_ins.operands);
1663 switch (output_ins.opcode) {
1666 TYS_ELEMENTS(output_ins.oprs[0].offset) | TY_BYTE;
1670 TYS_ELEMENTS(output_ins.oprs[0].offset) | TY_WORD;
1674 TYS_ELEMENTS(output_ins.oprs[0].offset) | TY_DWORD;
1678 TYS_ELEMENTS(output_ins.oprs[0].offset) | TY_QWORD;
1682 TYS_ELEMENTS(output_ins.oprs[0].offset) | TY_TBYTE;
1686 TYS_ELEMENTS(output_ins.oprs[0].offset) | TY_OWORD;
1690 TYS_ELEMENTS(output_ins.oprs[0].offset) | TY_YWORD;
1693 typeinfo |= TY_BYTE;
1696 typeinfo |= TY_WORD;
1699 if (output_ins.eops_float)
1700 typeinfo |= TY_FLOAT;
1702 typeinfo |= TY_DWORD;
1705 typeinfo |= TY_QWORD;
1708 typeinfo |= TY_TBYTE;
1711 typeinfo |= TY_OWORD;
1714 typeinfo |= TY_YWORD;
1717 typeinfo = TY_LABEL;
1721 dfmt->debug_typevalue(typeinfo);
1725 set_curr_offs(offs);
1728 * else l == -1 => invalid instruction, which will be
1729 * flagged as an error on pass 2
1733 offs += assemble(location.segment, offs, sb, cpu,
1734 &output_ins, ofmt, nasm_error,
1736 set_curr_offs(offs);
1740 cleanup_insn(&output_ins);
1743 location.offset = offs = get_curr_offs();
1744 } /* end while (line = preproc->getline... */
1746 if (pass0 == 2 && global_offset_changed && !terminate_after_phase)
1747 nasm_error(ERR_NONFATAL,
1748 "phase error detected at end of assembly.");
1751 preproc->cleanup(1);
1753 if ((passn > 1 && !global_offset_changed) || pass0 == 2) {
1755 } else if (global_offset_changed &&
1756 global_offset_changed < prev_offset_changed) {
1757 prev_offset_changed = global_offset_changed;
1763 if (terminate_after_phase)
1766 if ((stall_count > 997) || (passn >= pass_max)) {
1767 /* We get here if the labels don't converge
1768 * Example: FOO equ FOO + 1
1770 nasm_error(ERR_NONFATAL,
1771 "Can't find valid values for all labels "
1772 "after %d passes, giving up.", passn);
1773 nasm_error(ERR_NONFATAL,
1774 "Possible causes: recursive EQUs, macro abuse.");
1779 preproc->cleanup(0);
1781 if (!terminate_after_phase && opt_verbose_info) {
1782 /* -On and -Ov switches */
1783 fprintf(stdout, "info: assembly required 1+%d+1 passes\n", passn-3);
1787 static enum directives getkw(char **directive, char **value)
1791 buf = nasm_skip_spaces(*directive);
1793 /* it should be enclosed in [ ] */
1796 q = strchr(buf, ']');
1800 /* stip off the comments */
1801 p = strchr(buf, ';');
1803 if (p < q) /* ouch! somwhere inside */
1808 /* no brace, no trailing spaces */
1810 nasm_zap_spaces_rev(--q);
1813 p = nasm_skip_spaces(++buf);
1814 q = nasm_skip_word(p);
1816 return D_none; /* sigh... no value there */
1820 /* and value finally */
1821 p = nasm_skip_spaces(++q);
1824 return find_directive(*directive);
1828 * gnu style error reporting
1829 * This function prints an error message to error_file in the
1830 * style used by GNU. An example would be:
1831 * file.asm:50: error: blah blah blah
1832 * where file.asm is the name of the file, 50 is the line number on
1833 * which the error occurs (or is detected) and "error:" is one of
1834 * the possible optional diagnostics -- it can be "error" or "warning"
1835 * or something else. Finally the line terminates with the actual
1838 * @param severity the severity of the warning or error
1839 * @param fmt the printf style format string
1841 static void nasm_verror_gnu(int severity, const char *fmt, va_list ap)
1843 char *currentfile = NULL;
1846 if (is_suppressed_warning(severity))
1849 if (!(severity & ERR_NOFILE))
1850 src_get(&lineno, ¤tfile);
1853 fprintf(error_file, "%s:%"PRId32": ", currentfile, lineno);
1854 nasm_free(currentfile);
1856 fputs("nasm: ", error_file);
1859 nasm_verror_common(severity, fmt, ap);
1863 * MS style error reporting
1864 * This function prints an error message to error_file in the
1865 * style used by Visual C and some other Microsoft tools. An example
1867 * file.asm(50) : error: blah blah blah
1868 * where file.asm is the name of the file, 50 is the line number on
1869 * which the error occurs (or is detected) and "error:" is one of
1870 * the possible optional diagnostics -- it can be "error" or "warning"
1871 * or something else. Finally the line terminates with the actual
1874 * @param severity the severity of the warning or error
1875 * @param fmt the printf style format string
1877 static void nasm_verror_vc(int severity, const char *fmt, va_list ap)
1879 char *currentfile = NULL;
1882 if (is_suppressed_warning(severity))
1885 if (!(severity & ERR_NOFILE))
1886 src_get(&lineno, ¤tfile);
1889 fprintf(error_file, "%s(%"PRId32") : ", currentfile, lineno);
1890 nasm_free(currentfile);
1892 fputs("nasm: ", error_file);
1895 nasm_verror_common(severity, fmt, ap);
1899 * check for supressed warning
1900 * checks for suppressed warning or pass one only warning and we're
1903 * @param severity the severity of the warning or error
1904 * @return true if we should abort error/warning printing
1906 static bool is_suppressed_warning(int severity)
1908 /* Not a warning at all */
1909 if ((severity & ERR_MASK) != ERR_WARNING)
1912 /* See if it's a pass-one only warning and we're not in pass one. */
1913 if (((severity & ERR_PASS1) && pass0 != 1) ||
1914 ((severity & ERR_PASS2) && pass0 != 2))
1917 /* Might be a warning but suppresed explicitly */
1918 if (severity & ERR_WARN_MASK)
1919 return !warning_on[WARN_IDX(severity)];
1925 * common error reporting
1926 * This is the common back end of the error reporting schemes currently
1927 * implemented. It prints the nature of the warning and then the
1928 * specific error message to error_file and may or may not return. It
1929 * doesn't return if the error severity is a "panic" or "debug" type.
1931 * @param severity the severity of the warning or error
1932 * @param fmt the printf style format string
1934 static void nasm_verror_common(int severity, const char *fmt, va_list args)
1939 switch (severity & (ERR_MASK|ERR_NO_SEVERITY)) {
1960 vsnprintf(msg, sizeof msg, fmt, args);
1962 fprintf(error_file, "%s%s\n", pfx, msg);
1965 nasmlist.error(severity, pfx, msg);
1967 if (severity & ERR_USAGE)
1970 switch (severity & ERR_MASK) {
1972 /* no further action, by definition */
1975 /* Treat warnings as errors */
1976 if (warning_on[WARN_IDX(ERR_WARN_TERM)])
1977 terminate_after_phase = true;
1980 terminate_after_phase = true;
1990 exit(1); /* instantly die */
1991 break; /* placate silly compilers */
1994 /* abort(); */ /* halt, catch fire, and dump core */
2000 static void usage(void)
2002 fputs("type `nasm -h' for help\n", error_file);
2005 static uint32_t get_cpu(char *value)
2007 if (!strcmp(value, "8086"))
2009 if (!strcmp(value, "186"))
2011 if (!strcmp(value, "286"))
2013 if (!strcmp(value, "386"))
2015 if (!strcmp(value, "486"))
2017 if (!strcmp(value, "586") || !nasm_stricmp(value, "pentium"))
2019 if (!strcmp(value, "686") ||
2020 !nasm_stricmp(value, "ppro") ||
2021 !nasm_stricmp(value, "pentiumpro") || !nasm_stricmp(value, "p2"))
2023 if (!nasm_stricmp(value, "p3") || !nasm_stricmp(value, "katmai"))
2025 if (!nasm_stricmp(value, "p4") || /* is this right? -- jrc */
2026 !nasm_stricmp(value, "willamette"))
2027 return IF_WILLAMETTE;
2028 if (!nasm_stricmp(value, "prescott"))
2030 if (!nasm_stricmp(value, "x64") ||
2031 !nasm_stricmp(value, "x86-64"))
2033 if (!nasm_stricmp(value, "ia64") ||
2034 !nasm_stricmp(value, "ia-64") ||
2035 !nasm_stricmp(value, "itanium") ||
2036 !nasm_stricmp(value, "itanic") || !nasm_stricmp(value, "merced"))
2039 nasm_error(pass0 < 2 ? ERR_NONFATAL : ERR_FATAL,
2040 "unknown 'cpu' type");
2042 return IF_PLEVEL; /* the maximum level */
2045 static int get_bits(char *value)
2049 if ((i = atoi(value)) == 16)
2050 return i; /* set for a 16-bit segment */
2053 nasm_error(ERR_NONFATAL,
2054 "cannot specify 32-bit segment on processor below a 386");
2057 } else if (i == 64) {
2058 if (cpu < IF_X86_64) {
2059 nasm_error(ERR_NONFATAL,
2060 "cannot specify 64-bit segment on processor below an x86-64");
2064 nasm_error(ERR_NONFATAL,
2065 "%s output format does not support 64-bit code",
2070 nasm_error(pass0 < 2 ? ERR_NONFATAL : ERR_FATAL,
2071 "`%s' is not a valid segment size; must be 16, 32 or 64",