1 /* outcoff.c output routines for the Netwide Assembler to produce
2 * COFF object files (for DJGPP and Win32)
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.
20 #if defined(OF_COFF) || defined(OF_WIN32)
25 * (0) When I say `standard COFF' below, I mean `COFF as output and
26 * used by DJGPP'. I assume DJGPP gets it right.
28 * (1) Win32 appears to interpret the term `relative relocation'
29 * differently from standard COFF. Standard COFF understands a
30 * relative relocation to mean that during relocation you add the
31 * address of the symbol you're referencing, and subtract the base
32 * address of the section you're in. Win32 COFF, by contrast, seems
33 * to add the address of the symbol and then subtract the address
34 * of THE BYTE AFTER THE RELOCATED DWORD. Hence the two formats are
35 * subtly incompatible.
37 * (2) Win32 doesn't bother putting any flags in the header flags
38 * field (at offset 0x12 into the file).
40 * (3) Win32 uses some extra flags into the section header table:
41 * it defines flags 0x80000000 (writable), 0x40000000 (readable)
42 * and 0x20000000 (executable), and uses them in the expected
43 * combinations. It also defines 0x00100000 through 0x00700000 for
44 * section alignments of 1 through 64 bytes.
46 * (4) Both standard COFF and Win32 COFF seem to use the DWORD
47 * field directly after the section name in the section header
48 * table for something strange: they store what the address of the
49 * section start point _would_ be, if you laid all the sections end
50 * to end starting at zero. Dunno why. Microsoft's documentation
51 * lists this field as "Virtual Size of Section", which doesn't
52 * seem to fit at all. In fact, Win32 even includes non-linked
53 * sections such as .drectve in this calculation.
55 * (5) Standard COFF does something very strange to common
56 * variables: the relocation point for a common variable is as far
57 * _before_ the variable as its size stretches out _after_ it. So
58 * we must fix up common variable references. Win32 seems to be
59 * sensible on this one.
62 /* Flag which version of COFF we are currently outputting. */
67 long address
; /* relative to _start_ of section */
68 long symbol
; /* symbol number */
73 } symbase
; /* relocation for symbol number :) */
74 int relative
; /* TRUE or FALSE */
79 long strpos
; /* string table position of name */
80 int section
; /* section number where it's defined
81 * - in COFF codes, not NASM codes */
82 int is_global
; /* is it a global symbol or not? */
83 long value
; /* address, or COMMON variable size */
88 static char coff_infile
[FILENAME_MAX
];
95 struct Reloc
*head
, **tail
;
96 unsigned long flags
; /* section flags */
101 #define TEXT_FLAGS (win32 ? 0x60500020L : 0x20L)
102 #define DATA_FLAGS (win32 ? 0xC0300040L : 0x40L)
103 #define BSS_FLAGS (win32 ? 0xC0300080L : 0x80L)
104 #define INFO_FLAGS 0x00100A00L
105 #define RDATA_FLAGS (win32 ? 0x40400040L : 0x40L)
107 #define SECT_DELTA 32
108 static struct Section
**sects
;
109 static int nsects
, sectlen
;
111 static struct SAA
*syms
;
112 static unsigned long nsyms
;
118 static struct RAA
*bsym
, *symval
;
120 static struct SAA
*strs
;
121 static unsigned long strslen
;
123 static void coff_gen_init(FILE *, efunc
);
124 static void coff_sect_write(struct Section
*, const unsigned char *,
126 static void coff_write(void);
127 static void coff_section_header(char *, long, long, long, long, int, long);
128 static void coff_write_relocs(struct Section
*);
129 static void coff_write_symbols(void);
131 static void coff_win32_init(FILE * fp
, efunc errfunc
,
132 ldfunc ldef
, evalfunc eval
)
135 (void)ldef
; /* placate optimisers */
136 coff_gen_init(fp
, errfunc
);
139 static void coff_std_init(FILE * fp
, efunc errfunc
, ldfunc ldef
,
143 (void)ldef
; /* placate optimisers */
144 coff_gen_init(fp
, errfunc
);
147 static void coff_gen_init(FILE * fp
, efunc errfunc
)
153 nsects
= sectlen
= 0;
154 syms
= saa_init((long)sizeof(struct Symbol
));
160 def_seg
= seg_alloc();
163 static void coff_cleanup(int debuginfo
)
172 for (i
= 0; i
< nsects
; i
++) {
174 saa_free(sects
[i
]->data
);
175 while (sects
[i
]->head
) {
177 sects
[i
]->head
= sects
[i
]->head
->next
;
189 static int coff_make_section(char *name
, unsigned long flags
)
193 s
= nasm_malloc(sizeof(*s
));
195 if (flags
!= BSS_FLAGS
)
196 s
->data
= saa_init(1L);
203 if (!strcmp(name
, ".text"))
206 s
->index
= seg_alloc();
207 strncpy(s
->name
, name
, 8);
211 if (nsects
>= sectlen
)
213 nasm_realloc(sects
, (sectlen
+= SECT_DELTA
) * sizeof(*sects
));
219 static long coff_section_names(char *name
, int pass
, int *bits
)
222 unsigned long flags
, align_and
= ~0L, align_or
= 0L;
226 * Default is 32 bits.
235 while (*p
&& !isspace(*p
))
239 if (strlen(name
) > 8) {
240 error(ERR_WARNING
, "COFF section names limited to 8 characters:"
246 while (*p
&& isspace(*p
))
250 while (*p
&& !isspace(*p
))
254 while (*p
&& isspace(*p
))
257 if (!nasm_stricmp(q
, "code") || !nasm_stricmp(q
, "text")) {
259 } else if (!nasm_stricmp(q
, "data")) {
261 } else if (!nasm_stricmp(q
, "rdata")) {
265 flags
= DATA_FLAGS
; /* gotta do something */
266 error(ERR_NONFATAL
, "standard COFF does not support"
267 " read-only data sections");
269 } else if (!nasm_stricmp(q
, "bss")) {
271 } else if (!nasm_stricmp(q
, "info")) {
275 flags
= DATA_FLAGS
; /* gotta do something */
276 error(ERR_NONFATAL
, "standard COFF does not support"
277 " informational sections");
279 } else if (!nasm_strnicmp(q
, "align=", 6)) {
281 error(ERR_NONFATAL
, "standard COFF does not support"
282 " section alignment specification");
284 if (q
[6 + strspn(q
+ 6, "0123456789")])
286 "argument to `align' is not numeric");
288 unsigned int align
= atoi(q
+ 6);
289 if (!align
|| ((align
- 1) & align
))
290 error(ERR_NONFATAL
, "argument to `align' is not a"
293 error(ERR_NONFATAL
, "Win32 cannot align sections"
294 " to better than 64-byte boundaries");
296 align_and
= ~0x00F00000L
;
297 align_or
= (align
== 1 ? 0x00100000L
:
298 align
== 2 ? 0x00200000L
:
299 align
== 4 ? 0x00300000L
:
300 align
== 8 ? 0x00400000L
:
301 align
== 16 ? 0x00500000L
:
303 32 ? 0x00600000L
: 0x00700000L
);
310 for (i
= 0; i
< nsects
; i
++)
311 if (!strcmp(name
, sects
[i
]->name
))
315 if (!strcmp(name
, ".data"))
317 else if (!strcmp(name
, ".rdata"))
319 else if (!strcmp(name
, ".bss"))
324 i
= coff_make_section(name
, flags
);
326 sects
[i
]->flags
= flags
;
327 sects
[i
]->flags
&= align_and
;
328 sects
[i
]->flags
|= align_or
;
329 } else if (pass
== 1) {
331 error(ERR_WARNING
, "section attributes ignored on"
332 " redeclaration of section `%s'", name
);
335 return sects
[i
]->index
;
338 static void coff_deflabel(char *name
, long segment
, long offset
,
339 int is_global
, char *special
)
341 int pos
= strslen
+ 4;
345 error(ERR_NONFATAL
, "binary format does not support any"
346 " special symbol types");
348 if (name
[0] == '.' && name
[1] == '.' && name
[2] != '@') {
349 error(ERR_NONFATAL
, "unrecognised special symbol `%s'", name
);
353 if (strlen(name
) > 8) {
354 saa_wbytes(strs
, name
, (long)(1 + strlen(name
)));
355 strslen
+= 1 + strlen(name
);
359 sym
= saa_wstruct(syms
);
363 strcpy(sym
->name
, name
);
364 sym
->is_global
= !!is_global
;
365 if (segment
== NO_SEG
)
366 sym
->section
= -1; /* absolute symbol */
370 for (i
= 0; i
< nsects
; i
++)
371 if (segment
== sects
[i
]->index
) {
372 sym
->section
= i
+ 1;
376 sym
->is_global
= TRUE
;
381 sym
->value
= (sym
->section
== 0 ? 0 : offset
);
384 * define the references from external-symbol segment numbers
385 * to these symbol records.
387 if (sym
->section
== 0)
388 bsym
= raa_write(bsym
, segment
, nsyms
);
390 if (segment
!= NO_SEG
)
391 symval
= raa_write(symval
, segment
, sym
->section
? 0 : sym
->value
);
396 static long coff_add_reloc(struct Section
*sect
, long segment
,
401 r
= *sect
->tail
= nasm_malloc(sizeof(struct Reloc
));
402 sect
->tail
= &r
->next
;
405 r
->address
= sect
->len
;
406 if (segment
== NO_SEG
)
407 r
->symbol
= 0, r
->symbase
= ABS_SYMBOL
;
410 r
->symbase
= REAL_SYMBOLS
;
411 for (i
= 0; i
< nsects
; i
++)
412 if (segment
== sects
[i
]->index
) {
414 r
->symbase
= SECT_SYMBOLS
;
417 if (r
->symbase
== REAL_SYMBOLS
)
418 r
->symbol
= raa_read(bsym
, segment
);
420 r
->relative
= relative
;
425 * Return the fixup for standard COFF common variables.
427 if (r
->symbase
== REAL_SYMBOLS
&& !win32
)
428 return raa_read(symval
, segment
);
433 static void coff_out(long segto
, const void *data
, unsigned long type
,
434 long segment
, long wrt
)
437 long realbytes
= type
& OUT_SIZMASK
;
438 unsigned char mydata
[4], *p
;
442 wrt
= NO_SEG
; /* continue to do _something_ */
443 error(ERR_NONFATAL
, "WRT not supported by COFF output formats");
449 * handle absolute-assembly (structure definitions)
451 if (segto
== NO_SEG
) {
452 if (type
!= OUT_RESERVE
)
453 error(ERR_NONFATAL
, "attempt to assemble code in [ABSOLUTE]"
459 for (i
= 0; i
< nsects
; i
++)
460 if (segto
== sects
[i
]->index
) {
465 int tempint
; /* ignored */
466 if (segto
!= coff_section_names(".text", 2, &tempint
))
467 error(ERR_PANIC
, "strange segment conditions in COFF driver");
469 s
= sects
[nsects
- 1];
472 if (!s
->data
&& type
!= OUT_RESERVE
) {
473 error(ERR_WARNING
, "attempt to initialise memory in"
474 " BSS section `%s': ignored", s
->name
);
475 if (type
== OUT_REL2ADR
)
477 else if (type
== OUT_REL4ADR
)
483 if (type
== OUT_RESERVE
) {
485 error(ERR_WARNING
, "uninitialised space declared in"
486 " non-BSS section `%s': zeroing", s
->name
);
487 coff_sect_write(s
, NULL
, realbytes
);
490 } else if (type
== OUT_RAWDATA
) {
491 if (segment
!= NO_SEG
)
492 error(ERR_PANIC
, "OUT_RAWDATA with other than NO_SEG");
493 coff_sect_write(s
, data
, realbytes
);
494 } else if (type
== OUT_ADDRESS
) {
495 if (realbytes
!= 4 && (segment
!= NO_SEG
|| wrt
!= NO_SEG
))
496 error(ERR_NONFATAL
, "COFF format does not support non-32-bit"
500 if (segment
!= NO_SEG
|| wrt
!= NO_SEG
) {
502 error(ERR_NONFATAL
, "COFF format does not support"
504 } else if (segment
% 2) {
505 error(ERR_NONFATAL
, "COFF format does not support"
506 " segment base references");
508 fix
= coff_add_reloc(s
, segment
, FALSE
);
511 WRITELONG(p
, *(long *)data
+ fix
);
512 coff_sect_write(s
, mydata
, realbytes
);
514 } else if (type
== OUT_REL2ADR
) {
515 error(ERR_NONFATAL
, "COFF format does not support 16-bit"
517 } else if (type
== OUT_REL4ADR
) {
518 if (segment
== segto
)
519 error(ERR_PANIC
, "intra-segment OUT_REL4ADR");
520 else if (segment
== NO_SEG
&& win32
)
521 error(ERR_NONFATAL
, "Win32 COFF does not correctly support"
522 " relative references to absolute addresses");
525 if (segment
!= NO_SEG
&& segment
% 2) {
526 error(ERR_NONFATAL
, "COFF format does not support"
527 " segment base references");
529 fix
= coff_add_reloc(s
, segment
, TRUE
);
532 WRITELONG(p
, *(long *)data
+ 4 - realbytes
+ fix
);
534 WRITELONG(p
, *(long *)data
- (realbytes
+ s
->len
) + fix
);
536 coff_sect_write(s
, mydata
, 4L);
541 static void coff_sect_write(struct Section
*sect
,
542 const unsigned char *data
, unsigned long len
)
544 saa_wbytes(sect
->data
, data
, len
);
548 typedef struct tagString
{
549 struct tagString
*Next
;
554 #define EXPORT_SECTION_NAME ".drectve"
555 #define EXPORT_SECTION_FLAGS INFO_FLAGS
557 #define EXPORT_SECTION_NAME ".text"
558 #define EXPORT_SECTION_FLAGS TEXT_FLAGS
561 static STRING
*Exports
= NULL
;
562 static struct Section
*directive_sec
;
563 void AddExport(char *name
)
565 STRING
*rvp
= Exports
, *newS
;
567 newS
= (STRING
*) nasm_malloc(sizeof(STRING
));
568 newS
->len
= strlen(name
);
570 newS
->String
= (char *)nasm_malloc(newS
->len
+ 1);
571 strcpy(newS
->String
, name
);
574 for (i
= 0; i
< nsects
; i
++)
576 if (!strcmp(EXPORT_SECTION_NAME
, sects
[i
]->name
))
580 sects
[coff_make_section
581 (EXPORT_SECTION_NAME
, EXPORT_SECTION_FLAGS
)];
583 directive_sec
= sects
[i
];
587 if (!strcmp(rvp
->String
, name
))
595 void BuildExportTable(void)
597 STRING
*rvp
= Exports
, *next
;
598 unsigned char buf
[256];
603 len
= sprintf((char *)buf
, "-export:%s ", rvp
->String
);
604 coff_sect_write(directive_sec
, buf
, len
);
609 while ((rvp
= next
)) {
611 nasm_free(rvp
->String
);
617 static int coff_directives(char *directive
, char *value
, int pass
)
619 if (!strcmp(directive
, "export")) {
623 return 1; /* ignore in pass two */
625 while (*q
&& !isspace(*q
))
629 while (*q
&& isspace(*q
))
634 error(ERR_NONFATAL
, "`export' directive requires export name");
638 error(ERR_NONFATAL
, "unrecognised export qualifier `%s'", q
);
647 static void coff_write(void)
649 long pos
, sympos
, vsize
;
652 BuildExportTable(); /* fill in the .drectve section with -export's */
654 * Work out how big the file will get. Calculate the start of
655 * the `real' symbols at the same time.
657 pos
= 0x14 + 0x28 * nsects
;
658 initsym
= 3; /* two for the file, one absolute */
659 for (i
= 0; i
< nsects
; i
++) {
660 if (sects
[i
]->data
) {
662 pos
+= sects
[i
]->len
;
663 sects
[i
]->relpos
= pos
;
664 pos
+= 10 * sects
[i
]->nrelocs
;
666 sects
[i
]->pos
= sects
[i
]->relpos
= 0L;
667 initsym
+= 2; /* two for each section */
672 * Output the COFF header.
674 fwriteshort(0x14C, coffp
); /* MACHINE_i386 */
675 fwriteshort(nsects
, coffp
); /* number of sections */
676 fwritelong(time(NULL
), coffp
); /* time stamp */
677 fwritelong(sympos
, coffp
);
678 fwritelong(nsyms
+ initsym
, coffp
);
679 fwriteshort(0, coffp
); /* no optional header */
680 /* Flags: 32-bit, no line numbers. Win32 doesn't even bother with them. */
681 fwriteshort(win32
? 0 : 0x104, coffp
);
684 * Output the section headers.
687 for (i
= 0; i
< nsects
; i
++) {
688 coff_section_header(sects
[i
]->name
, vsize
, sects
[i
]->len
,
689 sects
[i
]->pos
, sects
[i
]->relpos
,
690 sects
[i
]->nrelocs
, sects
[i
]->flags
);
691 vsize
+= sects
[i
]->len
;
695 * Output the sections and their relocations.
697 for (i
= 0; i
< nsects
; i
++)
698 if (sects
[i
]->data
) {
699 saa_fpwrite(sects
[i
]->data
, coffp
);
700 coff_write_relocs(sects
[i
]);
704 * Output the symbol and string tables.
706 coff_write_symbols();
707 fwritelong(strslen
+ 4, coffp
); /* length includes length count */
708 saa_fpwrite(strs
, coffp
);
711 static void coff_section_header(char *name
, long vsize
,
712 long datalen
, long datapos
,
713 long relpos
, int nrelocs
, long flags
)
717 memset(padname
, 0, 8);
718 strncpy(padname
, name
, 8);
719 fwrite(padname
, 8, 1, coffp
);
720 fwritelong(vsize
, coffp
);
721 fwritelong(0L, coffp
); /* RVA/offset - we ignore */
722 fwritelong(datalen
, coffp
);
723 fwritelong(datapos
, coffp
);
724 fwritelong(relpos
, coffp
);
725 fwritelong(0L, coffp
); /* no line numbers - we don't do 'em */
726 fwriteshort(nrelocs
, coffp
);
727 fwriteshort(0, coffp
); /* again, no line numbers */
728 fwritelong(flags
, coffp
);
731 static void coff_write_relocs(struct Section
*s
)
735 for (r
= s
->head
; r
; r
= r
->next
) {
736 fwritelong(r
->address
, coffp
);
737 fwritelong(r
->symbol
+ (r
->symbase
== REAL_SYMBOLS
? initsym
:
738 r
->symbase
== ABS_SYMBOL
? initsym
- 1 :
739 r
->symbase
== SECT_SYMBOLS
? 2 : 0),
742 * Strange: Microsoft's COFF documentation says 0x03 for an
743 * absolute relocation, but both Visual C++ and DJGPP agree
744 * that in fact it's 0x06. I'll use 0x06 until someone
747 fwriteshort(r
->relative
? 0x14 : 0x06, coffp
);
751 static void coff_symbol(char *name
, long strpos
, long value
,
752 int section
, int type
, int aux
)
757 memset(padname
, 0, 8);
758 strncpy(padname
, name
, 8);
759 fwrite(padname
, 8, 1, coffp
);
761 fwritelong(0L, coffp
);
762 fwritelong(strpos
, coffp
);
764 fwritelong(value
, coffp
);
765 fwriteshort(section
, coffp
);
766 fwriteshort(0, coffp
);
771 static void coff_write_symbols(void)
777 * The `.file' record, and the file name auxiliary record.
779 coff_symbol(".file", 0L, 0L, -2, 0x67, 1);
780 memset(filename
, 0, 18);
781 strncpy(filename
, coff_infile
, 18);
782 fwrite(filename
, 18, 1, coffp
);
785 * The section records, with their auxiliaries.
787 memset(filename
, 0, 18); /* useful zeroed buffer */
789 for (i
= 0; i
< nsects
; i
++) {
790 coff_symbol(sects
[i
]->name
, 0L, 0L, i
+ 1, 3, 1);
791 fwritelong(sects
[i
]->len
, coffp
);
792 fwriteshort(sects
[i
]->nrelocs
, coffp
);
793 fwrite(filename
, 12, 1, coffp
);
797 * The absolute symbol, for relative-to-absolute relocations.
799 coff_symbol(".absolut", 0L, 0L, -1, 3, 0);
805 for (i
= 0; i
< nsyms
; i
++) {
806 struct Symbol
*sym
= saa_rstruct(syms
);
807 coff_symbol(sym
->strpos
== -1 ? sym
->name
: NULL
,
808 sym
->strpos
, sym
->value
, sym
->section
,
809 sym
->is_global
? 2 : 3, 0);
813 static long coff_segbase(long segment
)
818 static void coff_std_filename(char *inname
, char *outname
, efunc error
)
820 strcpy(coff_infile
, inname
);
821 standard_extension(inname
, outname
, ".o", error
);
824 static void coff_win32_filename(char *inname
, char *outname
, efunc error
)
826 strcpy(coff_infile
, inname
);
827 standard_extension(inname
, outname
, ".obj", error
);
830 static const char *coff_stdmac
[] = {
831 "%define __SECT__ [section .text]",
832 "%macro __NASM_CDecl__ 1",
834 "%imacro export 1+.nolist",
840 static int coff_set_info(enum geninfo type
, char **val
)
844 #endif /* defined(OF_COFF) || defined(OF_WIN32) */
848 struct ofmt of_coff
= {
849 "COFF (i386) object files (e.g. DJGPP for DOS)",
870 struct ofmt of_win32
= {
871 "Microsoft Win32 (i386) object files",