Move prototypes for null_debug to outform.h and outlib.h
[nasm.git] / output / outrdf2.c
blobc3f10cb36f310775a4da9fcb175b7560cf0a5b67
1 /*
2 * outrdf2.c output routines for the Netwide Assembler to produce
3 * RDOFF version 2 format object files, which Julian originally
4 * planned to use it in his MOSCOW operating system.
6 * The Netwide Assembler is copyright (C) 1996-1998 Simon Tatham and
7 * Julian Hall. All rights reserved. The software is
8 * redistributable under the license given in the file "LICENSE"
9 * distributed in the NASM archive.
12 #include "compiler.h"
14 #include <stdio.h>
15 #include <stdlib.h>
16 #include <string.h>
17 #include <ctype.h>
18 #include <assert.h>
19 #include <inttypes.h>
21 #include "nasm.h"
22 #include "nasmlib.h"
23 #include "saa.h"
24 #include "output/outform.h"
25 #include "output/outlib.h"
27 /* VERBOSE_WARNINGS: define this to add some extra warnings... */
28 #define VERBOSE_WARNINGS
30 #ifdef OF_RDF2
32 #include "rdoff/rdoff.h"
34 /* This signature is written to start of RDOFF files */
35 static const char *RDOFF2Id = RDOFF2_SIGNATURE;
37 /* Note that whenever a segment is referred to in the RDOFF file, its number
38 * is always half of the segment number that NASM uses to refer to it; this
39 * is because NASM only allocates even numbered segments, so as to not
40 * waste any of the 16 bits of segment number written to the file - this
41 * allows up to 65533 external labels to be defined; otherwise it would be
42 * 32764. */
44 #define COUNT_SEGTYPES 9
46 static char *segmenttypes[COUNT_SEGTYPES] = {
47 "null", "text", "code", "data",
48 "comment", "lcomment", "pcomment",
49 "symdebug", "linedebug"
52 static int segmenttypenumbers[COUNT_SEGTYPES] = {
53 0, 1, 1, 2, 3, 4, 5, 6, 7
56 /* code for managing buffers needed to separate code and data into individual
57 * sections until they are ready to be written to the file.
58 * We'd better hope that it all fits in memory else we're buggered... */
60 #define BUF_BLOCK_LEN 4088 /* selected to match page size (4096)
61 * on 80x86 machines for efficiency */
63 /***********************************************************************
64 * Actual code to deal with RDOFF2 ouput format begins here...
67 /* global variables set during the initialisation phase */
69 static struct SAA *seg[RDF_MAXSEGS]; /* seg 0 = code, seg 1 = data */
70 static struct SAA *header; /* relocation/import/export records */
72 static FILE *ofile;
74 static efunc error;
76 static struct seginfo {
77 char *segname;
78 int segnumber;
79 uint16_t segtype;
80 uint16_t segreserved;
81 int32_t seglength;
82 } segments[RDF_MAXSEGS];
84 static int nsegments;
86 static int32_t bsslength;
87 static int32_t headerlength;
89 static void rdf2_init(FILE * fp, efunc errfunc, ldfunc ldef, evalfunc eval)
91 int segtext, segdata, segbss;
93 (void)ldef;
94 (void)eval;
96 maxbits = 64;
98 /* set up the initial segments */
99 segments[0].segname = ".text";
100 segments[0].segnumber = 0;
101 segments[0].segtype = 1;
102 segments[0].segreserved = 0;
103 segments[0].seglength = 0;
105 segments[1].segname = ".data";
106 segments[1].segnumber = 1;
107 segments[1].segtype = 2;
108 segments[1].segreserved = 0;
109 segments[1].seglength = 0;
111 segments[2].segname = ".bss";
112 segments[2].segnumber = 2;
113 segments[2].segtype = 0xFFFF; /* reserved - should never be produced */
114 segments[2].segreserved = 0;
115 segments[2].seglength = 0;
117 nsegments = 3;
119 ofile = fp;
120 error = errfunc;
122 seg[0] = saa_init(1L);
123 seg[1] = saa_init(1L);
124 seg[2] = NULL; /* special case! */
126 header = saa_init(1L);
128 segtext = seg_alloc();
129 segdata = seg_alloc();
130 segbss = seg_alloc();
131 if (segtext != 0 || segdata != 2 || segbss != 4)
132 error(ERR_PANIC,
133 "rdf segment numbers not allocated as expected (%d,%d,%d)",
134 segtext, segdata, segbss);
135 bsslength = 0;
136 headerlength = 0;
139 static int32_t rdf2_section_names(char *name, int pass, int *bits)
141 int i;
142 bool err;
143 char *p, *q;
144 int code = -1;
145 int reserved = 0;
147 (void)pass;
150 * Default is 32 bits, in the text segment.
152 if (!name) {
153 *bits = 32;
154 return 0;
157 /* look for segment type code following segment name */
158 p = name;
159 while (*p && !nasm_isspace(*p))
160 p++;
161 if (*p) { /* we're now in whitespace */
162 *p++ = '\0';
163 while (*p && nasm_isspace(80))
164 *p++ = '\0';
166 if (*p) { /* we're now in an attribute value */
168 * see if we have an optional ',number' following the type code
170 if ((q = strchr(p, ','))) {
171 *q++ = '\0';
173 reserved = readnum(q, &err);
174 if (err) {
175 error(ERR_NONFATAL,
176 "value following comma must be numeric");
177 reserved = 0;
181 * check it against the text strings in segmenttypes
184 for (i = 0; i < COUNT_SEGTYPES; i++)
185 if (!nasm_stricmp(p, segmenttypes[i])) {
186 code = segmenttypenumbers[i];
187 break;
189 if (code == -1) { /* didn't find anything */
190 code = readnum(p, &err);
191 if (err) {
192 error(ERR_NONFATAL, "unrecognised RDF segment type (%s)",
194 code = 3;
198 for (i = 0; i < nsegments; i++) {
199 if (!strcmp(name, segments[i].segname)) {
200 if (code != -1 || reserved != 0)
201 error(ERR_NONFATAL, "segment attributes specified on"
202 " redeclaration of segment");
203 return segments[i].segnumber * 2;
207 /* declaring a new segment! */
209 if (code == -1) {
210 error(ERR_NONFATAL, "new segment declared without type code");
211 code = 3;
213 if (nsegments == RDF_MAXSEGS) {
214 error(ERR_FATAL, "reached compiled-in maximum segment limit (%d)",
215 RDF_MAXSEGS);
216 return NO_SEG;
219 segments[nsegments].segname = nasm_strdup(name);
220 i = seg_alloc();
221 if (i % 2 != 0)
222 error(ERR_PANIC, "seg_alloc() returned odd number");
223 segments[nsegments].segnumber = i >> 1;
224 segments[nsegments].segtype = code;
225 segments[nsegments].segreserved = reserved;
226 segments[nsegments].seglength = 0;
228 seg[nsegments] = saa_init(1L);
230 return i;
234 * Write relocation record
236 static void write_reloc_rec(struct RelocRec *r)
238 char buf[4], *b;
240 if (r->refseg != (uint16_t) NO_SEG && (r->refseg & 1)) /* segment base ref */
241 r->type = RDFREC_SEGRELOC;
243 r->refseg >>= 1; /* adjust segment nos to RDF rather than NASM */
245 saa_wbytes(header, &r->type, 1);
246 saa_wbytes(header, &r->reclen, 1);
247 saa_wbytes(header, &r->segment, 1);
248 b = buf;
249 WRITELONG(b, r->offset);
250 saa_wbytes(header, buf, 4);
251 saa_wbytes(header, &r->length, 1);
252 b = buf;
253 WRITESHORT(b, r->refseg);
254 saa_wbytes(header, buf, 2);
255 headerlength += r->reclen + 2;
259 * Write export record
261 static void write_export_rec(struct ExportRec *r)
263 char buf[4], *b;
265 r->segment >>= 1;
267 saa_wbytes(header, &r->type, 1);
268 saa_wbytes(header, &r->reclen, 1);
269 saa_wbytes(header, &r->flags, 1);
270 saa_wbytes(header, &r->segment, 1);
271 b = buf;
272 WRITELONG(b, r->offset);
273 saa_wbytes(header, buf, 4);
274 saa_wbytes(header, r->label, strlen(r->label) + 1);
275 headerlength += r->reclen + 2;
278 static void write_import_rec(struct ImportRec *r)
280 char buf[4], *b;
282 r->segment >>= 1;
284 saa_wbytes(header, &r->type, 1);
285 saa_wbytes(header, &r->reclen, 1);
286 saa_wbytes(header, &r->flags, 1);
287 b = buf;
288 WRITESHORT(b, r->segment);
289 saa_wbytes(header, buf, 2);
290 saa_wbytes(header, r->label, strlen(r->label) + 1);
291 headerlength += r->reclen + 2;
295 * Write BSS record
297 static void write_bss_rec(struct BSSRec *r)
299 char buf[4], *b;
301 saa_wbytes(header, &r->type, 1);
302 saa_wbytes(header, &r->reclen, 1);
303 b = buf;
304 WRITELONG(b, r->amount);
305 saa_wbytes(header, buf, 4);
306 headerlength += r->reclen + 2;
310 * Write common variable record
312 static void write_common_rec(struct CommonRec *r)
314 char buf[4], *b;
316 r->segment >>= 1;
318 saa_wbytes(header, &r->type, 1);
319 saa_wbytes(header, &r->reclen, 1);
320 b = buf;
321 WRITESHORT(b, r->segment);
322 saa_wbytes(header, buf, 2);
323 b = buf;
324 WRITELONG(b, r->size);
325 saa_wbytes(header, buf, 4);
326 b = buf;
327 WRITESHORT(b, r->align);
328 saa_wbytes(header, buf, 2);
329 saa_wbytes(header, r->label, strlen(r->label) + 1);
330 headerlength += r->reclen + 2;
334 * Write library record
336 static void write_dll_rec(struct DLLRec *r)
338 saa_wbytes(header, &r->type, 1);
339 saa_wbytes(header, &r->reclen, 1);
340 saa_wbytes(header, r->libname, strlen(r->libname) + 1);
341 headerlength += r->reclen + 2;
345 * Write module name record
347 static void write_modname_rec(struct ModRec *r)
349 saa_wbytes(header, &r->type, 1);
350 saa_wbytes(header, &r->reclen, 1);
351 saa_wbytes(header, r->modname, strlen(r->modname) + 1);
352 headerlength += r->reclen + 2;
356 * Handle export, import and common records.
358 static void rdf2_deflabel(char *name, int32_t segment, int64_t offset,
359 int is_global, char *special)
361 struct ExportRec r;
362 struct ImportRec ri;
363 struct CommonRec ci;
364 static int farsym = 0;
365 static int i;
366 char symflags = 0;
367 int len;
369 /* Check if the label length is OK */
370 if ((len = strlen(name)) >= EXIM_LABEL_MAX) {
371 error(ERR_NONFATAL, "label size exceeds %d bytes", EXIM_LABEL_MAX);
372 return;
374 if (!len) {
375 error(ERR_NONFATAL, "zero-length label");
376 return;
379 if (is_global == 2) {
380 /* Common variable */
381 ci.type = RDFREC_COMMON;
382 ci.size = offset;
383 ci.segment = segment;
384 strcpy(ci.label, name);
385 ci.reclen = 9 + len;
386 ci.align = 0;
389 * Check the special text to see if it's a valid number and power
390 * of two; if so, store it as the alignment for the common variable.
392 if (special) {
393 bool err;
394 ci.align = readnum(special, &err);
395 if (err)
396 error(ERR_NONFATAL, "alignment constraint `%s' is not a"
397 " valid number", special);
398 else if ((ci.align | (ci.align - 1)) != 2 * ci.align - 1)
399 error(ERR_NONFATAL, "alignment constraint `%s' is not a"
400 " power of two", special);
402 write_common_rec(&ci);
405 /* We don't care about local labels or fix-up hints */
406 if (is_global != 1)
407 return;
409 if (special) {
410 while (*special == ' ' || *special == '\t')
411 special++;
413 if (!nasm_strnicmp(special, "export", 6)) {
414 special += 6;
415 symflags |= SYM_GLOBAL;
416 } else if (!nasm_strnicmp(special, "import", 6)) {
417 special += 6;
418 symflags |= SYM_IMPORT;
421 if (*special) {
422 while (nasm_isspace(*special))
423 special++;
424 if (!nasm_stricmp(special, "far")) {
425 farsym = 1;
426 } else if (!nasm_stricmp(special, "near")) {
427 farsym = 0;
428 } else if (!nasm_stricmp(special, "proc") ||
429 !nasm_stricmp(special, "function")) {
430 symflags |= SYM_FUNCTION;
431 } else if (!nasm_stricmp(special, "data") ||
432 !nasm_stricmp(special, "object")) {
433 symflags |= SYM_DATA;
434 } else
435 error(ERR_NONFATAL, "unrecognised symbol type `%s'",
436 special);
440 if (name[0] == '.' && name[1] == '.' && name[2] != '@') {
441 error(ERR_NONFATAL, "unrecognised special symbol `%s'", name);
442 return;
445 for (i = 0; i < nsegments; i++) {
446 if (segments[i].segnumber == segment >> 1)
447 break;
450 if (i >= nsegments) { /* EXTERN declaration */
451 ri.type = farsym ? RDFREC_FARIMPORT : RDFREC_IMPORT;
452 if (symflags & SYM_GLOBAL)
453 error(ERR_NONFATAL,
454 "symbol type conflict - EXTERN cannot be EXPORT");
455 ri.flags = symflags;
456 ri.segment = segment;
457 strcpy(ri.label, name);
458 ri.reclen = 4 + len;
459 write_import_rec(&ri);
460 } else if (is_global) {
461 r.type = RDFREC_GLOBAL; /* GLOBAL declaration */
462 if (symflags & SYM_IMPORT)
463 error(ERR_NONFATAL,
464 "symbol type conflict - GLOBAL cannot be IMPORT");
465 r.flags = symflags;
466 r.segment = segment;
467 r.offset = offset;
468 strcpy(r.label, name);
469 r.reclen = 7 + len;
470 write_export_rec(&r);
474 static void membufwrite(int segment, const void *data, int bytes)
476 int i;
477 char buf[4], *b;
479 for (i = 0; i < nsegments; i++) {
480 if (segments[i].segnumber == segment)
481 break;
483 if (i == nsegments)
484 error(ERR_PANIC, "can't find segment %d", segment);
486 if (bytes < 0) {
487 b = buf;
488 if (bytes == -2)
489 WRITESHORT(b, *(int16_t *)data);
490 else
491 WRITELONG(b, *(int32_t *)data);
492 data = buf;
493 bytes = -bytes;
495 segments[i].seglength += bytes;
496 saa_wbytes(seg[i], data, bytes);
499 static int getsegmentlength(int segment)
501 int i;
502 for (i = 0; i < nsegments; i++) {
503 if (segments[i].segnumber == segment)
504 break;
506 if (i == nsegments)
507 error(ERR_PANIC, "can't find segment %d", segment);
509 return segments[i].seglength;
512 static void rdf2_out(int32_t segto, const void *data,
513 enum out_type type, uint64_t size,
514 int32_t segment, int32_t wrt)
516 struct RelocRec rr;
517 uint8_t databuf[8], *pd;
518 int seg;
520 if (segto == NO_SEG) {
521 if (type != OUT_RESERVE)
522 error(ERR_NONFATAL,
523 "attempt to assemble code in ABSOLUTE space");
524 return;
527 segto >>= 1; /* convert NASM segment no to RDF number */
529 for (seg = 0; seg < nsegments; seg++) {
530 if (segments[seg].segnumber == segto)
531 break;
533 if (seg >= nsegments) {
534 error(ERR_NONFATAL,
535 "specified segment not supported by rdf output format");
536 return;
539 if (wrt != NO_SEG) {
540 wrt = NO_SEG; /* continue to do _something_ */
541 error(ERR_NONFATAL, "WRT not supported by rdf output format");
544 if (segto == 2 && type != OUT_RESERVE) {
545 error(ERR_NONFATAL, "BSS segments may not be initialized");
547 /* just reserve the space for now... */
549 if (type == OUT_REL2ADR)
550 size = 2;
551 else
552 size = 4;
553 type = OUT_RESERVE;
556 if (type == OUT_RESERVE) {
557 if (segto == 2) /* BSS segment space reserverd */
558 bsslength += size;
559 else
560 while (size--)
561 membufwrite(segto, databuf, 1);
562 } else if (type == OUT_RAWDATA) {
563 if (segment != NO_SEG)
564 error(ERR_PANIC, "OUT_RAWDATA with other than NO_SEG");
566 membufwrite(segto, data, size);
567 } else if (type == OUT_ADDRESS) {
569 /* if segment == NO_SEG then we are writing an address of an
570 object within the same segment - do not produce reloc rec. */
572 /* FIXME - is this behaviour sane? at first glance it doesn't
573 appear to be. Must test this thoroughly...! */
575 if (segment != NO_SEG) {
576 /* it's an address, so we must write a relocation record */
578 rr.type = RDFREC_RELOC; /* type signature */
579 rr.reclen = 8;
580 rr.segment = segto; /* segment we're currently in */
581 rr.offset = getsegmentlength(segto); /* current offset */
582 rr.length = size; /* length of reference */
583 rr.refseg = segment; /* segment referred to */
584 write_reloc_rec(&rr);
587 pd = databuf; /* convert address to little-endian */
588 WRITEADDR(pd, *(int64_t *)data, size);
589 membufwrite(segto, databuf, size);
590 } else if (type == OUT_REL2ADR) {
591 if (segment == segto)
592 error(ERR_PANIC, "intra-segment OUT_REL2ADR");
594 rr.reclen = 8;
595 rr.offset = getsegmentlength(segto); /* current offset */
596 rr.length = 2; /* length of reference */
597 rr.refseg = segment; /* segment referred to (will be >>1'd) */
599 if (segment != NO_SEG && segment % 2) {
600 rr.type = RDFREC_SEGRELOC;
601 rr.segment = segto; /* memory base refs *aren't ever* relative! */
602 write_reloc_rec(&rr);
604 /* what do we put in the code? Simply the data. This should almost
605 * always be zero, unless someone's doing segment arithmetic...
607 rr.offset = *(int64_t *)data;
608 } else {
609 rr.type = RDFREC_RELOC; /* type signature */
610 rr.segment = segto + 64; /* segment we're currently in + rel flag */
611 write_reloc_rec(&rr);
613 /* work out what to put in the code: offset of the end of this operand,
614 * subtracted from any data specified, so that loader can just add
615 * address of imported symbol onto it to get address relative to end of
616 * instruction: import_address + data(offset) - end_of_instrn */
618 rr.offset = *(int32_t *)data - (rr.offset + size);
621 membufwrite(segto, &rr.offset, -2);
622 } else if (type == OUT_REL4ADR) {
623 if ((segment == segto) && (globalbits != 64))
624 error(ERR_PANIC, "intra-segment OUT_REL4ADR");
625 if (segment != NO_SEG && segment % 2) {
626 error(ERR_PANIC, "erm... 4 byte segment base ref?");
629 rr.type = RDFREC_RELOC; /* type signature */
630 rr.segment = segto + 64; /* segment we're currently in + rel tag */
631 rr.offset = getsegmentlength(segto); /* current offset */
632 rr.length = 4; /* length of reference */
633 rr.refseg = segment; /* segment referred to */
634 rr.reclen = 8;
635 write_reloc_rec(&rr);
637 rr.offset = *(int64_t *)data - (rr.offset + size);
639 membufwrite(segto, &rr.offset, -4);
643 static void rdf2_cleanup(int debuginfo)
645 int32_t l;
646 struct BSSRec bs;
647 int i;
649 (void)debuginfo;
651 /* should write imported & exported symbol declarations to header here */
653 /* generate the output file... */
654 fwrite(RDOFF2Id, 6, 1, ofile); /* file type magic number */
656 if (bsslength != 0) { /* reserve BSS */
657 bs.type = RDFREC_BSS;
658 bs.amount = bsslength;
659 bs.reclen = 4;
660 write_bss_rec(&bs);
664 * calculate overall length of the output object
666 l = headerlength + 4;
668 for (i = 0; i < nsegments; i++) {
669 if (i == 2)
670 continue; /* skip BSS segment */
671 l += 10 + segments[i].seglength;
673 l += 10; /* null segment */
675 fwriteint32_t(l, ofile);
677 fwriteint32_t(headerlength, ofile);
678 saa_fpwrite(header, ofile); /* dump header */
679 saa_free(header);
681 for (i = 0; i < nsegments; i++) {
682 if (i == 2)
683 continue;
685 fwriteint16_t(segments[i].segtype, ofile);
686 fwriteint16_t(segments[i].segnumber, ofile);
687 fwriteint16_t(segments[i].segreserved, ofile);
688 fwriteint32_t(segments[i].seglength, ofile);
690 saa_fpwrite(seg[i], ofile);
691 saa_free(seg[i]);
694 /* null segment - write 10 bytes of zero */
695 fwriteint32_t(0, ofile);
696 fwriteint32_t(0, ofile);
697 fwriteint16_t(0, ofile);
699 fclose(ofile);
702 static int32_t rdf2_segbase(int32_t segment)
704 return segment;
708 * Handle RDOFF2 specific directives
710 static int rdf2_directive(char *directive, char *value, int pass)
712 int n;
714 /* Check if the name length is OK */
715 if ((n = strlen(value)) >= MODLIB_NAME_MAX) {
716 error(ERR_NONFATAL, "name size exceeds %d bytes", MODLIB_NAME_MAX);
717 return 0;
720 if (!strcmp(directive, "library")) {
721 if (pass == 1) {
722 struct DLLRec r;
723 r.type = RDFREC_DLL;
724 r.reclen = n + 1;
725 strcpy(r.libname, value);
726 write_dll_rec(&r);
728 return 1;
731 if (!strcmp(directive, "module")) {
732 if (pass == 1) {
733 struct ModRec r;
734 r.type = RDFREC_MODNAME;
735 r.reclen = n + 1;
736 strcpy(r.modname, value);
737 write_modname_rec(&r);
739 return 1;
742 return 0;
745 static void rdf2_filename(char *inname, char *outname, efunc error)
747 standard_extension(inname, outname, ".rdf", error);
750 extern macros_t rdf2_stdmac[];
752 static int rdf2_set_info(enum geninfo type, char **val)
754 (void)type;
755 (void)val;
756 return 0;
759 struct ofmt of_rdf2 = {
760 "Relocatable Dynamic Object File Format v2.0",
761 "rdf",
762 NULL,
763 null_debug_arr,
764 &null_debug_form,
765 rdf2_stdmac,
766 rdf2_init,
767 rdf2_set_info,
768 rdf2_out,
769 rdf2_deflabel,
770 rdf2_section_names,
771 rdf2_segbase,
772 rdf2_directive,
773 rdf2_filename,
774 rdf2_cleanup
777 #endif /* OF_RDF2 */