1 /* outbin.c output routines for the Netwide Assembler to produce
2 * flat-form binary files
4 * The Netwide Assembler is copyright (C) 1996 Simon Tatham and
5 * Julian Hall. All rights reserved. The software is
6 * redistributable under the licence given in the file "Licence"
7 * distributed in the NASM archive.
10 /* This is the extended version of NASM's original binary output
11 * format. It is backward compatible with the original BIN format,
12 * and contains support for multiple sections and advanced section
17 * - Users can create an arbitrary number of sections; they are not
18 * limited to just ".text", ".data", and ".bss".
20 * - Sections can be either progbits or nobits type.
22 * - You can specify that they be aligned at a certian boundary
23 * following the previous section ("align="), or positioned at an
24 * arbitrary byte-granular location ("start=").
26 * - You can specify a "virtual" start address for a section, which
27 * will be used for the calculation for all address references
28 * with respect to that section ("vstart=").
30 * - The ORG directive, as well as the section/segment directive
31 * arguments ("align=", "start=", "vstart="), can take a critical
32 * expression as their value. For example: "align=(1 << 12)".
34 * - You can generate map files using the 'map' directive.
38 /* Uncomment the following define if you want sections to adapt
39 * their progbits/nobits state depending on what type of
40 * instructions are issued, rather than defaulting to progbits.
41 * Note that this behavior violates the specification.
43 #define ABIN_SMART_ADAPT
64 struct ofmt *bin_get_ofmt(); /* Prototype goes here since no header file. */
66 static FILE *fp, *rf = NULL;
69 /* Section flags keep track of which attributes the user has defined. */
70 #define START_DEFINED 0x001
71 #define ALIGN_DEFINED 0x002
72 #define FOLLOWS_DEFINED 0x004
73 #define VSTART_DEFINED 0x008
74 #define VALIGN_DEFINED 0x010
75 #define VFOLLOWS_DEFINED 0x020
76 #define TYPE_DEFINED 0x040
77 #define TYPE_PROGBITS 0x080
78 #define TYPE_NOBITS 0x100
80 /* This struct is used to keep track of symbols for map-file generation. */
81 static struct bin_label {
83 struct bin_label *next;
84 } *no_seg_labels, **nsl_tail;
86 static struct Section {
89 int64_t length; /* section length in bytes */
91 /* Section attributes */
92 int flags; /* see flag definitions above */
93 uint64_t align; /* section alignment */
94 uint64_t valign; /* notional section alignment */
95 uint64_t start; /* section start address */
96 uint64_t vstart; /* section virtual start address */
97 char *follows; /* the section that this one will follow */
98 char *vfollows; /* the section that this one will notionally follow */
99 int32_t start_index; /* NASM section id for non-relocated version */
100 int32_t vstart_index; /* the NASM section id */
102 struct bin_label *labels; /* linked-list of label handles for map output. */
103 struct bin_label **labels_end; /* Holds address of end of labels list. */
104 struct Section *ifollows; /* Points to previous section (implicit follows). */
105 struct Section *next; /* This links sections with a defined start address. */
107 /* The extended bin format allows for sections to have a "virtual"
108 * start address. This is accomplished by creating two sections:
109 * one beginning at the Load Memory Address and the other beginning
110 * at the Virtual Memory Address. The LMA section is only used to
111 * define the section.<section_name>.start label, but there isn't
112 * any other good way for us to handle that label.
115 } *sections, *last_section;
117 static struct Reloc {
123 struct Section *target;
124 } *relocs, **reloctail;
126 extern char *stdscan_bufptr;
128 static uint8_t format_mode; /* 0 = original bin, 1 = extended bin */
129 static int32_t current_section; /* only really needed if format_mode = 0 */
130 static uint64_t origin;
131 static int origin_defined;
133 /* Stuff we need for map-file generation. */
135 #define MAP_SUMMARY 2
136 #define MAP_SECTIONS 4
137 #define MAP_SYMBOLS 8
138 static int map_control = 0;
139 static char *infile, *outfile;
141 static const char *bin_stdmac[] = {
142 "%define __SECT__ [section .text]",
143 "%imacro org 1+.nolist",
146 "%macro __NASM_CDecl__ 1",
151 static void add_reloc(struct Section *s, int32_t bytes, int32_t secref,
156 r = *reloctail = nasm_malloc(sizeof(struct Reloc));
157 reloctail = &r->next;
166 static struct Section *find_section_by_name(const char *name)
170 for (s = sections; s; s = s->next)
171 if (!strcmp(s->name, name))
176 static struct Section *find_section_by_index(int32_t index)
180 for (s = sections; s; s = s->next)
181 if ((index == s->vstart_index) || (index == s->start_index))
186 static struct Section *create_section(char *name)
187 { /* Create a new section. */
188 last_section->next = nasm_malloc(sizeof(struct Section));
189 last_section->next->ifollows = last_section;
190 last_section = last_section->next;
191 last_section->labels = NULL;
192 last_section->labels_end = &(last_section->labels);
194 /* Initialize section attributes. */
195 last_section->name = nasm_strdup(name);
196 last_section->contents = saa_init(1L);
197 last_section->follows = last_section->vfollows = 0;
198 last_section->length = 0;
199 last_section->flags = 0;
200 last_section->next = NULL;
202 /* Register our sections with NASM. */
203 last_section->vstart_index = seg_alloc();
204 last_section->start_index = seg_alloc();
208 static void bin_cleanup(int debuginfo)
210 struct Section *g, **gp;
211 struct Section *gs = NULL, **gsp;
212 struct Section *s, **sp;
213 struct Section *nobits = NULL, **nt;
214 struct Section *last_progbits;
220 (void)debuginfo; /* placate optimizers */
224 "bin_cleanup: Sections were initially referenced in this order:\n");
225 for (h = 0, s = sections; s; h++, s = s->next)
226 fprintf(stdout, "%i. %s\n", h, s->name);
229 /* Assembly has completed, so now we need to generate the output file.
230 * Step 1: Separate progbits and nobits sections into separate lists.
231 * Step 2: Sort the progbits sections into their output order.
232 * Step 3: Compute start addresses for all progbits sections.
233 * Step 4: Compute vstart addresses for all sections.
234 * Step 5: Apply relocations.
235 * Step 6: Write the sections' data to the output file.
236 * Step 7: Generate the map file.
237 * Step 8: Release all allocated memory.
240 /* To do: Smart section-type adaptation could leave some empty sections
241 * without a defined type (progbits/nobits). Won't fix now since this
242 * feature will be disabled. */
244 /* Step 1: Split progbits and nobits sections into separate lists. */
247 /* Move nobits sections into a separate list. Also pre-process nobits
248 * sections' attributes. */
249 for (sp = §ions->next, s = sections->next; s; s = *sp) { /* Skip progbits sections. */
250 if (s->flags & TYPE_PROGBITS) {
254 /* Do some special pre-processing on nobits sections' attributes. */
255 if (s->flags & (START_DEFINED | ALIGN_DEFINED | FOLLOWS_DEFINED)) { /* Check for a mixture of real and virtual section attributes. */
257 flags & (VSTART_DEFINED | VALIGN_DEFINED |
260 "cannot mix real and virtual attributes"
261 " in nobits section (%s)", s->name);
262 /* Real and virtual attributes mean the same thing for nobits sections. */
263 if (s->flags & START_DEFINED) {
264 s->vstart = s->start;
265 s->flags |= VSTART_DEFINED;
267 if (s->flags & ALIGN_DEFINED) {
268 s->valign = s->align;
269 s->flags |= VALIGN_DEFINED;
271 if (s->flags & FOLLOWS_DEFINED) {
272 s->vfollows = s->follows;
273 s->flags |= VFOLLOWS_DEFINED;
274 s->flags &= ~FOLLOWS_DEFINED;
277 /* Every section must have a start address. */
278 if (s->flags & VSTART_DEFINED) {
279 s->start = s->vstart;
280 s->flags |= START_DEFINED;
282 /* Move the section into the nobits list. */
289 /* Step 2: Sort the progbits sections into their output order. */
291 /* In Step 2 we move around sections in groups. A group
292 * begins with a section (group leader) that has a user-
293 * defined start address or follows section. The remainder
294 * of the group is made up of the sections that implicitly
295 * follow the group leader (i.e., they were defined after
296 * the group leader and were not given an explicit start
297 * address or follows section by the user). */
299 /* For anyone attempting to read this code:
300 * g (group) points to a group of sections, the first one of which has
301 * a user-defined start address or follows section.
302 * gp (g previous) holds the location of the pointer to g.
303 * gs (g scan) is a temp variable that we use to scan to the end of the group.
304 * gsp (gs previous) holds the location of the pointer to gs.
305 * nt (nobits tail) points to the nobits section-list tail.
308 /* Link all 'follows' groups to their proper position. To do
309 * this we need to know three things: the start of the group
310 * to relocate (g), the section it is following (s), and the
311 * end of the group we're relocating (gs). */
312 for (gp = §ions, g = sections; g; g = gs) { /* Find the next follows group that is out of place (g). */
313 if (!(g->flags & FOLLOWS_DEFINED)) {
315 if ((g->next->flags & FOLLOWS_DEFINED) &&
316 strcmp(g->name, g->next->follows))
325 /* Find the section that this group follows (s). */
326 for (sp = §ions, s = sections;
327 s && strcmp(s->name, g->follows);
328 sp = &s->next, s = s->next) ;
330 error(ERR_FATAL, "section %s follows an invalid or"
331 " unknown section (%s)", g->name, g->follows);
332 if (s->next && (s->next->flags & FOLLOWS_DEFINED) &&
333 !strcmp(s->name, s->next->follows))
334 error(ERR_FATAL, "sections %s and %s can't both follow"
335 " section %s", g->name, s->next->name, s->name);
336 /* Find the end of the current follows group (gs). */
337 for (gsp = &g->next, gs = g->next;
338 gs && (gs != s) && !(gs->flags & START_DEFINED);
339 gsp = &gs->next, gs = gs->next) {
340 if (gs->next && (gs->next->flags & FOLLOWS_DEFINED) &&
341 strcmp(gs->name, gs->next->follows)) {
347 /* Re-link the group after its follows section. */
353 /* Link all 'start' groups to their proper position. Once
354 * again we need to know g, s, and gs (see above). The main
355 * difference is we already know g since we sort by moving
356 * groups from the 'unsorted' list into a 'sorted' list (g
357 * will always be the first section in the unsorted list). */
358 for (g = sections, sections = NULL; g; g = gs) { /* Find the section that we will insert this group before (s). */
359 for (sp = §ions, s = sections; s; sp = &s->next, s = s->next)
360 if ((s->flags & START_DEFINED) && (g->start < s->start))
362 /* Find the end of the group (gs). */
363 for (gs = g->next, gsp = &g->next;
364 gs && !(gs->flags & START_DEFINED);
365 gsp = &gs->next, gs = gs->next) ;
366 /* Re-link the group before the target section. */
371 /* Step 3: Compute start addresses for all progbits sections. */
373 /* Make sure we have an origin and a start address for the first section. */
375 switch (sections->flags & (START_DEFINED | ALIGN_DEFINED)) {
376 case START_DEFINED | ALIGN_DEFINED:
378 /* Make sure this section doesn't begin before the origin. */
379 if (sections->start < origin)
380 error(ERR_FATAL, "section %s begins"
381 " before program origin", sections->name);
384 sections->start = ((origin + sections->align - 1) &
385 ~(sections->align - 1));
388 sections->start = origin;
390 if (!(sections->flags & START_DEFINED))
392 origin = sections->start;
394 sections->flags |= START_DEFINED;
396 /* Make sure each section has an explicit start address. If it
397 * doesn't, then compute one based its alignment and the end of
398 * the previous section. */
399 for (pend = sections->start, g = s = sections; g; g = g->next) { /* Find the next section that could cause an overlap situation
400 * (has a defined start address, and is not zero length). */
403 s && ((s->length == 0) || !(s->flags & START_DEFINED));
405 /* Compute the start address of this section, if necessary. */
406 if (!(g->flags & START_DEFINED)) { /* Default to an alignment of 4 if unspecified. */
407 if (!(g->flags & ALIGN_DEFINED)) {
409 g->flags |= ALIGN_DEFINED;
411 /* Set the section start address. */
412 g->start = (pend + g->align - 1) & ~(g->align - 1);
413 g->flags |= START_DEFINED;
415 /* Ugly special case for progbits sections' virtual attributes:
416 * If there is a defined valign, but no vstart and no vfollows, then
417 * we valign after the previous progbits section. This case doesn't
418 * really make much sense for progbits sections with a defined start
419 * address, but it is possible and we must do *something*.
420 * Not-so-ugly special case:
421 * If a progbits section has no virtual attributes, we set the
422 * vstart equal to the start address. */
423 if (!(g->flags & (VSTART_DEFINED | VFOLLOWS_DEFINED))) {
424 if (g->flags & VALIGN_DEFINED)
425 g->vstart = (pend + g->valign - 1) & ~(g->valign - 1);
427 g->vstart = g->start;
428 g->flags |= VSTART_DEFINED;
430 /* Ignore zero-length sections. */
433 /* Compute the span of this section. */
434 pend = g->start + g->length;
435 /* Check for section overlap. */
437 if (g->start > s->start)
438 error(ERR_FATAL, "sections %s ~ %s and %s overlap!",
439 gs->name, g->name, s->name);
441 error(ERR_FATAL, "sections %s and %s overlap!",
444 /* Remember this section as the latest >0 length section. */
448 /* Step 4: Compute vstart addresses for all sections. */
450 /* Attach the nobits sections to the end of the progbits sections. */
451 for (s = sections; s->next; s = s->next) ;
454 /* Scan for sections that don't have a vstart address. If we find one we'll
455 * attempt to compute its vstart. If we can't compute the vstart, we leave
456 * it alone and come back to it in a subsequent scan. We continue scanning
457 * and re-scanning until we've gone one full cycle without computing any
459 do { /* Do one full scan of the sections list. */
460 for (h = 0, g = sections; g; g = g->next) {
461 if (g->flags & VSTART_DEFINED)
463 /* Find the section that this one virtually follows. */
464 if (g->flags & VFOLLOWS_DEFINED) {
465 for (s = sections; s && strcmp(g->vfollows, s->name);
469 "section %s vfollows unknown section (%s)",
470 g->name, g->vfollows);
471 } else if (g->ifollows != NULL)
472 for (s = sections; s && (s != g->ifollows); s = s->next) ;
473 /* The .bss section is the only one with ifollows = NULL. In this case we
474 * implicitly follow the last progbits section. */
478 /* If the section we're following has a vstart, we can proceed. */
479 if (s->flags & VSTART_DEFINED) { /* Default to virtual alignment of four. */
480 if (!(g->flags & VALIGN_DEFINED)) {
482 g->flags |= VALIGN_DEFINED;
484 /* Compute the vstart address. */
486 (s->vstart + s->length + g->valign - 1) & ~(g->valign -
488 g->flags |= VSTART_DEFINED;
490 /* Start and vstart mean the same thing for nobits sections. */
491 if (g->flags & TYPE_NOBITS)
492 g->start = g->vstart;
497 /* Now check for any circular vfollows references, which will manifest
498 * themselves as sections without a defined vstart. */
499 for (h = 0, s = sections; s; s = s->next) {
500 if (!(s->flags & VSTART_DEFINED)) { /* Non-fatal errors after assembly has completed are generally a
501 * no-no, but we'll throw a fatal one eventually so it's ok. */
502 error(ERR_NONFATAL, "cannot compute vstart for section %s",
508 error(ERR_FATAL, "circular vfollows path detected");
512 "bin_cleanup: Confirm final section order for output file:\n");
513 for (h = 0, s = sections; s && (s->flags & TYPE_PROGBITS);
515 fprintf(stdout, "%i. %s\n", h, s->name);
518 /* Step 5: Apply relocations. */
520 /* Prepare the sections for relocating. */
521 for (s = sections; s; s = s->next)
522 saa_rewind(s->contents);
523 /* Apply relocations. */
524 for (r = relocs; r; r = r->next) {
525 uint8_t *p, *q, mydata[8];
528 saa_fread(r->target->contents, r->posn, mydata, r->bytes);
533 l += ((int64_t)*p++) << 8;
535 l += ((int64_t)*p++) << 16;
536 l += ((int64_t)*p++) << 24;
539 l += ((int64_t)*p++) << 32;
540 l += ((int64_t)*p++) << 40;
541 l += ((int64_t)*p++) << 48;
542 l += ((int64_t)*p++) << 56;
546 s = find_section_by_index(r->secref);
548 if (r->secref == s->start_index)
553 s = find_section_by_index(r->secrel);
555 if (r->secrel == s->start_index)
563 else if (r->bytes == 2)
566 *q++ = (uint8_t)(l & 0xFF);
567 saa_fwrite(r->target->contents, r->posn, mydata, r->bytes);
570 /* Step 6: Write the section data to the output file. */
572 /* Write the progbits sections to the output file. */
573 for (pend = origin, s = sections; s && (s->flags & TYPE_PROGBITS); s = s->next) { /* Skip zero-length sections. */
576 /* Pad the space between sections. */
577 for (h = s->start - pend; h; h--)
579 /* Write the section to the output file. */
581 saa_fpwrite(s->contents, fp);
582 pend = s->start + s->length;
584 /* Done writing the file, so close it. */
587 /* Step 7: Generate the map file. */
590 const char *not_defined = { "not defined" };
592 /* Display input and output file names. */
593 fprintf(rf, "\n- NASM Map file ");
596 fprintf(rf, "\n\nSource file: %s\nOutput file: %s\n\n",
599 if (map_control & MAP_ORIGIN) { /* Display program origin. */
600 fprintf(rf, "-- Program origin ");
603 fprintf(rf, "\n\n%08"PRIX64"\n\n", origin);
605 /* Display sections summary. */
606 if (map_control & MAP_SUMMARY) {
607 fprintf(rf, "-- Sections (summary) ");
610 fprintf(rf, "\n\nVstart Start Stop "
611 "Length Class Name\n");
612 for (s = sections; s; s = s->next) {
613 fprintf(rf, "%16"PRIX64" %16"PRIX64" %16"PRIX64" %08"PRIX64" ",
614 s->vstart, s->start, s->start + s->length,
616 if (s->flags & TYPE_PROGBITS)
617 fprintf(rf, "progbits ");
619 fprintf(rf, "nobits ");
620 fprintf(rf, "%s\n", s->name);
624 /* Display detailed section information. */
625 if (map_control & MAP_SECTIONS) {
626 fprintf(rf, "-- Sections (detailed) ");
630 for (s = sections; s; s = s->next) {
631 fprintf(rf, "---- Section %s ", s->name);
632 for (h = 65 - strlen(s->name); h; h--)
634 fprintf(rf, "\n\nclass: ");
635 if (s->flags & TYPE_PROGBITS)
636 fprintf(rf, "progbits");
638 fprintf(rf, "nobits");
639 fprintf(rf, "\nlength: %16"PRIX64"\nstart: %16"PRIX64""
640 "\nalign: ", s->length, s->start);
641 if (s->flags & ALIGN_DEFINED)
642 fprintf(rf, "%16"PRIX64"", s->align);
644 fprintf(rf, not_defined);
645 fprintf(rf, "\nfollows: ");
646 if (s->flags & FOLLOWS_DEFINED)
647 fprintf(rf, "%s", s->follows);
649 fprintf(rf, not_defined);
650 fprintf(rf, "\nvstart: %16"PRIX64"\nvalign: ", s->vstart);
651 if (s->flags & VALIGN_DEFINED)
652 fprintf(rf, "%16"PRIX64"", s->valign);
654 fprintf(rf, not_defined);
655 fprintf(rf, "\nvfollows: ");
656 if (s->flags & VFOLLOWS_DEFINED)
657 fprintf(rf, "%s", s->vfollows);
659 fprintf(rf, not_defined);
663 /* Display symbols information. */
664 if (map_control & MAP_SYMBOLS) {
668 fprintf(rf, "-- Symbols ");
673 fprintf(rf, "---- No Section ");
676 fprintf(rf, "\n\nValue Name\n");
677 for (l = no_seg_labels; l; l = l->next) {
678 lookup_label(l->name, &segment, &offset);
679 fprintf(rf, "%08"PRIX64" %s\n", offset, l->name);
683 for (s = sections; s; s = s->next) {
685 fprintf(rf, "---- Section %s ", s->name);
686 for (h = 65 - strlen(s->name); h; h--)
688 fprintf(rf, "\n\nReal Virtual Name\n");
689 for (l = s->labels; l; l = l->next) {
690 lookup_label(l->name, &segment, &offset);
691 fprintf(rf, "%16"PRIX64" %16"PRIX64" %s\n",
692 s->start + offset, s->vstart + offset,
701 /* Close the report file. */
702 if (map_control && (rf != stdout) && (rf != stderr))
705 /* Step 8: Release all allocated memory. */
707 /* Free sections, label pointer structs, etc.. */
711 saa_free(s->contents);
713 if (s->flags & FOLLOWS_DEFINED)
714 nasm_free(s->follows);
715 if (s->flags & VFOLLOWS_DEFINED)
716 nasm_free(s->vfollows);
725 /* Free no-section labels. */
726 while (no_seg_labels) {
728 no_seg_labels = l->next;
732 /* Free relocation structures. */
740 static void bin_out(int32_t segto, const void *data, uint32_t type,
741 int32_t segment, int32_t wrt)
743 uint8_t *p, mydata[8];
749 wrt = NO_SEG; /* continue to do _something_ */
750 error(ERR_NONFATAL, "WRT not supported by binary output format");
753 /* Handle absolute-assembly (structure definitions). */
754 if (segto == NO_SEG) {
755 if ((type & OUT_TYPMASK) != OUT_RESERVE)
756 error(ERR_NONFATAL, "attempt to assemble code in"
757 " [ABSOLUTE] space");
761 /* Find the segment we are targeting. */
762 s = find_section_by_index(segto);
764 error(ERR_PANIC, "code directed to nonexistent segment?");
766 /* "Smart" section-type adaptation code. */
767 if (!(s->flags & TYPE_DEFINED)) {
768 if ((type & OUT_TYPMASK) == OUT_RESERVE)
769 s->flags |= TYPE_DEFINED | TYPE_NOBITS;
771 s->flags |= TYPE_DEFINED | TYPE_PROGBITS;
774 if ((s->flags & TYPE_NOBITS) && ((type & OUT_TYPMASK) != OUT_RESERVE))
775 error(ERR_WARNING, "attempt to initialize memory in a"
776 " nobits section: ignored");
778 if ((type & OUT_TYPMASK) == OUT_ADDRESS) {
779 if (segment != NO_SEG && !find_section_by_index(segment)) {
781 error(ERR_NONFATAL, "binary output format does not support"
782 " segment base references");
784 error(ERR_NONFATAL, "binary output format does not support"
785 " external references");
788 if (s->flags & TYPE_PROGBITS) {
789 if (segment != NO_SEG)
790 add_reloc(s, type & OUT_SIZMASK, segment, -1L);
792 if ((type & OUT_SIZMASK) == 4)
793 WRITELONG(p, *(int32_t *)data);
794 else if ((type & OUT_SIZMASK) == 8)
795 WRITEDLONG(p, *(int64_t *)data);
797 WRITESHORT(p, *(int32_t *)data);
798 saa_wbytes(s->contents, mydata, type & OUT_SIZMASK);
800 s->length += type & OUT_SIZMASK;
801 } else if ((type & OUT_TYPMASK) == OUT_RAWDATA) {
803 if (s->flags & TYPE_PROGBITS)
804 saa_wbytes(s->contents, data, type);
806 } else if ((type & OUT_TYPMASK) == OUT_RESERVE) {
808 if (s->flags & TYPE_PROGBITS) {
809 error(ERR_WARNING, "uninitialized space declared in"
810 " %s section: zeroing", s->name);
811 saa_wbytes(s->contents, NULL, type);
814 } else if ((type & OUT_TYPMASK) == OUT_REL2ADR ||
815 (type & OUT_TYPMASK) == OUT_REL4ADR) {
816 realbytes = (type & OUT_TYPMASK);
817 if (realbytes == OUT_REL2ADR)
821 if (segment != NO_SEG && !find_section_by_index(segment)) {
823 error(ERR_NONFATAL, "binary output format does not support"
824 " segment base references");
826 error(ERR_NONFATAL, "binary output format does not support"
827 " external references");
830 if (s->flags & TYPE_PROGBITS) {
831 add_reloc(s, realbytes, segment, segto);
834 WRITELONG(p, *(int32_t *)data - realbytes - s->length);
836 WRITESHORT(p, *(int32_t *)data - realbytes - s->length);
837 saa_wbytes(s->contents, mydata, realbytes);
839 s->length += realbytes;
843 static void bin_deflabel(char *name, int32_t segment, int64_t offset,
844 int is_global, char *special)
846 (void)segment; /* Don't warn that this parameter is unused */
847 (void)offset; /* Don't warn that this parameter is unused */
850 error(ERR_NONFATAL, "binary format does not support any"
851 " special symbol types");
852 else if (name[0] == '.' && name[1] == '.' && name[2] != '@')
853 error(ERR_NONFATAL, "unrecognised special symbol `%s'", name);
854 else if (is_global == 2)
855 error(ERR_NONFATAL, "binary output format does not support common"
859 struct bin_label ***ltp;
861 /* Remember label definition so we can look it up later when
862 * creating the map file. */
863 s = find_section_by_index(segment);
865 ltp = &(s->labels_end);
868 (**ltp) = nasm_malloc(sizeof(struct bin_label));
869 (**ltp)->name = name;
870 (**ltp)->next = NULL;
871 *ltp = &((**ltp)->next);
876 /* These constants and the following function are used
877 * by bin_secname() to parse attribute assignments. */
879 enum { ATTRIB_START, ATTRIB_ALIGN, ATTRIB_FOLLOWS,
880 ATTRIB_VSTART, ATTRIB_VALIGN, ATTRIB_VFOLLOWS,
881 ATTRIB_NOBITS, ATTRIB_PROGBITS
884 static int bin_read_attribute(char **line, int *attribute,
888 int attrib_name_size;
889 struct tokenval tokval;
892 /* Skip whitespace. */
893 while (**line && isspace(**line))
898 /* Figure out what attribute we're reading. */
899 if (!nasm_strnicmp(*line, "align=", 6)) {
900 *attribute = ATTRIB_ALIGN;
901 attrib_name_size = 6;
902 } else if (format_mode) {
903 if (!nasm_strnicmp(*line, "start=", 6)) {
904 *attribute = ATTRIB_START;
905 attrib_name_size = 6;
906 } else if (!nasm_strnicmp(*line, "follows=", 8)) {
907 *attribute = ATTRIB_FOLLOWS;
910 } else if (!nasm_strnicmp(*line, "vstart=", 7)) {
911 *attribute = ATTRIB_VSTART;
912 attrib_name_size = 7;
913 } else if (!nasm_strnicmp(*line, "valign=", 7)) {
914 *attribute = ATTRIB_VALIGN;
915 attrib_name_size = 7;
916 } else if (!nasm_strnicmp(*line, "vfollows=", 9)) {
917 *attribute = ATTRIB_VFOLLOWS;
920 } else if (!nasm_strnicmp(*line, "nobits", 6) &&
921 (isspace((*line)[6]) || ((*line)[6] == '\0'))) {
922 *attribute = ATTRIB_NOBITS;
925 } else if (!nasm_strnicmp(*line, "progbits", 8) &&
926 (isspace((*line)[8]) || ((*line)[8] == '\0'))) {
927 *attribute = ATTRIB_PROGBITS;
935 /* Find the end of the expression. */
936 if ((*line)[attrib_name_size] != '(') {
937 /* Single term (no parenthesis). */
938 exp = *line += attrib_name_size;
939 while (**line && !isspace(**line))
949 /* Full expression (delimited by parenthesis) */
950 exp = *line += attrib_name_size + 1;
952 (*line) += strcspn(*line, "()'\"");
963 if ((**line == '"') || (**line == '\'')) {
972 "invalid syntax in `section' directive");
978 error(ERR_NONFATAL, "expecting `)'");
982 *(*line - 1) = '\0'; /* Terminate the expression. */
985 /* Check for no value given. */
987 error(ERR_WARNING, "No value given to attribute in"
988 " `section' directive");
992 /* Read and evaluate the expression. */
994 stdscan_bufptr = exp;
995 tokval.t_type = TOKEN_INVALID;
996 e = evaluate(stdscan, NULL, &tokval, NULL, 1, error, NULL);
998 if (!is_really_simple(e)) {
999 error(ERR_NONFATAL, "section attribute value must be"
1000 " a critical expression");
1004 error(ERR_NONFATAL, "Invalid attribute value"
1005 " specified in `section' directive.");
1008 *value = (uint64_t)reloc_value(e);
1012 static void bin_assign_attributes(struct Section *sec, char *astring)
1014 int attribute, check;
1018 while (1) { /* Get the next attribute. */
1019 check = bin_read_attribute(&astring, &attribute, &value);
1020 /* Skip bad attribute. */
1023 /* Unknown section attribute, so skip it and warn the user. */
1026 break; /* End of line. */
1029 while (*astring && !isspace(*astring))
1035 error(ERR_WARNING, "ignoring unknown section attribute:"
1041 switch (attribute) { /* Handle nobits attribute. */
1043 if ((sec->flags & TYPE_DEFINED)
1044 && (sec->flags & TYPE_PROGBITS))
1046 "attempt to change section type"
1047 " from progbits to nobits");
1049 sec->flags |= TYPE_DEFINED | TYPE_NOBITS;
1052 /* Handle progbits attribute. */
1053 case ATTRIB_PROGBITS:
1054 if ((sec->flags & TYPE_DEFINED) && (sec->flags & TYPE_NOBITS))
1055 error(ERR_NONFATAL, "attempt to change section type"
1056 " from nobits to progbits");
1058 sec->flags |= TYPE_DEFINED | TYPE_PROGBITS;
1061 /* Handle align attribute. */
1063 if (!format_mode && (!strcmp(sec->name, ".text")))
1064 error(ERR_NONFATAL, "cannot specify an alignment"
1065 " to the .text section");
1067 if (!value || ((value - 1) & value))
1068 error(ERR_NONFATAL, "argument to `align' is not a"
1070 else { /* Alignment is already satisfied if the previous
1071 * align value is greater. */
1072 if ((sec->flags & ALIGN_DEFINED)
1073 && (value < sec->align))
1076 /* Don't allow a conflicting align value. */
1077 if ((sec->flags & START_DEFINED)
1078 && (sec->start & (value - 1)))
1080 "`align' value conflicts "
1081 "with section start address");
1084 sec->flags |= ALIGN_DEFINED;
1090 /* Handle valign attribute. */
1092 if (!value || ((value - 1) & value))
1093 error(ERR_NONFATAL, "argument to `valign' is not a"
1095 else { /* Alignment is already satisfied if the previous
1096 * align value is greater. */
1097 if ((sec->flags & VALIGN_DEFINED) && (value < sec->valign))
1098 value = sec->valign;
1100 /* Don't allow a conflicting valign value. */
1101 if ((sec->flags & VSTART_DEFINED)
1102 && (sec->vstart & (value - 1)))
1104 "`valign' value conflicts "
1105 "with `vstart' address");
1107 sec->valign = value;
1108 sec->flags |= VALIGN_DEFINED;
1113 /* Handle start attribute. */
1115 if (sec->flags & FOLLOWS_DEFINED)
1116 error(ERR_NONFATAL, "cannot combine `start' and `follows'"
1117 " section attributes");
1118 else if ((sec->flags & START_DEFINED) && (value != sec->start))
1119 error(ERR_NONFATAL, "section start address redefined");
1122 sec->flags |= START_DEFINED;
1123 if (sec->flags & ALIGN_DEFINED) {
1124 if (sec->start & (sec->align - 1))
1125 error(ERR_NONFATAL, "`start' address conflicts"
1126 " with section alignment");
1127 sec->flags ^= ALIGN_DEFINED;
1132 /* Handle vstart attribute. */
1134 if (sec->flags & VFOLLOWS_DEFINED)
1136 "cannot combine `vstart' and `vfollows'"
1137 " section attributes");
1138 else if ((sec->flags & VSTART_DEFINED)
1139 && (value != sec->vstart))
1141 "section virtual start address"
1142 " (vstart) redefined");
1144 sec->vstart = value;
1145 sec->flags |= VSTART_DEFINED;
1146 if (sec->flags & VALIGN_DEFINED) {
1147 if (sec->vstart & (sec->valign - 1))
1148 error(ERR_NONFATAL, "`vstart' address conflicts"
1149 " with `valign' value");
1150 sec->flags ^= VALIGN_DEFINED;
1155 /* Handle follows attribute. */
1156 case ATTRIB_FOLLOWS:
1158 astring += strcspn(astring, " \t");
1160 error(ERR_NONFATAL, "expecting section name for `follows'"
1163 *(astring++) = '\0';
1164 if (sec->flags & START_DEFINED)
1166 "cannot combine `start' and `follows'"
1167 " section attributes");
1168 sec->follows = nasm_strdup(p);
1169 sec->flags |= FOLLOWS_DEFINED;
1173 /* Handle vfollows attribute. */
1174 case ATTRIB_VFOLLOWS:
1175 if (sec->flags & VSTART_DEFINED)
1177 "cannot combine `vstart' and `vfollows'"
1178 " section attributes");
1181 astring += strcspn(astring, " \t");
1184 "expecting section name for `vfollows'"
1187 *(astring++) = '\0';
1188 sec->vfollows = nasm_strdup(p);
1189 sec->flags |= VFOLLOWS_DEFINED;
1197 static void bin_define_section_labels(void)
1199 static int labels_defined = 0;
1200 struct Section *sec;
1206 for (sec = sections; sec; sec = sec->next) {
1207 base_len = strlen(sec->name) + 8;
1208 label_name = nasm_malloc(base_len + 8);
1209 strcpy(label_name, "section.");
1210 strcpy(label_name + 8, sec->name);
1212 /* section.<name>.start */
1213 strcpy(label_name + base_len, ".start");
1214 define_label(label_name, sec->start_index, 0L,
1215 NULL, 0, 0, bin_get_ofmt(), error);
1217 /* section.<name>.vstart */
1218 strcpy(label_name + base_len, ".vstart");
1219 define_label(label_name, sec->vstart_index, 0L,
1220 NULL, 0, 0, bin_get_ofmt(), error);
1222 nasm_free(label_name);
1227 static int32_t bin_secname(char *name, int pass, int *bits)
1230 struct Section *sec;
1232 /* bin_secname is called with *name = NULL at the start of each
1233 * pass. Use this opportunity to establish the default section
1234 * (default is BITS-16 ".text" segment).
1236 if (!name) { /* Reset ORG and section attributes at the start of each pass. */
1238 for (sec = sections; sec; sec = sec->next)
1239 sec->flags &= ~(START_DEFINED | VSTART_DEFINED |
1240 ALIGN_DEFINED | VALIGN_DEFINED);
1242 /* Define section start and vstart labels. */
1243 if (format_mode && (pass != 1))
1244 bin_define_section_labels();
1246 /* Establish the default (.text) section. */
1248 sec = find_section_by_name(".text");
1249 sec->flags |= TYPE_DEFINED | TYPE_PROGBITS;
1250 current_section = sec->vstart_index;
1251 return current_section;
1254 /* Attempt to find the requested section. If it does not
1255 * exist, create it. */
1257 while (*p && !isspace(*p))
1261 sec = find_section_by_name(name);
1263 sec = create_section(name);
1264 if (!strcmp(name, ".data"))
1265 sec->flags |= TYPE_DEFINED | TYPE_PROGBITS;
1266 else if (!strcmp(name, ".bss")) {
1267 sec->flags |= TYPE_DEFINED | TYPE_NOBITS;
1268 sec->ifollows = NULL;
1269 } else if (!format_mode) {
1270 error(ERR_NONFATAL, "section name must be "
1271 ".text, .data, or .bss");
1272 return current_section;
1276 /* Handle attribute assignments. */
1278 bin_assign_attributes(sec, p);
1280 #ifndef ABIN_SMART_ADAPT
1281 /* The following line disables smart adaptation of
1282 * PROGBITS/NOBITS section types (it forces sections to
1283 * default to PROGBITS). */
1284 if ((pass != 1) && !(sec->flags & TYPE_DEFINED))
1285 sec->flags |= TYPE_DEFINED | TYPE_PROGBITS;
1288 /* Set the current section and return. */
1289 current_section = sec->vstart_index;
1290 return current_section;
1293 static int bin_directive(char *directive, char *args, int pass)
1295 /* Handle ORG directive */
1296 if (!nasm_stricmp(directive, "org")) {
1297 struct tokenval tokval;
1302 stdscan_bufptr = args;
1303 tokval.t_type = TOKEN_INVALID;
1304 e = evaluate(stdscan, NULL, &tokval, NULL, 1, error, NULL);
1306 if (!is_really_simple(e))
1307 error(ERR_NONFATAL, "org value must be a critical"
1310 value = reloc_value(e);
1311 /* Check for ORG redefinition. */
1312 if (origin_defined && (value != origin))
1313 error(ERR_NONFATAL, "program origin redefined");
1320 error(ERR_NONFATAL, "No or invalid offset specified"
1321 " in ORG directive.");
1325 /* The 'map' directive allows the user to generate section
1326 * and symbol information to stdout, stderr, or to a file. */
1327 else if (format_mode && !nasm_stricmp(directive, "map")) {
1332 args += strspn(args, " \t");
1335 args += strcspn(args, " \t");
1338 if (!nasm_stricmp(p, "all"))
1340 MAP_ORIGIN | MAP_SUMMARY | MAP_SECTIONS | MAP_SYMBOLS;
1341 else if (!nasm_stricmp(p, "brief"))
1342 map_control |= MAP_ORIGIN | MAP_SUMMARY;
1343 else if (!nasm_stricmp(p, "sections"))
1344 map_control |= MAP_ORIGIN | MAP_SUMMARY | MAP_SECTIONS;
1345 else if (!nasm_stricmp(p, "segments"))
1346 map_control |= MAP_ORIGIN | MAP_SUMMARY | MAP_SECTIONS;
1347 else if (!nasm_stricmp(p, "symbols"))
1348 map_control |= MAP_SYMBOLS;
1350 if (!nasm_stricmp(p, "stdout"))
1352 else if (!nasm_stricmp(p, "stderr"))
1354 else { /* Must be a filename. */
1355 rf = fopen(p, "wt");
1357 error(ERR_WARNING, "unable to open map file `%s'",
1364 error(ERR_WARNING, "map file already specified");
1366 if (map_control == 0)
1367 map_control |= MAP_ORIGIN | MAP_SUMMARY;
1375 static void bin_filename(char *inname, char *outname, efunc error)
1377 standard_extension(inname, outname, "", error);
1382 static int32_t bin_segbase(int32_t segment)
1387 static int bin_set_info(enum geninfo type, char **val)
1394 static void bin_init(FILE * afp, efunc errfunc, ldfunc ldef, evalfunc eval)
1399 (void)eval; /* Don't warn that this parameter is unused. */
1400 (void)ldef; /* Placate optimizers. */
1402 maxbits = 64; /* Support 64-bit Segments */
1404 reloctail = &relocs;
1406 no_seg_labels = NULL;
1407 nsl_tail = &no_seg_labels;
1408 format_mode = 1; /* Extended bin format
1409 * (set this to zero for old bin format). */
1411 /* Create default section (.text). */
1412 sections = last_section = nasm_malloc(sizeof(struct Section));
1413 last_section->next = NULL;
1414 last_section->name = nasm_strdup(".text");
1415 last_section->contents = saa_init(1L);
1416 last_section->follows = last_section->vfollows = 0;
1417 last_section->ifollows = NULL;
1418 last_section->length = 0;
1419 last_section->flags = TYPE_DEFINED | TYPE_PROGBITS;
1420 last_section->labels = NULL;
1421 last_section->labels_end = &(last_section->labels);
1422 last_section->start_index = seg_alloc();
1423 last_section->vstart_index = current_section = seg_alloc();
1426 struct ofmt of_bin = {
1427 "flat-form binary files (e.g. DOS .COM, .SYS)",
1444 /* This is needed for bin_define_section_labels() */
1445 struct ofmt *bin_get_ofmt(void)
1450 #endif /* #ifdef OF_BIN */