eval: Use nasm_error helpers
[nasm.git] / output / outieee.c
blobce4830da88e95125059ff52ba708abd42eca0613
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
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>
77 #include "nasm.h"
78 #include "nasmlib.h"
79 #include "error.h"
80 #include "ver.h"
82 #include "outform.h"
83 #include "outlib.h"
85 #ifdef OF_IEEE
87 #define ARRAY_BOT 0x1
89 static char ieee_infile[FILENAME_MAX];
90 static int ieee_uppercase;
92 static bool any_segs;
93 static int arrindex;
95 #define HUNKSIZE 1024 /* Size of the data hunk */
96 #define EXT_BLKSIZ 512
97 #define LDPERLINE 32 /* bytes per line in output */
99 struct ieeeSection;
101 struct LineNumber {
102 struct LineNumber *next;
103 struct ieeeSection *segment;
104 int32_t offset;
105 int32_t lineno;
108 static struct FileName {
109 struct FileName *next;
110 char *name;
111 int32_t index;
112 } *fnhead, **fntail;
114 static struct Array {
115 struct Array *next;
116 unsigned size;
117 int basetype;
118 } *arrhead, **arrtail;
120 static struct ieeePublic {
121 struct ieeePublic *next;
122 char *name;
123 int32_t offset;
124 int32_t segment; /* only if it's far-absolute */
125 int32_t index;
126 int type; /* for debug purposes */
127 } *fpubhead, **fpubtail, *last_defined;
129 static struct ieeeExternal {
130 struct ieeeExternal *next;
131 char *name;
132 int32_t commonsize;
133 } *exthead, **exttail;
135 static int externals;
137 static struct ExtBack {
138 struct ExtBack *next;
139 int index[EXT_BLKSIZ];
140 } *ebhead, **ebtail;
142 /* NOTE: the first segment MUST be the lineno segment */
143 static struct ieeeSection {
144 struct ieeeSection *next;
145 char *name;
146 struct ieeeObjData *data, *datacurr;
147 struct ieeeFixupp *fptr, *flptr;
148 int32_t index; /* the NASM segment id */
149 int32_t ieee_index; /* the OBJ-file segment index */
150 int32_t currentpos;
151 int32_t align; /* can be SEG_ABS + absolute addr */
152 int32_t startpos;
153 int32_t use32; /* is this segment 32-bit? */
154 struct ieeePublic *pubhead, **pubtail, *lochead, **loctail;
155 enum {
156 CMB_PRIVATE = 0,
157 CMB_PUBLIC = 2,
158 CMB_COMMON = 6
159 } combine;
160 } *seghead, **segtail, *ieee_seg_needs_update;
162 struct ieeeObjData {
163 struct ieeeObjData *next;
164 uint8_t data[HUNKSIZE];
167 struct ieeeFixupp {
168 struct ieeeFixupp *next;
169 enum {
170 FT_SEG = 0,
171 FT_REL = 1,
172 FT_OFS = 2,
173 FT_EXT = 3,
174 FT_WRT = 4,
175 FT_EXTREL = 5,
176 FT_EXTWRT = 6,
177 FT_EXTSEG = 7
178 } ftype;
179 int16_t size;
180 int32_t id1;
181 int32_t id2;
182 int32_t offset;
183 int32_t addend;
186 static int32_t ieee_entry_seg, ieee_entry_ofs;
187 static int checksum;
189 extern const struct ofmt of_ieee;
190 static const struct dfmt ladsoft_debug_form;
192 static void ieee_data_new(struct ieeeSection *);
193 static void ieee_write_fixup(int32_t, int32_t, struct ieeeSection *,
194 int, uint64_t, int32_t);
195 static void ieee_install_fixup(struct ieeeSection *, struct ieeeFixupp *);
196 static int32_t ieee_segment(char *, int, int *);
197 static void ieee_write_file(void);
198 static void ieee_write_byte(struct ieeeSection *, int);
199 static void ieee_write_word(struct ieeeSection *, int);
200 static void ieee_write_dword(struct ieeeSection *, int32_t);
201 static void ieee_putascii(char *, ...);
202 static void ieee_putcs(int);
203 static int32_t ieee_putld(int32_t, int32_t, uint8_t *);
204 static int32_t ieee_putlr(struct ieeeFixupp *);
205 static void ieee_unqualified_name(char *, char *);
208 * pup init
210 static void ieee_init(void)
212 strlcpy(ieee_infile, inname, sizeof(ieee_infile));
213 any_segs = false;
214 fpubhead = NULL;
215 fpubtail = &fpubhead;
216 exthead = NULL;
217 exttail = &exthead;
218 externals = 1;
219 ebhead = NULL;
220 ebtail = &ebhead;
221 seghead = ieee_seg_needs_update = NULL;
222 segtail = &seghead;
223 ieee_entry_seg = NO_SEG;
224 ieee_uppercase = false;
225 checksum = 0;
229 * Rundown
231 static void ieee_cleanup(void)
233 ieee_write_file();
234 dfmt->cleanup();
235 while (seghead) {
236 struct ieeeSection *segtmp = seghead;
237 seghead = seghead->next;
238 while (segtmp->pubhead) {
239 struct ieeePublic *pubtmp = segtmp->pubhead;
240 segtmp->pubhead = pubtmp->next;
241 nasm_free(pubtmp);
243 while (segtmp->fptr) {
244 struct ieeeFixupp *fixtmp = segtmp->fptr;
245 segtmp->fptr = fixtmp->next;
246 nasm_free(fixtmp);
248 while (segtmp->data) {
249 struct ieeeObjData *dattmp = segtmp->data;
250 segtmp->data = dattmp->next;
251 nasm_free(dattmp);
253 nasm_free(segtmp);
255 while (fpubhead) {
256 struct ieeePublic *pubtmp = fpubhead;
257 fpubhead = fpubhead->next;
258 nasm_free(pubtmp);
260 while (exthead) {
261 struct ieeeExternal *exttmp = exthead;
262 exthead = exthead->next;
263 nasm_free(exttmp);
265 while (ebhead) {
266 struct ExtBack *ebtmp = ebhead;
267 ebhead = ebhead->next;
268 nasm_free(ebtmp);
273 * callback for labels
275 static void ieee_deflabel(char *name, int32_t segment,
276 int64_t offset, int is_global, char *special)
279 * We have three cases:
281 * (i) `segment' is a segment-base. If so, set the name field
282 * for the segment structure it refers to, and then
283 * return.
285 * (ii) `segment' is one of our segments, or a SEG_ABS segment.
286 * Save the label position for later output of a PUBDEF record.
289 * (iii) `segment' is not one of our segments. Save the label
290 * position for later output of an EXTDEF.
292 struct ieeeExternal *ext;
293 struct ExtBack *eb;
294 struct ieeeSection *seg;
295 int i;
297 if (special) {
298 nasm_error(ERR_NONFATAL, "unrecognised symbol type `%s'", special);
301 * First check for the double-period, signifying something
302 * unusual.
304 if (name[0] == '.' && name[1] == '.' && name[2] != '@') {
305 if (!strcmp(name, "..start")) {
306 ieee_entry_seg = segment;
307 ieee_entry_ofs = offset;
309 return;
313 * Case (i):
315 if (ieee_seg_needs_update) {
316 ieee_seg_needs_update->name = name;
317 return;
319 if (segment < SEG_ABS && segment != NO_SEG && segment % 2)
320 return;
323 * case (ii)
325 if (segment >= SEG_ABS) {
327 * SEG_ABS subcase of (ii).
329 if (is_global) {
330 struct ieeePublic *pub;
332 pub = *fpubtail = nasm_malloc(sizeof(*pub));
333 fpubtail = &pub->next;
334 pub->next = NULL;
335 pub->name = name;
336 pub->offset = offset;
337 pub->segment = segment & ~SEG_ABS;
339 return;
342 for (seg = seghead; seg && is_global; seg = seg->next)
343 if (seg->index == segment) {
344 struct ieeePublic *pub;
346 last_defined = pub = *seg->pubtail = nasm_malloc(sizeof(*pub));
347 seg->pubtail = &pub->next;
348 pub->next = NULL;
349 pub->name = name;
350 pub->offset = offset;
351 pub->index = seg->ieee_index;
352 pub->segment = -1;
353 return;
357 * Case (iii).
359 if (is_global) {
360 ext = *exttail = nasm_malloc(sizeof(*ext));
361 ext->next = NULL;
362 exttail = &ext->next;
363 ext->name = name;
364 if (is_global == 2)
365 ext->commonsize = offset;
366 else
367 ext->commonsize = 0;
368 i = segment / 2;
369 eb = ebhead;
370 if (!eb) {
371 eb = *ebtail = nasm_zalloc(sizeof(*eb));
372 eb->next = NULL;
373 ebtail = &eb->next;
375 while (i > EXT_BLKSIZ) {
376 if (eb && eb->next)
377 eb = eb->next;
378 else {
379 eb = *ebtail = nasm_zalloc(sizeof(*eb));
380 eb->next = NULL;
381 ebtail = &eb->next;
383 i -= EXT_BLKSIZ;
385 eb->index[i] = externals++;
391 * Put data out
393 static void ieee_out(int32_t segto, const void *data,
394 enum out_type type, uint64_t size,
395 int32_t segment, int32_t wrt)
397 const uint8_t *ucdata;
398 int32_t ldata;
399 struct ieeeSection *seg;
402 * If `any_segs' is still false, we must define a default
403 * segment.
405 if (!any_segs) {
406 int tempint; /* ignored */
407 if (segto != ieee_segment("__NASMDEFSEG", 2, &tempint))
408 nasm_panic("strange segment conditions in IEEE driver");
412 * Find the segment we are targetting.
414 for (seg = seghead; seg; seg = seg->next)
415 if (seg->index == segto)
416 break;
417 if (!seg)
418 nasm_panic("code directed to nonexistent segment?");
420 if (type == OUT_RAWDATA) {
421 ucdata = data;
422 while (size--)
423 ieee_write_byte(seg, *ucdata++);
424 } else if (type == OUT_ADDRESS || type == OUT_REL2ADR ||
425 type == OUT_REL4ADR) {
426 if (type == OUT_ADDRESS)
427 size = abs((int)size);
428 else if (segment == NO_SEG)
429 nasm_error(ERR_NONFATAL, "relative call to absolute address not"
430 " supported by IEEE format");
431 ldata = *(int64_t *)data;
432 if (type == OUT_REL2ADR)
433 ldata += (size - 2);
434 if (type == OUT_REL4ADR)
435 ldata += (size - 4);
436 ieee_write_fixup(segment, wrt, seg, size, type, ldata);
437 if (size == 2)
438 ieee_write_word(seg, ldata);
439 else
440 ieee_write_dword(seg, ldata);
441 } else if (type == OUT_RESERVE) {
442 while (size--)
443 ieee_write_byte(seg, 0);
447 static void ieee_data_new(struct ieeeSection *segto)
450 if (!segto->data)
451 segto->data = segto->datacurr =
452 nasm_malloc(sizeof(*(segto->datacurr)));
453 else
454 segto->datacurr = segto->datacurr->next =
455 nasm_malloc(sizeof(*(segto->datacurr)));
456 segto->datacurr->next = NULL;
460 * this routine is unalduterated bloatware. I usually don't do this
461 * but I might as well see what it is like on a harmless program.
462 * If anyone wants to optimize this is a good canditate!
464 static void ieee_write_fixup(int32_t segment, int32_t wrt,
465 struct ieeeSection *segto, int size,
466 uint64_t realtype, int32_t offset)
468 struct ieeeSection *target;
469 struct ieeeFixupp s;
471 /* Don't put a fixup for things NASM can calculate */
472 if (wrt == NO_SEG && segment == NO_SEG)
473 return;
475 s.ftype = -1;
476 /* if it is a WRT offset */
477 if (wrt != NO_SEG) {
478 s.ftype = FT_WRT;
479 s.addend = offset;
480 if (wrt >= SEG_ABS)
481 s.id1 = -(wrt - SEG_ABS);
482 else {
483 if (wrt % 2 && realtype != OUT_REL2ADR
484 && realtype != OUT_REL4ADR) {
485 wrt--;
487 for (target = seghead; target; target = target->next)
488 if (target->index == wrt)
489 break;
490 if (target) {
491 s.id1 = target->ieee_index;
492 for (target = seghead; target; target = target->next)
493 if (target->index == segment)
494 break;
496 if (target)
497 s.id2 = target->ieee_index;
498 else {
500 * Now we assume the segment field is being used
501 * to hold an extern index
503 int32_t i = segment / 2;
504 struct ExtBack *eb = ebhead;
505 while (i > EXT_BLKSIZ) {
506 if (eb)
507 eb = eb->next;
508 else
509 break;
510 i -= EXT_BLKSIZ;
512 /* if we have an extern decide the type and make a record
514 if (eb) {
515 s.ftype = FT_EXTWRT;
516 s.addend = 0;
517 s.id2 = eb->index[i];
518 } else
519 nasm_error(ERR_NONFATAL,
520 "Source of WRT must be an offset");
523 } else
524 nasm_panic("unrecognised WRT value in ieee_write_fixup");
525 } else
526 nasm_error(ERR_NONFATAL, "target of WRT must be a section ");
528 s.size = size;
529 ieee_install_fixup(segto, &s);
530 return;
532 /* Pure segment fixup ? */
533 if (segment != NO_SEG) {
534 s.ftype = FT_SEG;
535 s.id1 = 0;
536 if (segment >= SEG_ABS) {
537 /* absolute far segment fixup */
538 s.id1 = -(segment - ~SEG_ABS);
539 } else if (segment % 2) {
540 /* fixup to named segment */
541 /* look it up */
542 for (target = seghead; target; target = target->next)
543 if (target->index == segment - 1)
544 break;
545 if (target)
546 s.id1 = target->ieee_index;
547 else {
549 * Now we assume the segment field is being used
550 * to hold an extern index
552 int32_t i = segment / 2;
553 struct ExtBack *eb = ebhead;
554 while (i > EXT_BLKSIZ) {
555 if (eb)
556 eb = eb->next;
557 else
558 break;
559 i -= EXT_BLKSIZ;
561 /* if we have an extern decide the type and make a record
563 if (eb) {
564 if (realtype == OUT_REL2ADR || realtype == OUT_REL4ADR) {
565 nasm_panic("Segment of a rel not supported in ieee_write_fixup");
566 } else {
567 /* If we want the segment */
568 s.ftype = FT_EXTSEG;
569 s.addend = 0;
570 s.id1 = eb->index[i];
573 } else
574 /* If we get here the seg value doesn't make sense */
575 nasm_panic("unrecognised segment value in ieee_write_fixup");
578 } else {
579 /* Assume we are offsetting directly from a section
580 * So look up the target segment
582 for (target = seghead; target; target = target->next)
583 if (target->index == segment)
584 break;
585 if (target) {
586 if (realtype == OUT_REL2ADR || realtype == OUT_REL4ADR) {
587 /* PC rel to a known offset */
588 s.id1 = target->ieee_index;
589 s.ftype = FT_REL;
590 s.size = size;
591 s.addend = offset;
592 } else {
593 /* We were offsetting from a seg */
594 s.id1 = target->ieee_index;
595 s.ftype = FT_OFS;
596 s.size = size;
597 s.addend = offset;
599 } else {
601 * Now we assume the segment field is being used
602 * to hold an extern index
604 int32_t i = segment / 2;
605 struct ExtBack *eb = ebhead;
606 while (i > EXT_BLKSIZ) {
607 if (eb)
608 eb = eb->next;
609 else
610 break;
611 i -= EXT_BLKSIZ;
613 /* if we have an extern decide the type and make a record
615 if (eb) {
616 if (realtype == OUT_REL2ADR || realtype == OUT_REL4ADR) {
617 s.ftype = FT_EXTREL;
618 s.addend = 0;
619 s.id1 = eb->index[i];
620 } else {
621 /* else we want the external offset */
622 s.ftype = FT_EXT;
623 s.addend = 0;
624 s.id1 = eb->index[i];
627 } else
628 /* If we get here the seg value doesn't make sense */
629 nasm_panic("unrecognised segment value in ieee_write_fixup");
632 if (size != 2 && s.ftype == FT_SEG)
633 nasm_error(ERR_NONFATAL, "IEEE format can only handle 2-byte"
634 " segment base references");
635 s.size = size;
636 ieee_install_fixup(segto, &s);
637 return;
639 /* should never get here */
641 static void ieee_install_fixup(struct ieeeSection *seg,
642 struct ieeeFixupp *fix)
644 struct ieeeFixupp *f;
645 f = nasm_malloc(sizeof(struct ieeeFixupp));
646 memcpy(f, fix, sizeof(struct ieeeFixupp));
647 f->offset = seg->currentpos;
648 seg->currentpos += fix->size;
649 f->next = NULL;
650 if (seg->fptr)
651 seg->flptr = seg->flptr->next = f;
652 else
653 seg->fptr = seg->flptr = f;
658 * segment registry
660 static int32_t ieee_segment(char *name, int pass, int *bits)
663 * We call the label manager here to define a name for the new
664 * segment, and when our _own_ label-definition stub gets
665 * called in return, it should register the new segment name
666 * using the pointer it gets passed. That way we save memory,
667 * by sponging off the label manager.
669 if (!name) {
670 *bits = 16;
671 if (!any_segs)
672 return 0;
673 return seghead->index;
674 } else {
675 struct ieeeSection *seg;
676 int ieee_idx, attrs;
677 bool rn_error;
678 char *p;
681 * Look for segment attributes.
683 attrs = 0;
684 while (*name == '.')
685 name++; /* hack, but a documented one */
686 p = name;
687 while (*p && !nasm_isspace(*p))
688 p++;
689 if (*p) {
690 *p++ = '\0';
691 while (*p && nasm_isspace(*p))
692 *p++ = '\0';
694 while (*p) {
695 while (*p && !nasm_isspace(*p))
696 p++;
697 if (*p) {
698 *p++ = '\0';
699 while (*p && nasm_isspace(*p))
700 *p++ = '\0';
703 attrs++;
706 ieee_idx = 1;
707 for (seg = seghead; seg; seg = seg->next) {
708 ieee_idx++;
709 if (!strcmp(seg->name, name)) {
710 if (attrs > 0 && pass == 1)
711 nasm_error(ERR_WARNING, "segment attributes specified on"
712 " redeclaration of segment: ignoring");
713 if (seg->use32)
714 *bits = 32;
715 else
716 *bits = 16;
717 return seg->index;
721 *segtail = seg = nasm_malloc(sizeof(*seg));
722 seg->next = NULL;
723 segtail = &seg->next;
724 seg->index = seg_alloc();
725 seg->ieee_index = ieee_idx;
726 any_segs = true;
727 seg->name = NULL;
728 seg->currentpos = 0;
729 seg->align = 1; /* default */
730 seg->use32 = *bits == 32; /* default to user spec */
731 seg->combine = CMB_PUBLIC; /* default */
732 seg->pubhead = NULL;
733 seg->pubtail = &seg->pubhead;
734 seg->data = NULL;
735 seg->fptr = NULL;
736 seg->lochead = NULL;
737 seg->loctail = &seg->lochead;
740 * Process the segment attributes.
742 p = name;
743 while (attrs--) {
744 p += strlen(p);
745 while (!*p)
746 p++;
749 * `p' contains a segment attribute.
751 if (!nasm_stricmp(p, "private"))
752 seg->combine = CMB_PRIVATE;
753 else if (!nasm_stricmp(p, "public"))
754 seg->combine = CMB_PUBLIC;
755 else if (!nasm_stricmp(p, "common"))
756 seg->combine = CMB_COMMON;
757 else if (!nasm_stricmp(p, "use16"))
758 seg->use32 = false;
759 else if (!nasm_stricmp(p, "use32"))
760 seg->use32 = true;
761 else if (!nasm_strnicmp(p, "align=", 6)) {
762 seg->align = readnum(p + 6, &rn_error);
763 if (seg->align == 0)
764 seg->align = 1;
765 if (rn_error) {
766 seg->align = 1;
767 nasm_error(ERR_NONFATAL, "segment alignment should be"
768 " numeric");
770 switch (seg->align) {
771 case 1: /* BYTE */
772 case 2: /* WORD */
773 case 4: /* DWORD */
774 case 16: /* PARA */
775 case 256: /* PAGE */
776 case 8:
777 case 32:
778 case 64:
779 case 128:
780 break;
781 default:
782 nasm_error(ERR_NONFATAL, "invalid alignment value %d",
783 seg->align);
784 seg->align = 1;
785 break;
787 } else if (!nasm_strnicmp(p, "absolute=", 9)) {
788 seg->align = SEG_ABS + readnum(p + 9, &rn_error);
789 if (rn_error)
790 nasm_error(ERR_NONFATAL, "argument to `absolute' segment"
791 " attribute should be numeric");
795 ieee_seg_needs_update = seg;
796 if (seg->align >= SEG_ABS)
797 define_label(name, NO_SEG, seg->align - SEG_ABS, false);
798 else
799 define_label(name, seg->index + 1, 0L, false);
800 ieee_seg_needs_update = NULL;
802 if (seg->use32)
803 *bits = 32;
804 else
805 *bits = 16;
806 return seg->index;
811 * directives supported
813 static enum directive_result
814 ieee_directive(enum directive directive, char *value, int pass)
817 (void)value;
818 (void)pass;
820 switch (directive) {
821 case D_UPPERCASE:
822 ieee_uppercase = true;
823 return DIRR_OK;
825 default:
826 return DIRR_UNKNOWN;
830 static void ieee_sectalign(int32_t seg, unsigned int value)
832 struct ieeeSection *s;
834 list_for_each(s, seghead) {
835 if (s->index == seg)
836 break;
840 * 256 is maximum there, note it may happen
841 * that align is issued on "absolute" segment
842 * it's fine since SEG_ABS > 256 and we never
843 * get escape this test
845 if (!s || !is_power2(value) || value > 256)
846 return;
848 if ((unsigned int)s->align < value)
849 s->align = value;
853 * Return segment data
855 static int32_t ieee_segbase(int32_t segment)
857 struct ieeeSection *seg;
860 * Find the segment in our list.
862 for (seg = seghead; seg; seg = seg->next)
863 if (seg->index == segment - 1)
864 break;
866 if (!seg)
867 return segment; /* not one of ours - leave it alone */
869 if (seg->align >= SEG_ABS)
870 return seg->align; /* absolute segment */
872 return segment; /* no special treatment */
875 static void ieee_write_file(void)
877 const struct tm * const thetime = &official_compile_time.local;
878 struct FileName *fn;
879 struct ieeeSection *seg;
880 struct ieeePublic *pub, *loc;
881 struct ieeeExternal *ext;
882 struct ieeeObjData *data;
883 struct ieeeFixupp *fix;
884 struct Array *arr;
885 int i;
886 const bool debuginfo = (dfmt == &ladsoft_debug_form);
889 * Write the module header
891 ieee_putascii("MBFNASM,%02X%s.\n", strlen(ieee_infile), ieee_infile);
894 * Write the NASM boast comment.
896 ieee_putascii("CO0,%02X%s.\n", nasm_comment_len(), nasm_comment());
899 * write processor-specific information
901 ieee_putascii("AD8,4,L.\n");
904 * date and time
906 ieee_putascii("DT%04d%02d%02d%02d%02d%02d.\n",
907 1900 + thetime->tm_year, thetime->tm_mon + 1,
908 thetime->tm_mday, thetime->tm_hour, thetime->tm_min,
909 thetime->tm_sec);
911 * if debugging, dump file names
913 for (fn = fnhead; fn && debuginfo; fn = fn->next) {
914 ieee_putascii("C0105,%02X%s.\n", strlen(fn->name), fn->name);
917 ieee_putascii("CO101,07ENDHEAD.\n");
919 * the standard doesn't specify when to put checksums,
920 * we'll just do it periodically.
922 ieee_putcs(false);
925 * Write the section headers
927 seg = seghead;
928 if (!debuginfo && !strcmp(seg->name, "??LINE"))
929 seg = seg->next;
930 while (seg) {
931 char buf[256];
932 char attrib;
933 switch (seg->combine) {
934 case CMB_PUBLIC:
935 default:
936 attrib = 'C';
937 break;
938 case CMB_PRIVATE:
939 attrib = 'S';
940 break;
941 case CMB_COMMON:
942 attrib = 'M';
943 break;
945 ieee_unqualified_name(buf, seg->name);
946 if (seg->align >= SEG_ABS) {
947 ieee_putascii("ST%X,A,%02X%s.\n", seg->ieee_index,
948 strlen(buf), buf);
949 ieee_putascii("ASL%X,%lX.\n", seg->ieee_index,
950 (seg->align - SEG_ABS) * 16);
951 } else {
952 ieee_putascii("ST%X,%c,%02X%s.\n", seg->ieee_index, attrib,
953 strlen(buf), buf);
954 ieee_putascii("SA%X,%lX.\n", seg->ieee_index, seg->align);
955 ieee_putascii("ASS%X,%X.\n", seg->ieee_index,
956 seg->currentpos);
958 seg = seg->next;
961 * write the start address if there is one
963 if (ieee_entry_seg) {
964 for (seg = seghead; seg; seg = seg->next)
965 if (seg->index == ieee_entry_seg)
966 break;
967 if (!seg)
968 nasm_panic("Start address records are incorrect");
969 else
970 ieee_putascii("ASG,R%X,%lX,+.\n", seg->ieee_index,
971 ieee_entry_ofs);
974 ieee_putcs(false);
976 * Write the publics
978 i = 1;
979 for (seg = seghead; seg; seg = seg->next) {
980 for (pub = seg->pubhead; pub; pub = pub->next) {
981 char buf[256];
982 ieee_unqualified_name(buf, pub->name);
983 ieee_putascii("NI%X,%02X%s.\n", i, strlen(buf), buf);
984 if (pub->segment == -1)
985 ieee_putascii("ASI%X,R%X,%lX,+.\n", i, pub->index,
986 pub->offset);
987 else
988 ieee_putascii("ASI%X,%lX,%lX,+.\n", i, pub->segment * 16,
989 pub->offset);
990 if (debuginfo) {
991 if (pub->type >= 0x100)
992 ieee_putascii("ATI%X,T%X.\n", i, pub->type - 0x100);
993 else
994 ieee_putascii("ATI%X,%X.\n", i, pub->type);
996 i++;
999 pub = fpubhead;
1000 i = 1;
1001 while (pub) {
1002 char buf[256];
1003 ieee_unqualified_name(buf, pub->name);
1004 ieee_putascii("NI%X,%02X%s.\n", i, strlen(buf), buf);
1005 if (pub->segment == -1)
1006 ieee_putascii("ASI%X,R%X,%lX,+.\n", i, pub->index,
1007 pub->offset);
1008 else
1009 ieee_putascii("ASI%X,%lX,%lX,+.\n", i, pub->segment * 16,
1010 pub->offset);
1011 if (debuginfo) {
1012 if (pub->type >= 0x100)
1013 ieee_putascii("ATI%X,T%X.\n", i, pub->type - 0x100);
1014 else
1015 ieee_putascii("ATI%X,%X.\n", i, pub->type);
1017 i++;
1018 pub = pub->next;
1021 * Write the externals
1023 ext = exthead;
1024 i = 1;
1025 while (ext) {
1026 char buf[256];
1027 ieee_unqualified_name(buf, ext->name);
1028 ieee_putascii("NX%X,%02X%s.\n", i++, strlen(buf), buf);
1029 ext = ext->next;
1031 ieee_putcs(false);
1034 * IEEE doesn't have a standard pass break record
1035 * so use the ladsoft variant
1037 ieee_putascii("CO100,06ENDSYM.\n");
1040 * now put types
1042 i = ARRAY_BOT;
1043 for (arr = arrhead; arr && debuginfo; arr = arr->next) {
1044 ieee_putascii("TY%X,20,%X,%lX.\n", i++, arr->basetype,
1045 arr->size);
1048 * now put locals
1050 i = 1;
1051 for (seg = seghead; seg && debuginfo; seg = seg->next) {
1052 for (loc = seg->lochead; loc; loc = loc->next) {
1053 char buf[256];
1054 ieee_unqualified_name(buf, loc->name);
1055 ieee_putascii("NN%X,%02X%s.\n", i, strlen(buf), buf);
1056 if (loc->segment == -1)
1057 ieee_putascii("ASN%X,R%X,%lX,+.\n", i, loc->index,
1058 loc->offset);
1059 else
1060 ieee_putascii("ASN%X,%lX,%lX,+.\n", i, loc->segment * 16,
1061 loc->offset);
1062 if (debuginfo) {
1063 if (loc->type >= 0x100)
1064 ieee_putascii("ATN%X,T%X.\n", i, loc->type - 0x100);
1065 else
1066 ieee_putascii("ATN%X,%X.\n", i, loc->type);
1068 i++;
1073 * put out section data;
1075 seg = seghead;
1076 if (!debuginfo && !strcmp(seg->name, "??LINE"))
1077 seg = seg->next;
1078 while (seg) {
1079 if (seg->currentpos) {
1080 int32_t size, org = 0;
1081 data = seg->data;
1082 ieee_putascii("SB%X.\n", seg->ieee_index);
1083 fix = seg->fptr;
1084 while (fix) {
1085 size = HUNKSIZE - (org % HUNKSIZE);
1086 size =
1087 size + org >
1088 seg->currentpos ? seg->currentpos - org : size;
1089 size = fix->offset - org > size ? size : fix->offset - org;
1090 org = ieee_putld(org, org + size, data->data);
1091 if (org % HUNKSIZE == 0)
1092 data = data->next;
1093 if (org == fix->offset) {
1094 org += ieee_putlr(fix);
1095 fix = fix->next;
1098 while (org < seg->currentpos && data) {
1099 size =
1100 seg->currentpos - org >
1101 HUNKSIZE ? HUNKSIZE : seg->currentpos - org;
1102 org = ieee_putld(org, org + size, data->data);
1103 data = data->next;
1105 ieee_putcs(false);
1108 seg = seg->next;
1111 * module end record
1113 ieee_putascii("ME.\n");
1116 static void ieee_write_byte(struct ieeeSection *seg, int data)
1118 int temp;
1119 if (!(temp = seg->currentpos++ % HUNKSIZE))
1120 ieee_data_new(seg);
1121 seg->datacurr->data[temp] = data;
1124 static void ieee_write_word(struct ieeeSection *seg, int data)
1126 ieee_write_byte(seg, data & 0xFF);
1127 ieee_write_byte(seg, (data >> 8) & 0xFF);
1130 static void ieee_write_dword(struct ieeeSection *seg, int32_t data)
1132 ieee_write_byte(seg, data & 0xFF);
1133 ieee_write_byte(seg, (data >> 8) & 0xFF);
1134 ieee_write_byte(seg, (data >> 16) & 0xFF);
1135 ieee_write_byte(seg, (data >> 24) & 0xFF);
1137 static void ieee_putascii(char *format, ...)
1139 char buffer[256];
1140 int i, l;
1141 va_list ap;
1143 va_start(ap, format);
1144 vsnprintf(buffer, sizeof(buffer), format, ap);
1145 l = strlen(buffer);
1146 for (i = 0; i < l; i++)
1147 if ((uint8_t)buffer[i] > 31)
1148 checksum += buffer[i];
1149 va_end(ap);
1150 fputs(buffer, ofile);
1154 * put out a checksum record */
1155 static void ieee_putcs(int toclear)
1157 if (toclear) {
1158 ieee_putascii("CS.\n");
1159 } else {
1160 checksum += 'C';
1161 checksum += 'S';
1162 ieee_putascii("CS%02X.\n", checksum & 127);
1164 checksum = 0;
1167 static int32_t ieee_putld(int32_t start, int32_t end, uint8_t *buf)
1169 int32_t val;
1170 if (start == end)
1171 return (start);
1172 val = start % HUNKSIZE;
1173 /* fill up multiple lines */
1174 while (end - start >= LDPERLINE) {
1175 int i;
1176 ieee_putascii("LD");
1177 for (i = 0; i < LDPERLINE; i++) {
1178 ieee_putascii("%02X", buf[val++]);
1179 start++;
1181 ieee_putascii(".\n");
1183 /* if no partial lines */
1184 if (start == end)
1185 return (start);
1186 /* make a partial line */
1187 ieee_putascii("LD");
1188 while (start < end) {
1189 ieee_putascii("%02X", buf[val++]);
1190 start++;
1192 ieee_putascii(".\n");
1193 return (start);
1195 static int32_t ieee_putlr(struct ieeeFixupp *p)
1198 * To deal with the vagaries of segmentation the LADsoft linker
1199 * defines two types of segments: absolute and virtual. Note that
1200 * 'absolute' in this context is a different thing from the IEEE
1201 * definition of an absolute segment type, which is also supported. If a
1202 * sement is linked in virtual mode the low limit (L-var) is
1203 * subtracted from each R,X, and P variable which appears in an
1204 * expression, so that we can have relative offsets. Meanwhile
1205 * in the ABSOLUTE mode this subtraction is not done and
1206 * so we can use absolute offsets from 0. In the LADsoft linker
1207 * this configuration is not done in the assemblker source but in
1208 * a source the linker reads. Generally this type of thing only
1209 * becomes an issue if real mode code is used. A pure 32-bit linker could
1210 * get away without defining the virtual mode...
1212 char buf[40];
1213 int32_t size = p->size;
1214 switch (p->ftype) {
1215 case FT_SEG:
1216 if (p->id1 < 0)
1217 sprintf(buf, "%"PRIX32"", -p->id1);
1218 else
1219 sprintf(buf, "L%"PRIX32",10,/", p->id1);
1220 break;
1221 case FT_OFS:
1222 sprintf(buf, "R%"PRIX32",%"PRIX32",+", p->id1, p->addend);
1223 break;
1224 case FT_REL:
1225 sprintf(buf, "R%"PRIX32",%"PRIX32",+,P,-,%X,-", p->id1, p->addend, p->size);
1226 break;
1228 case FT_WRT:
1229 if (p->id2 < 0)
1230 sprintf(buf, "R%"PRIX32",%"PRIX32",+,L%"PRIX32",+,%"PRIX32",-", p->id2, p->addend,
1231 p->id2, -p->id1 * 16);
1232 else
1233 sprintf(buf, "R%"PRIX32",%"PRIX32",+,L%"PRIX32",+,L%"PRIX32",-", p->id2, p->addend,
1234 p->id2, p->id1);
1235 break;
1236 case FT_EXT:
1237 sprintf(buf, "X%"PRIX32"", p->id1);
1238 break;
1239 case FT_EXTREL:
1240 sprintf(buf, "X%"PRIX32",P,-,%"PRIX32",-", p->id1, size);
1241 break;
1242 case FT_EXTSEG:
1243 /* We needed a non-ieee hack here.
1244 * We introduce the Y variable, which is the low
1245 * limit of the native segment the extern resides in
1247 sprintf(buf, "Y%"PRIX32",10,/", p->id1);
1248 break;
1249 case FT_EXTWRT:
1250 if (p->id2 < 0)
1251 sprintf(buf, "X%"PRIX32",Y%"PRIX32",+,%"PRIX32",-", p->id2, p->id2,
1252 -p->id1 * 16);
1253 else
1254 sprintf(buf, "X%"PRIX32",Y%"PRIX32",+,L%"PRIX32",-", p->id2, p->id2, p->id1);
1255 break;
1257 ieee_putascii("LR(%s,%"PRIX32").\n", buf, size);
1259 return (size);
1262 /* Dump all segment data (text and fixups )*/
1264 static void ieee_unqualified_name(char *dest, char *source)
1266 if (ieee_uppercase) {
1267 while (*source)
1268 *dest++ = toupper(*source++);
1269 *dest = 0;
1270 } else
1271 strcpy(dest, source);
1273 static void dbgls_init(void)
1275 int tempint;
1277 fnhead = NULL;
1278 fntail = &fnhead;
1279 arrindex = ARRAY_BOT;
1280 arrhead = NULL;
1281 arrtail = &arrhead;
1282 ieee_segment("??LINE", 2, &tempint);
1283 any_segs = false;
1285 static void dbgls_cleanup(void)
1287 struct ieeeSection *segtmp;
1288 while (fnhead) {
1289 struct FileName *fntemp = fnhead;
1290 fnhead = fnhead->next;
1291 nasm_free(fntemp->name);
1292 nasm_free(fntemp);
1294 for (segtmp = seghead; segtmp; segtmp = segtmp->next) {
1295 while (segtmp->lochead) {
1296 struct ieeePublic *loctmp = segtmp->lochead;
1297 segtmp->lochead = loctmp->next;
1298 nasm_free(loctmp->name);
1299 nasm_free(loctmp);
1302 while (arrhead) {
1303 struct Array *arrtmp = arrhead;
1304 arrhead = arrhead->next;
1305 nasm_free(arrtmp);
1310 * because this routine is not bracketed in
1311 * the main program, this routine will be called even if there
1312 * is no request for debug info
1313 * so, we have to make sure the ??LINE segment is avaialbe
1314 * as the first segment when this debug format is selected
1316 static void dbgls_linnum(const char *lnfname, int32_t lineno, int32_t segto)
1318 struct FileName *fn;
1319 struct ieeeSection *seg;
1320 int i = 0;
1321 if (segto == NO_SEG)
1322 return;
1325 * If `any_segs' is still false, we must define a default
1326 * segment.
1328 if (!any_segs) {
1329 int tempint; /* ignored */
1330 if (segto != ieee_segment("__NASMDEFSEG", 2, &tempint))
1331 nasm_panic("strange segment conditions in OBJ driver");
1335 * Find the segment we are targetting.
1337 for (seg = seghead; seg; seg = seg->next)
1338 if (seg->index == segto)
1339 break;
1340 if (!seg)
1341 nasm_panic("lineno directed to nonexistent segment?");
1343 for (fn = fnhead; fn; fn = fn->next) {
1344 if (!nasm_stricmp(lnfname, fn->name))
1345 break;
1346 i++;
1348 if (!fn) {
1349 fn = nasm_malloc(sizeof(*fn));
1350 fn->name = nasm_malloc(strlen(lnfname) + 1);
1351 fn->index = i;
1352 strcpy(fn->name, lnfname);
1353 fn->next = NULL;
1354 *fntail = fn;
1355 fntail = &fn->next;
1357 ieee_write_byte(seghead, fn->index);
1358 ieee_write_word(seghead, lineno);
1359 ieee_write_fixup(segto, NO_SEG, seghead, 4, OUT_ADDRESS,
1360 seg->currentpos);
1363 static void dbgls_deflabel(char *name, int32_t segment,
1364 int64_t offset, int is_global, char *special)
1366 struct ieeeSection *seg;
1368 /* Keep compiler from warning about special */
1369 (void)special;
1372 * Note: ..[^@] special symbols are filtered in labels.c
1376 * If it's a special-retry from pass two, discard it.
1378 if (is_global == 3)
1379 return;
1382 * Case (i):
1384 if (ieee_seg_needs_update)
1385 return;
1386 if (segment < SEG_ABS && segment != NO_SEG && segment % 2)
1387 return;
1389 if (segment >= SEG_ABS || segment == NO_SEG) {
1390 return;
1394 * If `any_segs' is still false, we might need to define a
1395 * default segment, if they're trying to declare a label in
1396 * `first_seg'. But the label should exist due to a prior
1397 * call to ieee_deflabel so we can skip that.
1400 for (seg = seghead; seg; seg = seg->next)
1401 if (seg->index == segment) {
1402 struct ieeePublic *loc;
1404 * Case (ii). Maybe MODPUB someday?
1406 if (!is_global) {
1407 last_defined = loc = nasm_malloc(sizeof(*loc));
1408 *seg->loctail = loc;
1409 seg->loctail = &loc->next;
1410 loc->next = NULL;
1411 loc->name = nasm_strdup(name);
1412 loc->offset = offset;
1413 loc->segment = -1;
1414 loc->index = seg->ieee_index;
1418 static void dbgls_typevalue(int32_t type)
1420 int elem = TYM_ELEMENTS(type);
1421 type = TYM_TYPE(type);
1423 if (!last_defined)
1424 return;
1426 switch (type) {
1427 case TY_BYTE:
1428 last_defined->type = 1; /* uint8_t */
1429 break;
1430 case TY_WORD:
1431 last_defined->type = 3; /* unsigned word */
1432 break;
1433 case TY_DWORD:
1434 last_defined->type = 5; /* unsigned dword */
1435 break;
1436 case TY_FLOAT:
1437 last_defined->type = 9; /* float */
1438 break;
1439 case TY_QWORD:
1440 last_defined->type = 10; /* qword */
1441 break;
1442 case TY_TBYTE:
1443 last_defined->type = 11; /* TBYTE */
1444 break;
1445 default:
1446 last_defined->type = 0x10; /* near label */
1447 break;
1450 if (elem > 1) {
1451 struct Array *arrtmp = nasm_malloc(sizeof(*arrtmp));
1452 int vtype = last_defined->type;
1453 arrtmp->size = elem;
1454 arrtmp->basetype = vtype;
1455 arrtmp->next = NULL;
1456 last_defined->type = arrindex++ + 0x100;
1457 *arrtail = arrtmp;
1458 arrtail = &(arrtmp->next);
1460 last_defined = NULL;
1462 static void dbgls_output(int output_type, void *param)
1464 (void)output_type;
1465 (void)param;
1467 static const struct dfmt ladsoft_debug_form = {
1468 "LADsoft Debug Records",
1469 "ladsoft",
1470 dbgls_init,
1471 dbgls_linnum,
1472 dbgls_deflabel,
1473 null_debug_directive,
1474 dbgls_typevalue,
1475 dbgls_output,
1476 dbgls_cleanup,
1477 NULL /* pragma list */
1479 static const struct dfmt * const ladsoft_debug_arr[3] = {
1480 &ladsoft_debug_form,
1481 &null_debug_form,
1482 NULL
1484 const struct ofmt of_ieee = {
1485 "IEEE-695 (LADsoft variant) object file format",
1486 "ieee",
1487 ".o",
1488 OFMT_TEXT,
1490 ladsoft_debug_arr,
1491 &ladsoft_debug_form,
1492 NULL,
1493 ieee_init,
1494 null_reset,
1495 nasm_do_legacy_output,
1496 ieee_out,
1497 ieee_deflabel,
1498 ieee_segment,
1499 NULL,
1500 ieee_sectalign,
1501 ieee_segbase,
1502 ieee_directive,
1503 ieee_cleanup,
1504 NULL /* pragma list */
1507 #endif /* OF_IEEE */