1 /* ----------------------------------------------------------------------- *
3 * Copyright 1996-2016 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 * outrdf2.c output routines for the Netwide Assembler to produce
36 * RDOFF version 2 format object files, which Julian originally
37 * planned to use it in his MOSCOW operating system.
55 /* VERBOSE_WARNINGS: define this to add some extra warnings... */
56 #define VERBOSE_WARNINGS
62 /* This signature is written to start of RDOFF files */
63 static const char *RDOFF2Id
= RDOFF2_SIGNATURE
;
65 /* Note that whenever a segment is referred to in the RDOFF file, its number
66 * is always half of the segment number that NASM uses to refer to it; this
67 * is because NASM only allocates even numbered segments, so as to not
68 * waste any of the 16 bits of segment number written to the file - this
69 * allows up to 65533 external labels to be defined; otherwise it would be
72 #define COUNT_SEGTYPES 9
74 static char *segmenttypes
[COUNT_SEGTYPES
] = {
75 "null", "text", "code", "data",
76 "comment", "lcomment", "pcomment",
77 "symdebug", "linedebug"
80 static int segmenttypenumbers
[COUNT_SEGTYPES
] = {
81 0, 1, 1, 2, 3, 4, 5, 6, 7
84 /* code for managing buffers needed to separate code and data into individual
85 * sections until they are ready to be written to the file.
86 * We'd better hope that it all fits in memory else we're buggered... */
88 #define BUF_BLOCK_LEN 4088 /* selected to match page size (4096)
89 * on 80x86 machines for efficiency */
91 /***********************************************************************
92 * Actual code to deal with RDOFF2 ouput format begins here...
95 /* global variables set during the initialisation phase */
97 static struct SAA
*seg
[RDF_MAXSEGS
]; /* seg 0 = code, seg 1 = data */
98 static struct SAA
*header
; /* relocation/import/export records */
100 static struct seginfo
{
104 uint16_t segreserved
;
106 } segments
[RDF_MAXSEGS
];
108 static int nsegments
;
110 static int32_t bsslength
;
111 static int32_t headerlength
;
113 static void rdf2_init(void)
115 int segtext
, segdata
, segbss
;
117 /* set up the initial segments */
118 segments
[0].segname
= ".text";
119 segments
[0].segnumber
= 0;
120 segments
[0].segtype
= 1;
121 segments
[0].segreserved
= 0;
122 segments
[0].seglength
= 0;
124 segments
[1].segname
= ".data";
125 segments
[1].segnumber
= 1;
126 segments
[1].segtype
= 2;
127 segments
[1].segreserved
= 0;
128 segments
[1].seglength
= 0;
130 segments
[2].segname
= ".bss";
131 segments
[2].segnumber
= 2;
132 segments
[2].segtype
= 0xFFFF; /* reserved - should never be produced */
133 segments
[2].segreserved
= 0;
134 segments
[2].seglength
= 0;
138 seg
[0] = saa_init(1L);
139 seg
[1] = saa_init(1L);
140 seg
[2] = NULL
; /* special case! */
142 header
= saa_init(1L);
144 segtext
= seg_alloc();
145 segdata
= seg_alloc();
146 segbss
= seg_alloc();
147 if (segtext
!= 0 || segdata
!= 2 || segbss
!= 4)
149 "rdf segment numbers not allocated as expected (%d,%d,%d)",
150 segtext
, segdata
, segbss
);
155 static int32_t rdf2_section_names(char *name
, int pass
, int *bits
)
166 * Default is 32 bits, in the text segment.
173 /* look for segment type code following segment name */
175 while (*p
&& !nasm_isspace(*p
))
177 if (*p
) { /* we're now in whitespace */
179 while (*p
&& nasm_isspace(80))
182 if (*p
) { /* we're now in an attribute value */
184 * see if we have an optional ',number' following the type code
186 if ((q
= strchr(p
, ','))) {
189 reserved
= readnum(q
, &err
);
191 nasm_error(ERR_NONFATAL
,
192 "value following comma must be numeric");
197 * check it against the text strings in segmenttypes
200 for (i
= 0; i
< COUNT_SEGTYPES
; i
++)
201 if (!nasm_stricmp(p
, segmenttypes
[i
])) {
202 code
= segmenttypenumbers
[i
];
205 if (code
== -1) { /* didn't find anything */
206 code
= readnum(p
, &err
);
208 nasm_error(ERR_NONFATAL
, "unrecognised RDF segment type (%s)",
214 for (i
= 0; i
< nsegments
; i
++) {
215 if (!strcmp(name
, segments
[i
].segname
)) {
216 if (code
!= -1 || reserved
!= 0)
217 nasm_error(ERR_NONFATAL
, "segment attributes specified on"
218 " redeclaration of segment");
219 return segments
[i
].segnumber
* 2;
223 /* declaring a new segment! */
226 nasm_error(ERR_NONFATAL
, "new segment declared without type code");
229 if (nsegments
== RDF_MAXSEGS
) {
230 nasm_fatal(0, "reached compiled-in maximum segment limit (%d)",
235 segments
[nsegments
].segname
= nasm_strdup(name
);
238 nasm_panic(0, "seg_alloc() returned odd number");
239 segments
[nsegments
].segnumber
= i
>> 1;
240 segments
[nsegments
].segtype
= code
;
241 segments
[nsegments
].segreserved
= reserved
;
242 segments
[nsegments
].seglength
= 0;
244 seg
[nsegments
] = saa_init(1L);
250 * Write relocation record
252 static void write_reloc_rec(struct RelocRec
*r
)
256 if (r
->refseg
!= (uint16_t) NO_SEG
&& (r
->refseg
& 1)) /* segment base ref */
257 r
->type
= RDFREC_SEGRELOC
;
259 r
->refseg
>>= 1; /* adjust segment nos to RDF rather than NASM */
261 saa_wbytes(header
, &r
->type
, 1);
262 saa_wbytes(header
, &r
->reclen
, 1);
263 saa_wbytes(header
, &r
->segment
, 1);
265 WRITELONG(b
, r
->offset
);
266 saa_wbytes(header
, buf
, 4);
267 saa_wbytes(header
, &r
->length
, 1);
269 WRITESHORT(b
, r
->refseg
);
270 saa_wbytes(header
, buf
, 2);
271 headerlength
+= r
->reclen
+ 2;
275 * Write export record
277 static void write_export_rec(struct ExportRec
*r
)
283 saa_wbytes(header
, &r
->type
, 1);
284 saa_wbytes(header
, &r
->reclen
, 1);
285 saa_wbytes(header
, &r
->flags
, 1);
286 saa_wbytes(header
, &r
->segment
, 1);
288 WRITELONG(b
, r
->offset
);
289 saa_wbytes(header
, buf
, 4);
290 saa_wbytes(header
, r
->label
, strlen(r
->label
) + 1);
291 headerlength
+= r
->reclen
+ 2;
294 static void write_import_rec(struct ImportRec
*r
)
300 saa_wbytes(header
, &r
->type
, 1);
301 saa_wbytes(header
, &r
->reclen
, 1);
302 saa_wbytes(header
, &r
->flags
, 1);
304 WRITESHORT(b
, r
->segment
);
305 saa_wbytes(header
, buf
, 2);
306 saa_wbytes(header
, r
->label
, strlen(r
->label
) + 1);
307 headerlength
+= r
->reclen
+ 2;
313 static void write_bss_rec(struct BSSRec
*r
)
317 saa_wbytes(header
, &r
->type
, 1);
318 saa_wbytes(header
, &r
->reclen
, 1);
320 WRITELONG(b
, r
->amount
);
321 saa_wbytes(header
, buf
, 4);
322 headerlength
+= r
->reclen
+ 2;
326 * Write common variable record
328 static void write_common_rec(struct CommonRec
*r
)
334 saa_wbytes(header
, &r
->type
, 1);
335 saa_wbytes(header
, &r
->reclen
, 1);
337 WRITESHORT(b
, r
->segment
);
338 saa_wbytes(header
, buf
, 2);
340 WRITELONG(b
, r
->size
);
341 saa_wbytes(header
, buf
, 4);
343 WRITESHORT(b
, r
->align
);
344 saa_wbytes(header
, buf
, 2);
345 saa_wbytes(header
, r
->label
, strlen(r
->label
) + 1);
346 headerlength
+= r
->reclen
+ 2;
350 * Write library record
352 static void write_dll_rec(struct DLLRec
*r
)
354 saa_wbytes(header
, &r
->type
, 1);
355 saa_wbytes(header
, &r
->reclen
, 1);
356 saa_wbytes(header
, r
->libname
, strlen(r
->libname
) + 1);
357 headerlength
+= r
->reclen
+ 2;
361 * Write module name record
363 static void write_modname_rec(struct ModRec
*r
)
365 saa_wbytes(header
, &r
->type
, 1);
366 saa_wbytes(header
, &r
->reclen
, 1);
367 saa_wbytes(header
, r
->modname
, strlen(r
->modname
) + 1);
368 headerlength
+= r
->reclen
+ 2;
372 * Handle export, import and common records.
374 static void rdf2_deflabel(char *name
, int32_t segment
, int64_t offset
,
375 int is_global
, char *special
)
380 static int farsym
= 0;
385 /* Check if the label length is OK */
386 if ((len
= strlen(name
)) >= EXIM_LABEL_MAX
) {
387 nasm_error(ERR_NONFATAL
, "label size exceeds %d bytes", EXIM_LABEL_MAX
);
391 nasm_error(ERR_NONFATAL
, "zero-length label");
395 if (is_global
== 2) {
396 /* Common variable */
397 ci
.type
= RDFREC_COMMON
;
399 ci
.segment
= segment
;
400 strcpy(ci
.label
, name
);
405 * Check the special text to see if it's a valid number and power
406 * of two; if so, store it as the alignment for the common variable.
410 ci
.align
= readnum(special
, &err
);
412 nasm_error(ERR_NONFATAL
, "alignment constraint `%s' is not a"
413 " valid number", special
);
414 else if ((ci
.align
| (ci
.align
- 1)) != 2 * ci
.align
- 1)
415 nasm_error(ERR_NONFATAL
, "alignment constraint `%s' is not a"
416 " power of two", special
);
418 write_common_rec(&ci
);
421 /* We don't care about local labels or fix-up hints */
426 while (*special
== ' ' || *special
== '\t')
429 if (!nasm_strnicmp(special
, "export", 6)) {
431 symflags
|= SYM_GLOBAL
;
432 } else if (!nasm_strnicmp(special
, "import", 6)) {
434 symflags
|= SYM_IMPORT
;
438 while (nasm_isspace(*special
))
440 if (!nasm_stricmp(special
, "far")) {
442 } else if (!nasm_stricmp(special
, "near")) {
444 } else if (!nasm_stricmp(special
, "proc") ||
445 !nasm_stricmp(special
, "function")) {
446 symflags
|= SYM_FUNCTION
;
447 } else if (!nasm_stricmp(special
, "data") ||
448 !nasm_stricmp(special
, "object")) {
449 symflags
|= SYM_DATA
;
451 nasm_error(ERR_NONFATAL
, "unrecognised symbol type `%s'",
456 if (name
[0] == '.' && name
[1] == '.' && name
[2] != '@') {
457 nasm_error(ERR_NONFATAL
, "unrecognised special symbol `%s'", name
);
461 for (i
= 0; i
< nsegments
; i
++) {
462 if (segments
[i
].segnumber
== segment
>> 1)
466 if (i
>= nsegments
) { /* EXTERN declaration */
467 ri
.type
= farsym
? RDFREC_FARIMPORT
: RDFREC_IMPORT
;
468 if (symflags
& SYM_GLOBAL
)
469 nasm_error(ERR_NONFATAL
,
470 "symbol type conflict - EXTERN cannot be EXPORT");
472 ri
.segment
= segment
;
473 strcpy(ri
.label
, name
);
475 write_import_rec(&ri
);
476 } else if (is_global
) {
477 r
.type
= RDFREC_GLOBAL
; /* GLOBAL declaration */
478 if (symflags
& SYM_IMPORT
)
479 nasm_error(ERR_NONFATAL
,
480 "symbol type conflict - GLOBAL cannot be IMPORT");
484 strcpy(r
.label
, name
);
486 write_export_rec(&r
);
490 static void membufwrite(int segment
, const void *data
, int bytes
)
495 for (i
= 0; i
< nsegments
; i
++) {
496 if (segments
[i
].segnumber
== segment
)
500 nasm_panic(0, "can't find segment %d", segment
);
505 WRITESHORT(b
, *(int16_t *)data
);
507 WRITELONG(b
, *(int32_t *)data
);
511 segments
[i
].seglength
+= bytes
;
512 saa_wbytes(seg
[i
], data
, bytes
);
515 static int getsegmentlength(int segment
)
518 for (i
= 0; i
< nsegments
; i
++) {
519 if (segments
[i
].segnumber
== segment
)
523 nasm_panic(0, "can't find segment %d", segment
);
525 return segments
[i
].seglength
;
528 static void rdf2_out(int32_t segto
, const void *data
,
529 enum out_type type
, uint64_t size
,
530 int32_t segment
, int32_t wrt
)
533 uint8_t databuf
[8], *pd
;
536 if (segto
== NO_SEG
) {
537 if (type
!= OUT_RESERVE
)
538 nasm_error(ERR_NONFATAL
,
539 "attempt to assemble code in ABSOLUTE space");
543 segto
>>= 1; /* convert NASM segment no to RDF number */
545 for (seg
= 0; seg
< nsegments
; seg
++) {
546 if (segments
[seg
].segnumber
== segto
)
549 if (seg
>= nsegments
) {
550 nasm_error(ERR_NONFATAL
,
551 "specified segment not supported by rdf output format");
556 wrt
= NO_SEG
; /* continue to do _something_ */
557 nasm_error(ERR_NONFATAL
, "WRT not supported by rdf output format");
560 if (segto
== 2 && type
!= OUT_RESERVE
) {
561 nasm_error(ERR_NONFATAL
, "BSS segments may not be initialized");
563 /* just reserve the space for now... */
565 if (type
== OUT_REL2ADR
)
572 if (type
== OUT_RESERVE
) {
573 if (segto
== 2) /* BSS segment space reserverd */
577 membufwrite(segto
, databuf
, 1);
578 } else if (type
== OUT_RAWDATA
) {
579 if (segment
!= NO_SEG
)
580 nasm_panic(0, "OUT_RAWDATA with other than NO_SEG");
582 membufwrite(segto
, data
, size
);
583 } else if (type
== OUT_ADDRESS
) {
584 int asize
= abs((int)size
);
586 /* if segment == NO_SEG then we are writing an address of an
587 object within the same segment - do not produce reloc rec. */
589 /* FIXME - is this behaviour sane? at first glance it doesn't
590 appear to be. Must test this thoroughly...! */
592 if (segment
!= NO_SEG
) {
593 /* it's an address, so we must write a relocation record */
595 rr
.type
= RDFREC_RELOC
; /* type signature */
597 rr
.segment
= segto
; /* segment we're currently in */
598 rr
.offset
= getsegmentlength(segto
); /* current offset */
599 rr
.length
= asize
; /* length of reference */
600 rr
.refseg
= segment
; /* segment referred to */
601 write_reloc_rec(&rr
);
604 pd
= databuf
; /* convert address to little-endian */
605 WRITEADDR(pd
, *(int64_t *)data
, asize
);
606 membufwrite(segto
, databuf
, asize
);
607 } else if (type
== OUT_REL2ADR
) {
608 if (segment
== segto
)
609 nasm_panic(0, "intra-segment OUT_REL2ADR");
612 rr
.offset
= getsegmentlength(segto
); /* current offset */
613 rr
.length
= 2; /* length of reference */
614 rr
.refseg
= segment
; /* segment referred to (will be >>1'd) */
616 if (segment
!= NO_SEG
&& segment
% 2) {
617 rr
.type
= RDFREC_SEGRELOC
;
618 rr
.segment
= segto
; /* memory base refs *aren't ever* relative! */
619 write_reloc_rec(&rr
);
621 /* what do we put in the code? Simply the data. This should almost
622 * always be zero, unless someone's doing segment arithmetic...
624 rr
.offset
= *(int64_t *)data
;
626 rr
.type
= RDFREC_RELOC
; /* type signature */
627 rr
.segment
= segto
+ 64; /* segment we're currently in + rel flag */
628 write_reloc_rec(&rr
);
630 /* work out what to put in the code: offset of the end of this operand,
631 * subtracted from any data specified, so that loader can just add
632 * address of imported symbol onto it to get address relative to end of
633 * instruction: import_address + data(offset) - end_of_instrn */
635 rr
.offset
= *(int32_t *)data
- (rr
.offset
+ size
);
638 membufwrite(segto
, &rr
.offset
, -2);
639 } else if (type
== OUT_REL4ADR
) {
640 if ((segment
== segto
) && (globalbits
!= 64))
641 nasm_panic(0, "intra-segment OUT_REL4ADR");
642 if (segment
!= NO_SEG
&& segment
% 2) {
643 nasm_panic(0, "erm... 4 byte segment base ref?");
646 rr
.type
= RDFREC_RELOC
; /* type signature */
647 rr
.segment
= segto
+ 64; /* segment we're currently in + rel tag */
648 rr
.offset
= getsegmentlength(segto
); /* current offset */
649 rr
.length
= 4; /* length of reference */
650 rr
.refseg
= segment
; /* segment referred to */
652 write_reloc_rec(&rr
);
654 rr
.offset
= *(int64_t *)data
- (rr
.offset
+ size
);
656 membufwrite(segto
, &rr
.offset
, -4);
660 static void rdf2_cleanup(void)
666 /* should write imported & exported symbol declarations to header here */
668 /* generate the output file... */
669 nasm_write(RDOFF2Id
, 6, ofile
); /* file type magic number */
671 if (bsslength
!= 0) { /* reserve BSS */
672 bs
.type
= RDFREC_BSS
;
673 bs
.amount
= bsslength
;
679 * calculate overall length of the output object
681 l
= headerlength
+ 4;
683 for (i
= 0; i
< nsegments
; i
++) {
685 continue; /* skip BSS segment */
686 l
+= 10 + segments
[i
].seglength
;
688 l
+= 10; /* null segment */
690 fwriteint32_t(l
, ofile
);
692 fwriteint32_t(headerlength
, ofile
);
693 saa_fpwrite(header
, ofile
); /* dump header */
696 for (i
= 0; i
< nsegments
; i
++) {
700 fwriteint16_t(segments
[i
].segtype
, ofile
);
701 fwriteint16_t(segments
[i
].segnumber
, ofile
);
702 fwriteint16_t(segments
[i
].segreserved
, ofile
);
703 fwriteint32_t(segments
[i
].seglength
, ofile
);
705 saa_fpwrite(seg
[i
], ofile
);
709 /* null segment - write 10 bytes of zero */
710 fwriteint32_t(0, ofile
);
711 fwriteint32_t(0, ofile
);
712 fwriteint16_t(0, ofile
);
715 static int32_t rdf2_segbase(int32_t segment
)
721 * Handle RDOFF2 specific directives
723 static enum directive_result
724 rdf2_directive(enum directive directive
, char *value
, int pass
)
731 if (n
>= MODLIB_NAME_MAX
) {
732 nasm_error(ERR_NONFATAL
, "name size exceeds %d bytes", MODLIB_NAME_MAX
);
739 strcpy(r
.libname
, value
);
745 if ((n
= strlen(value
)) >= MODLIB_NAME_MAX
) {
746 nasm_error(ERR_NONFATAL
, "name size exceeds %d bytes", MODLIB_NAME_MAX
);
751 r
.type
= RDFREC_MODNAME
;
753 strcpy(r
.modname
, value
);
754 write_modname_rec(&r
);
763 static void rdf2_filename(char *inname
, char *outname
)
765 standard_extension(inname
, outname
, ".rdf");
768 extern macros_t rdf2_stdmac
[];
770 const struct ofmt of_rdf2
= {
771 "Relocatable Dynamic Object File Format v2.0",
779 nasm_do_legacy_output
,
788 NULL
/* pragma list */