output: change null_debug_routine to null_debug_directive
[nasm.git] / output / outieee.c
blobffdd5d6ea1cdba3f025b641f6ccab7ae62632461
1 /* ----------------------------------------------------------------------- *
2 *
3 * Copyright 1996-2009 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
9 * conditions are met:
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 * outieee.c output routines for the Netwide Assembler to produce
36 * IEEE-std object files
39 /* notes: I have tried to make this correspond to the IEEE version
40 * of the standard, specifically the primary ASCII version. It should
41 * be trivial to create the binary version given this source (which is
42 * one of MANY things that have to be done to make this correspond to
43 * the hp-microtek version of the standard).
45 * 16-bit support is assumed to use 24-bit addresses
46 * The linker can sort out segmentation-specific stuff
47 * if it keeps track of externals
48 * in terms of being relative to section bases
50 * A non-standard variable type, the 'Yn' variable, has been introduced.
51 * Basically it is a reference to extern 'n'- denoting the low limit
52 * (L-variable) of the section that extern 'n' is defined in. Like the
53 * x variable, there may be no explicit assignment to it, it is derived
54 * from the public definition corresponding to the extern name. This
55 * is required because the one thing the mufom guys forgot to do well was
56 * take into account segmented architectures.
58 * I use comment classes for various things and these are undefined by
59 * the standard.
61 * Debug info should be considered totally non-standard (local labels are
62 * standard but linenum records are not covered by the standard.
63 * Type defs have the standard format but absolute meanings for ordinal
64 * types are not covered by the standard.)
66 * David Lindauer, LADsoft
68 #include "compiler.h"
70 #include <stdio.h>
71 #include <stdlib.h>
72 #include <string.h>
73 #include <time.h>
74 #include <stdarg.h> /* Note: we need the ANSI version of stdarg.h */
75 #include <ctype.h>
76 #include <inttypes.h>
78 #include "nasm.h"
79 #include "nasmlib.h"
80 #include "output/outform.h"
81 #include "output/outlib.h"
83 #ifdef OF_IEEE
85 #define ARRAY_BOT 0x1
87 static char ieee_infile[FILENAME_MAX];
88 static int ieee_uppercase;
90 static bool any_segs;
91 static int arrindex;
93 #define HUNKSIZE 1024 /* Size of the data hunk */
94 #define EXT_BLKSIZ 512
95 #define LDPERLINE 32 /* bytes per line in output */
97 struct ieeeSection;
99 struct LineNumber {
100 struct LineNumber *next;
101 struct ieeeSection *segment;
102 int32_t offset;
103 int32_t lineno;
106 static struct FileName {
107 struct FileName *next;
108 char *name;
109 int32_t index;
110 } *fnhead, **fntail;
112 static struct Array {
113 struct Array *next;
114 unsigned size;
115 int basetype;
116 } *arrhead, **arrtail;
118 static struct ieeePublic {
119 struct ieeePublic *next;
120 char *name;
121 int32_t offset;
122 int32_t segment; /* only if it's far-absolute */
123 int32_t index;
124 int type; /* for debug purposes */
125 } *fpubhead, **fpubtail, *last_defined;
127 static struct ieeeExternal {
128 struct ieeeExternal *next;
129 char *name;
130 int32_t commonsize;
131 } *exthead, **exttail;
133 static int externals;
135 static struct ExtBack {
136 struct ExtBack *next;
137 int index[EXT_BLKSIZ];
138 } *ebhead, **ebtail;
140 /* NOTE: the first segment MUST be the lineno segment */
141 static struct ieeeSection {
142 struct ieeeObjData *data, *datacurr;
143 struct ieeeSection *next;
144 struct ieeeFixupp *fptr, *flptr;
145 int32_t index; /* the NASM segment id */
146 int32_t ieee_index; /* the OBJ-file segment index */
147 int32_t currentpos;
148 int32_t align; /* can be SEG_ABS + absolute addr */
149 int32_t startpos;
150 enum {
151 CMB_PRIVATE = 0,
152 CMB_PUBLIC = 2,
153 CMB_COMMON = 6
154 } combine;
155 int32_t use32; /* is this segment 32-bit? */
156 struct ieeePublic *pubhead, **pubtail, *lochead, **loctail;
157 char *name;
158 } *seghead, **segtail, *ieee_seg_needs_update;
160 struct ieeeObjData {
161 struct ieeeObjData *next;
162 uint8_t data[HUNKSIZE];
165 struct ieeeFixupp {
166 struct ieeeFixupp *next;
167 enum {
168 FT_SEG = 0,
169 FT_REL = 1,
170 FT_OFS = 2,
171 FT_EXT = 3,
172 FT_WRT = 4,
173 FT_EXTREL = 5,
174 FT_EXTWRT = 6,
175 FT_EXTSEG = 7
176 } ftype;
177 int16_t size;
178 int32_t id1;
179 int32_t id2;
180 int32_t offset;
181 int32_t addend;
184 static int32_t ieee_entry_seg, ieee_entry_ofs;
185 static int checksum;
187 extern struct ofmt of_ieee;
189 static void ieee_data_new(struct ieeeSection *);
190 static void ieee_write_fixup(int32_t, int32_t, struct ieeeSection *,
191 int, uint64_t, int32_t);
192 static void ieee_install_fixup(struct ieeeSection *, struct ieeeFixupp *);
193 static int32_t ieee_segment(char *, int, int *);
194 static void ieee_write_file(int debuginfo);
195 static void ieee_write_byte(struct ieeeSection *, int);
196 static void ieee_write_word(struct ieeeSection *, int);
197 static void ieee_write_dword(struct ieeeSection *, int32_t);
198 static void ieee_putascii(char *, ...);
199 static void ieee_putcs(int);
200 static int32_t ieee_putld(int32_t, int32_t, uint8_t *);
201 static int32_t ieee_putlr(struct ieeeFixupp *);
202 static void ieee_unqualified_name(char *, char *);
205 * pup init
207 static void ieee_init(void)
209 any_segs = false;
210 fpubhead = NULL;
211 fpubtail = &fpubhead;
212 exthead = NULL;
213 exttail = &exthead;
214 externals = 1;
215 ebhead = NULL;
216 ebtail = &ebhead;
217 seghead = ieee_seg_needs_update = NULL;
218 segtail = &seghead;
219 ieee_entry_seg = NO_SEG;
220 ieee_uppercase = false;
221 checksum = 0;
224 static int ieee_set_info(enum geninfo type, char **val)
226 (void)type;
227 (void)val;
229 return 0;
233 * Rundown
235 static void ieee_cleanup(int debuginfo)
237 ieee_write_file(debuginfo);
238 of_ieee.current_dfmt->cleanup();
239 while (seghead) {
240 struct ieeeSection *segtmp = seghead;
241 seghead = seghead->next;
242 while (segtmp->pubhead) {
243 struct ieeePublic *pubtmp = segtmp->pubhead;
244 segtmp->pubhead = pubtmp->next;
245 nasm_free(pubtmp);
247 while (segtmp->fptr) {
248 struct ieeeFixupp *fixtmp = segtmp->fptr;
249 segtmp->fptr = fixtmp->next;
250 nasm_free(fixtmp);
252 while (segtmp->data) {
253 struct ieeeObjData *dattmp = segtmp->data;
254 segtmp->data = dattmp->next;
255 nasm_free(dattmp);
257 nasm_free(segtmp);
259 while (fpubhead) {
260 struct ieeePublic *pubtmp = fpubhead;
261 fpubhead = fpubhead->next;
262 nasm_free(pubtmp);
264 while (exthead) {
265 struct ieeeExternal *exttmp = exthead;
266 exthead = exthead->next;
267 nasm_free(exttmp);
269 while (ebhead) {
270 struct ExtBack *ebtmp = ebhead;
271 ebhead = ebhead->next;
272 nasm_free(ebtmp);
277 * callback for labels
279 static void ieee_deflabel(char *name, int32_t segment,
280 int64_t offset, int is_global, char *special)
283 * We have three cases:
285 * (i) `segment' is a segment-base. If so, set the name field
286 * for the segment structure it refers to, and then
287 * return.
289 * (ii) `segment' is one of our segments, or a SEG_ABS segment.
290 * Save the label position for later output of a PUBDEF record.
293 * (iii) `segment' is not one of our segments. Save the label
294 * position for later output of an EXTDEF.
296 struct ieeeExternal *ext;
297 struct ExtBack *eb;
298 struct ieeeSection *seg;
299 int i;
301 if (special) {
302 nasm_error(ERR_NONFATAL, "unrecognised symbol type `%s'", special);
305 * First check for the double-period, signifying something
306 * unusual.
308 if (name[0] == '.' && name[1] == '.') {
309 if (!strcmp(name, "..start")) {
310 ieee_entry_seg = segment;
311 ieee_entry_ofs = offset;
313 return;
317 * Case (i):
319 if (ieee_seg_needs_update) {
320 ieee_seg_needs_update->name = name;
321 return;
323 if (segment < SEG_ABS && segment != NO_SEG && segment % 2)
324 return;
327 * case (ii)
329 if (segment >= SEG_ABS) {
331 * SEG_ABS subcase of (ii).
333 if (is_global) {
334 struct ieeePublic *pub;
336 pub = *fpubtail = nasm_malloc(sizeof(*pub));
337 fpubtail = &pub->next;
338 pub->next = NULL;
339 pub->name = name;
340 pub->offset = offset;
341 pub->segment = segment & ~SEG_ABS;
343 return;
346 for (seg = seghead; seg && is_global; seg = seg->next)
347 if (seg->index == segment) {
348 struct ieeePublic *pub;
350 last_defined = pub = *seg->pubtail = nasm_malloc(sizeof(*pub));
351 seg->pubtail = &pub->next;
352 pub->next = NULL;
353 pub->name = name;
354 pub->offset = offset;
355 pub->index = seg->ieee_index;
356 pub->segment = -1;
357 return;
361 * Case (iii).
363 if (is_global) {
364 ext = *exttail = nasm_malloc(sizeof(*ext));
365 ext->next = NULL;
366 exttail = &ext->next;
367 ext->name = name;
368 if (is_global == 2)
369 ext->commonsize = offset;
370 else
371 ext->commonsize = 0;
372 i = segment / 2;
373 eb = ebhead;
374 if (!eb) {
375 eb = *ebtail = nasm_malloc(sizeof(*eb));
376 eb->next = NULL;
377 ebtail = &eb->next;
379 while (i > EXT_BLKSIZ) {
380 if (eb && eb->next)
381 eb = eb->next;
382 else {
383 eb = *ebtail = nasm_malloc(sizeof(*eb));
384 eb->next = NULL;
385 ebtail = &eb->next;
387 i -= EXT_BLKSIZ;
389 eb->index[i] = externals++;
395 * Put data out
397 static void ieee_out(int32_t segto, const void *data,
398 enum out_type type, uint64_t size,
399 int32_t segment, int32_t wrt)
401 const uint8_t *ucdata;
402 int32_t ldata;
403 struct ieeeSection *seg;
406 * handle absolute-assembly (structure definitions)
408 if (segto == NO_SEG) {
409 if (type != OUT_RESERVE)
410 nasm_error(ERR_NONFATAL, "attempt to assemble code in [ABSOLUTE]"
411 " space");
412 return;
416 * If `any_segs' is still false, we must define a default
417 * segment.
419 if (!any_segs) {
420 int tempint; /* ignored */
421 if (segto != ieee_segment("__NASMDEFSEG", 2, &tempint))
422 nasm_error(ERR_PANIC, "strange segment conditions in IEEE driver");
426 * Find the segment we are targetting.
428 for (seg = seghead; seg; seg = seg->next)
429 if (seg->index == segto)
430 break;
431 if (!seg)
432 nasm_error(ERR_PANIC, "code directed to nonexistent segment?");
434 if (type == OUT_RAWDATA) {
435 ucdata = data;
436 while (size--)
437 ieee_write_byte(seg, *ucdata++);
438 } else if (type == OUT_ADDRESS || type == OUT_REL2ADR ||
439 type == OUT_REL4ADR) {
440 if (segment == NO_SEG && type != OUT_ADDRESS)
441 nasm_error(ERR_NONFATAL, "relative call to absolute address not"
442 " supported by IEEE format");
443 ldata = *(int64_t *)data;
444 if (type == OUT_REL2ADR)
445 ldata += (size - 2);
446 if (type == OUT_REL4ADR)
447 ldata += (size - 4);
448 ieee_write_fixup(segment, wrt, seg, size, type, ldata);
449 if (size == 2)
450 ieee_write_word(seg, ldata);
451 else
452 ieee_write_dword(seg, ldata);
453 } else if (type == OUT_RESERVE) {
454 while (size--)
455 ieee_write_byte(seg, 0);
459 static void ieee_data_new(struct ieeeSection *segto)
462 if (!segto->data)
463 segto->data = segto->datacurr =
464 nasm_malloc(sizeof(*(segto->datacurr)));
465 else
466 segto->datacurr = segto->datacurr->next =
467 nasm_malloc(sizeof(*(segto->datacurr)));
468 segto->datacurr->next = NULL;
472 * this routine is unalduterated bloatware. I usually don't do this
473 * but I might as well see what it is like on a harmless program.
474 * If anyone wants to optimize this is a good canditate!
476 static void ieee_write_fixup(int32_t segment, int32_t wrt,
477 struct ieeeSection *segto, int size,
478 uint64_t realtype, int32_t offset)
480 struct ieeeSection *target;
481 struct ieeeFixupp s;
483 /* Don't put a fixup for things NASM can calculate */
484 if (wrt == NO_SEG && segment == NO_SEG)
485 return;
487 s.ftype = -1;
488 /* if it is a WRT offset */
489 if (wrt != NO_SEG) {
490 s.ftype = FT_WRT;
491 s.addend = offset;
492 if (wrt >= SEG_ABS)
493 s.id1 = -(wrt - SEG_ABS);
494 else {
495 if (wrt % 2 && realtype != OUT_REL2ADR
496 && realtype != OUT_REL4ADR) {
497 wrt--;
499 for (target = seghead; target; target = target->next)
500 if (target->index == wrt)
501 break;
502 if (target) {
503 s.id1 = target->ieee_index;
504 for (target = seghead; target; target = target->next)
505 if (target->index == segment)
506 break;
508 if (target)
509 s.id2 = target->ieee_index;
510 else {
512 * Now we assume the segment field is being used
513 * to hold an extern index
515 int32_t i = segment / 2;
516 struct ExtBack *eb = ebhead;
517 while (i > EXT_BLKSIZ) {
518 if (eb)
519 eb = eb->next;
520 else
521 break;
522 i -= EXT_BLKSIZ;
524 /* if we have an extern decide the type and make a record
526 if (eb) {
527 s.ftype = FT_EXTWRT;
528 s.addend = 0;
529 s.id2 = eb->index[i];
530 } else
531 nasm_error(ERR_NONFATAL,
532 "Source of WRT must be an offset");
535 } else
536 nasm_error(ERR_PANIC,
537 "unrecognised WRT value in ieee_write_fixup");
538 } else
539 nasm_error(ERR_NONFATAL, "target of WRT must be a section ");
541 s.size = size;
542 ieee_install_fixup(segto, &s);
543 return;
545 /* Pure segment fixup ? */
546 if (segment != NO_SEG) {
547 s.ftype = FT_SEG;
548 s.id1 = 0;
549 if (segment >= SEG_ABS) {
550 /* absolute far segment fixup */
551 s.id1 = -(segment - ~SEG_ABS);
552 } else if (segment % 2) {
553 /* fixup to named segment */
554 /* look it up */
555 for (target = seghead; target; target = target->next)
556 if (target->index == segment - 1)
557 break;
558 if (target)
559 s.id1 = target->ieee_index;
560 else {
562 * Now we assume the segment field is being used
563 * to hold an extern index
565 int32_t i = segment / 2;
566 struct ExtBack *eb = ebhead;
567 while (i > EXT_BLKSIZ) {
568 if (eb)
569 eb = eb->next;
570 else
571 break;
572 i -= EXT_BLKSIZ;
574 /* if we have an extern decide the type and make a record
576 if (eb) {
577 if (realtype == OUT_REL2ADR || realtype == OUT_REL4ADR) {
578 nasm_error(ERR_PANIC,
579 "Segment of a rel not supported in ieee_write_fixup");
580 } else {
581 /* If we want the segment */
582 s.ftype = FT_EXTSEG;
583 s.addend = 0;
584 s.id1 = eb->index[i];
587 } else
588 /* If we get here the seg value doesn't make sense */
589 nasm_error(ERR_PANIC,
590 "unrecognised segment value in ieee_write_fixup");
593 } else {
594 /* Assume we are offsetting directly from a section
595 * So look up the target segment
597 for (target = seghead; target; target = target->next)
598 if (target->index == segment)
599 break;
600 if (target) {
601 if (realtype == OUT_REL2ADR || realtype == OUT_REL4ADR) {
602 /* PC rel to a known offset */
603 s.id1 = target->ieee_index;
604 s.ftype = FT_REL;
605 s.size = size;
606 s.addend = offset;
607 } else {
608 /* We were offsetting from a seg */
609 s.id1 = target->ieee_index;
610 s.ftype = FT_OFS;
611 s.size = size;
612 s.addend = offset;
614 } else {
616 * Now we assume the segment field is being used
617 * to hold an extern index
619 int32_t i = segment / 2;
620 struct ExtBack *eb = ebhead;
621 while (i > EXT_BLKSIZ) {
622 if (eb)
623 eb = eb->next;
624 else
625 break;
626 i -= EXT_BLKSIZ;
628 /* if we have an extern decide the type and make a record
630 if (eb) {
631 if (realtype == OUT_REL2ADR || realtype == OUT_REL4ADR) {
632 s.ftype = FT_EXTREL;
633 s.addend = 0;
634 s.id1 = eb->index[i];
635 } else {
636 /* else we want the external offset */
637 s.ftype = FT_EXT;
638 s.addend = 0;
639 s.id1 = eb->index[i];
642 } else
643 /* If we get here the seg value doesn't make sense */
644 nasm_error(ERR_PANIC,
645 "unrecognised segment value in ieee_write_fixup");
648 if (size != 2 && s.ftype == FT_SEG)
649 nasm_error(ERR_NONFATAL, "IEEE format can only handle 2-byte"
650 " segment base references");
651 s.size = size;
652 ieee_install_fixup(segto, &s);
653 return;
655 /* should never get here */
657 static void ieee_install_fixup(struct ieeeSection *seg,
658 struct ieeeFixupp *fix)
660 struct ieeeFixupp *f;
661 f = nasm_malloc(sizeof(struct ieeeFixupp));
662 memcpy(f, fix, sizeof(struct ieeeFixupp));
663 f->offset = seg->currentpos;
664 seg->currentpos += fix->size;
665 f->next = NULL;
666 if (seg->fptr)
667 seg->flptr = seg->flptr->next = f;
668 else
669 seg->fptr = seg->flptr = f;
674 * segment registry
676 static int32_t ieee_segment(char *name, int pass, int *bits)
679 * We call the label manager here to define a name for the new
680 * segment, and when our _own_ label-definition stub gets
681 * called in return, it should register the new segment name
682 * using the pointer it gets passed. That way we save memory,
683 * by sponging off the label manager.
685 if (!name) {
686 *bits = 16;
687 if (!any_segs)
688 return 0;
689 return seghead->index;
690 } else {
691 struct ieeeSection *seg;
692 int ieee_idx, attrs;
693 bool rn_error;
694 char *p;
697 * Look for segment attributes.
699 attrs = 0;
700 while (*name == '.')
701 name++; /* hack, but a documented one */
702 p = name;
703 while (*p && !nasm_isspace(*p))
704 p++;
705 if (*p) {
706 *p++ = '\0';
707 while (*p && nasm_isspace(*p))
708 *p++ = '\0';
710 while (*p) {
711 while (*p && !nasm_isspace(*p))
712 p++;
713 if (*p) {
714 *p++ = '\0';
715 while (*p && nasm_isspace(*p))
716 *p++ = '\0';
719 attrs++;
722 ieee_idx = 1;
723 for (seg = seghead; seg; seg = seg->next) {
724 ieee_idx++;
725 if (!strcmp(seg->name, name)) {
726 if (attrs > 0 && pass == 1)
727 nasm_error(ERR_WARNING, "segment attributes specified on"
728 " redeclaration of segment: ignoring");
729 if (seg->use32)
730 *bits = 32;
731 else
732 *bits = 16;
733 return seg->index;
737 *segtail = seg = nasm_malloc(sizeof(*seg));
738 seg->next = NULL;
739 segtail = &seg->next;
740 seg->index = seg_alloc();
741 seg->ieee_index = ieee_idx;
742 any_segs = true;
743 seg->name = NULL;
744 seg->currentpos = 0;
745 seg->align = 1; /* default */
746 seg->use32 = *bits == 32; /* default to user spec */
747 seg->combine = CMB_PUBLIC; /* default */
748 seg->pubhead = NULL;
749 seg->pubtail = &seg->pubhead;
750 seg->data = NULL;
751 seg->fptr = NULL;
752 seg->lochead = NULL;
753 seg->loctail = &seg->lochead;
756 * Process the segment attributes.
758 p = name;
759 while (attrs--) {
760 p += strlen(p);
761 while (!*p)
762 p++;
765 * `p' contains a segment attribute.
767 if (!nasm_stricmp(p, "private"))
768 seg->combine = CMB_PRIVATE;
769 else if (!nasm_stricmp(p, "public"))
770 seg->combine = CMB_PUBLIC;
771 else if (!nasm_stricmp(p, "common"))
772 seg->combine = CMB_COMMON;
773 else if (!nasm_stricmp(p, "use16"))
774 seg->use32 = false;
775 else if (!nasm_stricmp(p, "use32"))
776 seg->use32 = true;
777 else if (!nasm_strnicmp(p, "align=", 6)) {
778 seg->align = readnum(p + 6, &rn_error);
779 if (seg->align == 0)
780 seg->align = 1;
781 if (rn_error) {
782 seg->align = 1;
783 nasm_error(ERR_NONFATAL, "segment alignment should be"
784 " numeric");
786 switch ((int)seg->align) {
787 case 1: /* BYTE */
788 case 2: /* WORD */
789 case 4: /* DWORD */
790 case 16: /* PARA */
791 case 256: /* PAGE */
792 case 8:
793 case 32:
794 case 64:
795 case 128:
796 break;
797 default:
798 nasm_error(ERR_NONFATAL, "invalid alignment value %d",
799 seg->align);
800 seg->align = 1;
801 break;
803 } else if (!nasm_strnicmp(p, "absolute=", 9)) {
804 seg->align = SEG_ABS + readnum(p + 9, &rn_error);
805 if (rn_error)
806 nasm_error(ERR_NONFATAL, "argument to `absolute' segment"
807 " attribute should be numeric");
811 ieee_seg_needs_update = seg;
812 if (seg->align >= SEG_ABS)
813 define_label(name, NO_SEG, seg->align - SEG_ABS,
814 NULL, false, false);
815 else
816 define_label(name, seg->index + 1, 0L, NULL, false, false);
817 ieee_seg_needs_update = NULL;
819 if (seg->use32)
820 *bits = 32;
821 else
822 *bits = 16;
823 return seg->index;
828 * directives supported
830 static int ieee_directive(enum directives directive, char *value, int pass)
833 (void)value;
834 (void)pass;
836 switch (directive) {
837 case D_UPPERCASE:
838 ieee_uppercase = true;
839 return 1;
841 default:
842 return 0;
847 * Return segment data
849 static int32_t ieee_segbase(int32_t segment)
851 struct ieeeSection *seg;
854 * Find the segment in our list.
856 for (seg = seghead; seg; seg = seg->next)
857 if (seg->index == segment - 1)
858 break;
860 if (!seg)
861 return segment; /* not one of ours - leave it alone */
863 if (seg->align >= SEG_ABS)
864 return seg->align; /* absolute segment */
866 return segment; /* no special treatment */
870 * filename
872 static void ieee_filename(char *inname, char *outname)
874 strcpy(ieee_infile, inname);
875 standard_extension(inname, outname, ".o");
878 static void ieee_write_file(int debuginfo)
880 struct tm *thetime;
881 time_t reltime;
882 struct FileName *fn;
883 struct ieeeSection *seg;
884 struct ieeePublic *pub, *loc;
885 struct ieeeExternal *ext;
886 struct ieeeObjData *data;
887 struct ieeeFixupp *fix;
888 struct Array *arr;
889 int i;
892 * Write the module header
894 ieee_putascii("MBFNASM,%02X%s.\n", strlen(ieee_infile), ieee_infile);
897 * Write the NASM boast comment.
899 ieee_putascii("CO0,%02X%s.\n", strlen(nasm_comment), nasm_comment);
902 * write processor-specific information
904 ieee_putascii("AD8,4,L.\n");
907 * date and time
909 time(&reltime);
910 thetime = localtime(&reltime);
911 ieee_putascii("DT%04d%02d%02d%02d%02d%02d.\n",
912 1900 + thetime->tm_year, thetime->tm_mon + 1,
913 thetime->tm_mday, thetime->tm_hour, thetime->tm_min,
914 thetime->tm_sec);
916 * if debugging, dump file names
918 for (fn = fnhead; fn && debuginfo; fn = fn->next) {
919 ieee_putascii("C0105,%02X%s.\n", strlen(fn->name), fn->name);
922 ieee_putascii("CO101,07ENDHEAD.\n");
924 * the standard doesn't specify when to put checksums,
925 * we'll just do it periodically.
927 ieee_putcs(false);
930 * Write the section headers
932 seg = seghead;
933 if (!debuginfo && !strcmp(seg->name, "??LINE"))
934 seg = seg->next;
935 while (seg) {
936 char buf[256];
937 char attrib;
938 switch (seg->combine) {
939 case CMB_PUBLIC:
940 default:
941 attrib = 'C';
942 break;
943 case CMB_PRIVATE:
944 attrib = 'S';
945 break;
946 case CMB_COMMON:
947 attrib = 'M';
948 break;
950 ieee_unqualified_name(buf, seg->name);
951 if (seg->align >= SEG_ABS) {
952 ieee_putascii("ST%X,A,%02X%s.\n", seg->ieee_index,
953 strlen(buf), buf);
954 ieee_putascii("ASL%X,%lX.\n", seg->ieee_index,
955 (seg->align - SEG_ABS) * 16);
956 } else {
957 ieee_putascii("ST%X,%c,%02X%s.\n", seg->ieee_index, attrib,
958 strlen(buf), buf);
959 ieee_putascii("SA%X,%lX.\n", seg->ieee_index, seg->align);
960 ieee_putascii("ASS%X,%X.\n", seg->ieee_index,
961 seg->currentpos);
963 seg = seg->next;
966 * write the start address if there is one
968 if (ieee_entry_seg) {
969 for (seg = seghead; seg; seg = seg->next)
970 if (seg->index == ieee_entry_seg)
971 break;
972 if (!seg)
973 nasm_error(ERR_PANIC, "Start address records are incorrect");
974 else
975 ieee_putascii("ASG,R%X,%lX,+.\n", seg->ieee_index,
976 ieee_entry_ofs);
979 ieee_putcs(false);
981 * Write the publics
983 i = 1;
984 for (seg = seghead; seg; seg = seg->next) {
985 for (pub = seg->pubhead; pub; pub = pub->next) {
986 char buf[256];
987 ieee_unqualified_name(buf, pub->name);
988 ieee_putascii("NI%X,%02X%s.\n", i, strlen(buf), buf);
989 if (pub->segment == -1)
990 ieee_putascii("ASI%X,R%X,%lX,+.\n", i, pub->index,
991 pub->offset);
992 else
993 ieee_putascii("ASI%X,%lX,%lX,+.\n", i, pub->segment * 16,
994 pub->offset);
995 if (debuginfo) {
996 if (pub->type >= 0x100)
997 ieee_putascii("ATI%X,T%X.\n", i, pub->type - 0x100);
998 else
999 ieee_putascii("ATI%X,%X.\n", i, pub->type);
1001 i++;
1004 pub = fpubhead;
1005 i = 1;
1006 while (pub) {
1007 char buf[256];
1008 ieee_unqualified_name(buf, pub->name);
1009 ieee_putascii("NI%X,%02X%s.\n", i, strlen(buf), buf);
1010 if (pub->segment == -1)
1011 ieee_putascii("ASI%X,R%X,%lX,+.\n", i, pub->index,
1012 pub->offset);
1013 else
1014 ieee_putascii("ASI%X,%lX,%lX,+.\n", i, pub->segment * 16,
1015 pub->offset);
1016 if (debuginfo) {
1017 if (pub->type >= 0x100)
1018 ieee_putascii("ATI%X,T%X.\n", i, pub->type - 0x100);
1019 else
1020 ieee_putascii("ATI%X,%X.\n", i, pub->type);
1022 i++;
1023 pub = pub->next;
1026 * Write the externals
1028 ext = exthead;
1029 i = 1;
1030 while (ext) {
1031 char buf[256];
1032 ieee_unqualified_name(buf, ext->name);
1033 ieee_putascii("NX%X,%02X%s.\n", i++, strlen(buf), buf);
1034 ext = ext->next;
1036 ieee_putcs(false);
1039 * IEEE doesn't have a standard pass break record
1040 * so use the ladsoft variant
1042 ieee_putascii("CO100,06ENDSYM.\n");
1045 * now put types
1047 i = ARRAY_BOT;
1048 for (arr = arrhead; arr && debuginfo; arr = arr->next) {
1049 ieee_putascii("TY%X,20,%X,%lX.\n", i++, arr->basetype,
1050 arr->size);
1053 * now put locals
1055 i = 1;
1056 for (seg = seghead; seg && debuginfo; seg = seg->next) {
1057 for (loc = seg->lochead; loc; loc = loc->next) {
1058 char buf[256];
1059 ieee_unqualified_name(buf, loc->name);
1060 ieee_putascii("NN%X,%02X%s.\n", i, strlen(buf), buf);
1061 if (loc->segment == -1)
1062 ieee_putascii("ASN%X,R%X,%lX,+.\n", i, loc->index,
1063 loc->offset);
1064 else
1065 ieee_putascii("ASN%X,%lX,%lX,+.\n", i, loc->segment * 16,
1066 loc->offset);
1067 if (debuginfo) {
1068 if (loc->type >= 0x100)
1069 ieee_putascii("ATN%X,T%X.\n", i, loc->type - 0x100);
1070 else
1071 ieee_putascii("ATN%X,%X.\n", i, loc->type);
1073 i++;
1078 * put out section data;
1080 seg = seghead;
1081 if (!debuginfo && !strcmp(seg->name, "??LINE"))
1082 seg = seg->next;
1083 while (seg) {
1084 if (seg->currentpos) {
1085 int32_t size, org = 0;
1086 data = seg->data;
1087 ieee_putascii("SB%X.\n", seg->ieee_index);
1088 fix = seg->fptr;
1089 while (fix) {
1090 size = HUNKSIZE - (org % HUNKSIZE);
1091 size =
1092 size + org >
1093 seg->currentpos ? seg->currentpos - org : size;
1094 size = fix->offset - org > size ? size : fix->offset - org;
1095 org = ieee_putld(org, org + size, data->data);
1096 if (org % HUNKSIZE == 0)
1097 data = data->next;
1098 if (org == fix->offset) {
1099 org += ieee_putlr(fix);
1100 fix = fix->next;
1103 while (org < seg->currentpos && data) {
1104 size =
1105 seg->currentpos - org >
1106 HUNKSIZE ? HUNKSIZE : seg->currentpos - org;
1107 org = ieee_putld(org, org + size, data->data);
1108 data = data->next;
1110 ieee_putcs(false);
1113 seg = seg->next;
1116 * module end record
1118 ieee_putascii("ME.\n");
1121 static void ieee_write_byte(struct ieeeSection *seg, int data)
1123 int temp;
1124 if (!(temp = seg->currentpos++ % HUNKSIZE))
1125 ieee_data_new(seg);
1126 seg->datacurr->data[temp] = data;
1129 static void ieee_write_word(struct ieeeSection *seg, int data)
1131 ieee_write_byte(seg, data & 0xFF);
1132 ieee_write_byte(seg, (data >> 8) & 0xFF);
1135 static void ieee_write_dword(struct ieeeSection *seg, int32_t data)
1137 ieee_write_byte(seg, data & 0xFF);
1138 ieee_write_byte(seg, (data >> 8) & 0xFF);
1139 ieee_write_byte(seg, (data >> 16) & 0xFF);
1140 ieee_write_byte(seg, (data >> 24) & 0xFF);
1142 static void ieee_putascii(char *format, ...)
1144 char buffer[256];
1145 int i, l;
1146 va_list ap;
1148 va_start(ap, format);
1149 vsnprintf(buffer, sizeof(buffer), format, ap);
1150 l = strlen(buffer);
1151 for (i = 0; i < l; i++)
1152 if ((uint8_t)buffer[i] > 31)
1153 checksum += buffer[i];
1154 va_end(ap);
1155 fprintf(ofile, buffer);
1159 * put out a checksum record */
1160 static void ieee_putcs(int toclear)
1162 if (toclear) {
1163 ieee_putascii("CS.\n");
1164 } else {
1165 checksum += 'C';
1166 checksum += 'S';
1167 ieee_putascii("CS%02X.\n", checksum & 127);
1169 checksum = 0;
1172 static int32_t ieee_putld(int32_t start, int32_t end, uint8_t *buf)
1174 int32_t val;
1175 if (start == end)
1176 return (start);
1177 val = start % HUNKSIZE;
1178 /* fill up multiple lines */
1179 while (end - start >= LDPERLINE) {
1180 int i;
1181 ieee_putascii("LD");
1182 for (i = 0; i < LDPERLINE; i++) {
1183 ieee_putascii("%02X", buf[val++]);
1184 start++;
1186 ieee_putascii(".\n");
1188 /* if no partial lines */
1189 if (start == end)
1190 return (start);
1191 /* make a partial line */
1192 ieee_putascii("LD");
1193 while (start < end) {
1194 ieee_putascii("%02X", buf[val++]);
1195 start++;
1197 ieee_putascii(".\n");
1198 return (start);
1200 static int32_t ieee_putlr(struct ieeeFixupp *p)
1203 * To deal with the vagaries of segmentation the LADsoft linker
1204 * defines two types of segments: absolute and virtual. Note that
1205 * 'absolute' in this context is a different thing from the IEEE
1206 * definition of an absolute segment type, which is also supported. If a
1207 * sement is linked in virtual mode the low limit (L-var) is
1208 * subtracted from each R,X, and P variable which appears in an
1209 * expression, so that we can have relative offsets. Meanwhile
1210 * in the ABSOLUTE mode this subtraction is not done and
1211 * so we can use absolute offsets from 0. In the LADsoft linker
1212 * this configuration is not done in the assemblker source but in
1213 * a source the linker reads. Generally this type of thing only
1214 * becomes an issue if real mode code is used. A pure 32-bit linker could
1215 * get away without defining the virtual mode...
1217 char buf[40];
1218 int32_t size = p->size;
1219 switch (p->ftype) {
1220 case FT_SEG:
1221 if (p->id1 < 0)
1222 sprintf(buf, "%"PRIX32"", -p->id1);
1223 else
1224 sprintf(buf, "L%"PRIX32",10,/", p->id1);
1225 break;
1226 case FT_OFS:
1227 sprintf(buf, "R%"PRIX32",%"PRIX32",+", p->id1, p->addend);
1228 break;
1229 case FT_REL:
1230 sprintf(buf, "R%"PRIX32",%"PRIX32",+,P,-,%X,-", p->id1, p->addend, p->size);
1231 break;
1233 case FT_WRT:
1234 if (p->id2 < 0)
1235 sprintf(buf, "R%"PRIX32",%"PRIX32",+,L%"PRIX32",+,%"PRIX32",-", p->id2, p->addend,
1236 p->id2, -p->id1 * 16);
1237 else
1238 sprintf(buf, "R%"PRIX32",%"PRIX32",+,L%"PRIX32",+,L%"PRIX32",-", p->id2, p->addend,
1239 p->id2, p->id1);
1240 break;
1241 case FT_EXT:
1242 sprintf(buf, "X%"PRIX32"", p->id1);
1243 break;
1244 case FT_EXTREL:
1245 sprintf(buf, "X%"PRIX32",P,-,%"PRIX32",-", p->id1, size);
1246 break;
1247 case FT_EXTSEG:
1248 /* We needed a non-ieee hack here.
1249 * We introduce the Y variable, which is the low
1250 * limit of the native segment the extern resides in
1252 sprintf(buf, "Y%"PRIX32",10,/", p->id1);
1253 break;
1254 case FT_EXTWRT:
1255 if (p->id2 < 0)
1256 sprintf(buf, "X%"PRIX32",Y%"PRIX32",+,%"PRIX32",-", p->id2, p->id2,
1257 -p->id1 * 16);
1258 else
1259 sprintf(buf, "X%"PRIX32",Y%"PRIX32",+,L%"PRIX32",-", p->id2, p->id2, p->id1);
1260 break;
1262 ieee_putascii("LR(%s,%"PRIX32").\n", buf, size);
1264 return (size);
1267 /* Dump all segment data (text and fixups )*/
1269 static void ieee_unqualified_name(char *dest, char *source)
1271 if (ieee_uppercase) {
1272 while (*source)
1273 *dest++ = toupper(*source++);
1274 *dest = 0;
1275 } else
1276 strcpy(dest, source);
1278 void dbgls_init(void)
1280 int tempint;
1282 fnhead = NULL;
1283 fntail = &fnhead;
1284 arrindex = ARRAY_BOT;
1285 arrhead = NULL;
1286 arrtail = &arrhead;
1287 ieee_segment("??LINE", 2, &tempint);
1288 any_segs = false;
1290 static void dbgls_cleanup(void)
1292 struct ieeeSection *segtmp;
1293 while (fnhead) {
1294 struct FileName *fntemp = fnhead;
1295 fnhead = fnhead->next;
1296 nasm_free(fntemp->name);
1297 nasm_free(fntemp);
1299 for (segtmp = seghead; segtmp; segtmp = segtmp->next) {
1300 while (segtmp->lochead) {
1301 struct ieeePublic *loctmp = segtmp->lochead;
1302 segtmp->lochead = loctmp->next;
1303 nasm_free(loctmp->name);
1304 nasm_free(loctmp);
1307 while (arrhead) {
1308 struct Array *arrtmp = arrhead;
1309 arrhead = arrhead->next;
1310 nasm_free(arrtmp);
1315 * because this routine is not bracketed in
1316 * the main program, this routine will be called even if there
1317 * is no request for debug info
1318 * so, we have to make sure the ??LINE segment is avaialbe
1319 * as the first segment when this debug format is selected
1321 static void dbgls_linnum(const char *lnfname, int32_t lineno, int32_t segto)
1323 struct FileName *fn;
1324 struct ieeeSection *seg;
1325 int i = 0;
1326 if (segto == NO_SEG)
1327 return;
1330 * If `any_segs' is still false, we must define a default
1331 * segment.
1333 if (!any_segs) {
1334 int tempint; /* ignored */
1335 if (segto != ieee_segment("__NASMDEFSEG", 2, &tempint))
1336 nasm_error(ERR_PANIC, "strange segment conditions in OBJ driver");
1340 * Find the segment we are targetting.
1342 for (seg = seghead; seg; seg = seg->next)
1343 if (seg->index == segto)
1344 break;
1345 if (!seg)
1346 nasm_error(ERR_PANIC, "lineno directed to nonexistent segment?");
1348 for (fn = fnhead; fn; fn = fn->next) {
1349 if (!nasm_stricmp(lnfname, fn->name))
1350 break;
1351 i++;
1353 if (!fn) {
1354 fn = nasm_malloc(sizeof(*fn));
1355 fn->name = nasm_malloc(strlen(lnfname) + 1);
1356 fn->index = i;
1357 strcpy(fn->name, lnfname);
1358 fn->next = NULL;
1359 *fntail = fn;
1360 fntail = &fn->next;
1362 ieee_write_byte(seghead, fn->index);
1363 ieee_write_word(seghead, lineno);
1364 ieee_write_fixup(segto, NO_SEG, seghead, 4, OUT_ADDRESS,
1365 seg->currentpos);
1368 static void dbgls_deflabel(char *name, int32_t segment,
1369 int64_t offset, int is_global, char *special)
1371 struct ieeeSection *seg;
1373 /* Keep compiler from warning about special */
1374 (void)special;
1377 * If it's a special-retry from pass two, discard it.
1379 if (is_global == 3)
1380 return;
1383 * First check for the double-period, signifying something
1384 * unusual.
1386 if (name[0] == '.' && name[1] == '.' && name[2] != '@') {
1387 return;
1391 * Case (i):
1393 if (ieee_seg_needs_update)
1394 return;
1395 if (segment < SEG_ABS && segment != NO_SEG && segment % 2)
1396 return;
1398 if (segment >= SEG_ABS || segment == NO_SEG) {
1399 return;
1403 * If `any_segs' is still false, we might need to define a
1404 * default segment, if they're trying to declare a label in
1405 * `first_seg'. But the label should exist due to a prior
1406 * call to ieee_deflabel so we can skip that.
1409 for (seg = seghead; seg; seg = seg->next)
1410 if (seg->index == segment) {
1411 struct ieeePublic *loc;
1413 * Case (ii). Maybe MODPUB someday?
1415 if (!is_global) {
1416 last_defined = loc = nasm_malloc(sizeof(*loc));
1417 *seg->loctail = loc;
1418 seg->loctail = &loc->next;
1419 loc->next = NULL;
1420 loc->name = nasm_strdup(name);
1421 loc->offset = offset;
1422 loc->segment = -1;
1423 loc->index = seg->ieee_index;
1427 static void dbgls_typevalue(int32_t type)
1429 int elem = TYM_ELEMENTS(type);
1430 type = TYM_TYPE(type);
1432 if (!last_defined)
1433 return;
1435 switch (type) {
1436 case TY_BYTE:
1437 last_defined->type = 1; /* uint8_t */
1438 break;
1439 case TY_WORD:
1440 last_defined->type = 3; /* unsigned word */
1441 break;
1442 case TY_DWORD:
1443 last_defined->type = 5; /* unsigned dword */
1444 break;
1445 case TY_FLOAT:
1446 last_defined->type = 9; /* float */
1447 break;
1448 case TY_QWORD:
1449 last_defined->type = 10; /* qword */
1450 break;
1451 case TY_TBYTE:
1452 last_defined->type = 11; /* TBYTE */
1453 break;
1454 default:
1455 last_defined->type = 0x10; /* near label */
1456 break;
1459 if (elem > 1) {
1460 struct Array *arrtmp = nasm_malloc(sizeof(*arrtmp));
1461 int vtype = last_defined->type;
1462 arrtmp->size = elem;
1463 arrtmp->basetype = vtype;
1464 arrtmp->next = NULL;
1465 last_defined->type = arrindex++ + 0x100;
1466 *arrtail = arrtmp;
1467 arrtail = &(arrtmp->next);
1469 last_defined = NULL;
1471 static void dbgls_output(int output_type, void *param)
1473 (void)output_type;
1474 (void)param;
1476 static struct dfmt ladsoft_debug_form = {
1477 "LADsoft Debug Records",
1478 "ladsoft",
1479 dbgls_init,
1480 dbgls_linnum,
1481 dbgls_deflabel,
1482 null_debug_directive,
1483 dbgls_typevalue,
1484 dbgls_output,
1485 dbgls_cleanup,
1487 static struct dfmt *ladsoft_debug_arr[3] = {
1488 &ladsoft_debug_form,
1489 &null_debug_form,
1490 NULL
1492 struct ofmt of_ieee = {
1493 "IEEE-695 (LADsoft variant) object file format",
1494 "ieee",
1495 OFMT_TEXT,
1496 ladsoft_debug_arr,
1497 &ladsoft_debug_form,
1498 NULL,
1499 ieee_init,
1500 ieee_set_info,
1501 ieee_out,
1502 ieee_deflabel,
1503 ieee_segment,
1504 ieee_segbase,
1505 ieee_directive,
1506 ieee_filename,
1507 ieee_cleanup
1510 #endif /* OF_IEEE */