1 /*****************************************************************************/
5 /* Module to handle the o65 binary format */
9 /* (C) 1999-2010, Ullrich von Bassewitz */
10 /* Roemerstrasse 52 */
11 /* D-70794 Filderstadt */
12 /* EMail: uz@cc65.org */
15 /* This software is provided 'as-is', without any expressed or implied */
16 /* warranty. In no event will the authors be held liable for any damages */
17 /* arising from the use of this software. */
19 /* Permission is granted to anyone to use this software for any purpose, */
20 /* including commercial applications, and to alter it and redistribute it */
21 /* freely, subject to the following restrictions: */
23 /* 1. The origin of this software must not be misrepresented; you must not */
24 /* claim that you wrote the original software. If you use this software */
25 /* in a product, an acknowledgment in the product documentation would be */
26 /* appreciated but is not required. */
27 /* 2. Altered source versions must be plainly marked as such, and must not */
28 /* be misrepresented as being the original software. */
29 /* 3. This notice may not be removed or altered from any source */
32 /*****************************************************************************/
62 /*****************************************************************************/
64 /*****************************************************************************/
68 /* Header mode bits */
69 #define MF_CPU_65816 0x8000 /* Executable is for 65816 */
70 #define MF_CPU_6502 0x0000 /* Executable is for the 6502 */
71 #define MF_CPU_MASK 0x8000 /* Mask to extract CPU type */
73 #define MF_RELOC_PAGE 0x4000 /* Page wise relocation */
74 #define MF_RELOC_BYTE 0x0000 /* Byte wise relocation */
75 #define MF_RELOC_MASK 0x4000 /* Mask to extract relocation type */
77 #define MF_SIZE_32BIT 0x2000 /* All size words are 32bit */
78 #define MF_SIZE_16BIT 0x0000 /* All size words are 16bit */
79 #define MF_SIZE_MASK 0x2000 /* Mask to extract size */
81 #define MF_FTYPE_OBJ 0x1000 /* Object file */
82 #define MF_FTYPE_EXE 0x0000 /* Executable file */
83 #define MF_FTYPE_MASK 0x1000 /* Mask to extract type */
85 #define MF_ADDR_SIMPLE 0x0800 /* Simple addressing */
86 #define MF_ADDR_DEFAULT 0x0000 /* Default addressing */
87 #define MF_ADDR_MASK 0x0800 /* Mask to extract addressing */
89 #define MF_ALIGN_1 0x0000 /* Bytewise alignment */
90 #define MF_ALIGN_2 0x0001 /* Align words */
91 #define MF_ALIGN_4 0x0002 /* Align longwords */
92 #define MF_ALIGN_256 0x0003 /* Align pages (256 bytes) */
93 #define MF_ALIGN_MASK 0x0003 /* Mask to extract alignment */
95 /* The four o65 segment types. Note: These values are identical to the values
96 * needed for the segmentID in the o65 spec.
98 #define O65SEG_UNDEF 0x00
99 #define O65SEG_ABS 0x01
100 #define O65SEG_TEXT 0x02
101 #define O65SEG_DATA 0x03
102 #define O65SEG_BSS 0x04
103 #define O65SEG_ZP 0x05
105 /* Relocation type codes for the o65 format */
106 #define O65RELOC_WORD 0x80
107 #define O65RELOC_HIGH 0x40
108 #define O65RELOC_LOW 0x20
109 #define O65RELOC_SEGADR 0xC0
110 #define O65RELOC_SEG 0xA0
111 #define O65RELOC_MASK 0xE0
113 /* O65 executable file header */
114 typedef struct O65Header O65Header;
116 unsigned Version; /* Version number for o65 format */
117 unsigned Mode; /* Mode word */
118 unsigned long TextBase; /* Base address of text segment */
119 unsigned long TextSize; /* Size of text segment */
120 unsigned long DataBase; /* Base of data segment */
121 unsigned long DataSize; /* Size of data segment */
122 unsigned long BssBase; /* Base of bss segment */
123 unsigned long BssSize; /* Size of bss segment */
124 unsigned long ZPBase; /* Base of zeropage segment */
125 unsigned long ZPSize; /* Size of zeropage segment */
126 unsigned long StackSize; /* Requested stack size */
130 typedef struct O65Option O65Option;
132 O65Option* Next; /* Next in option list */
133 unsigned char Type; /* Type of option */
134 unsigned char Len; /* Data length */
135 unsigned char Data [1]; /* Data, dynamically allocated */
138 /* A o65 relocation table */
139 typedef struct O65RelocTab O65RelocTab;
141 unsigned Size; /* Size of the table */
142 unsigned Fill; /* Amount used */
143 unsigned char* Buf; /* Buffer, dynamically allocated */
146 /* Structure describing the format */
148 O65Header Header; /* File header */
149 O65Option* Options; /* List of file options */
150 ExtSymTab* Exports; /* Table with exported symbols */
151 ExtSymTab* Imports; /* Table with imported symbols */
152 unsigned Undef; /* Count of undefined symbols */
153 FILE* F; /* The file we're writing to */
154 const char* Filename; /* Name of the output file */
155 O65RelocTab* TextReloc; /* Relocation table for text segment */
156 O65RelocTab* DataReloc; /* Relocation table for data segment */
158 unsigned TextCount; /* Number of segments assigned to .text */
159 SegDesc** TextSeg; /* Array of text segments */
160 unsigned DataCount; /* Number of segments assigned to .data */
161 SegDesc** DataSeg; /* Array of data segments */
162 unsigned BssCount; /* Number of segments assigned to .bss */
163 SegDesc** BssSeg; /* Array of bss segments */
164 unsigned ZPCount; /* Number of segments assigned to .zp */
165 SegDesc** ZPSeg; /* Array of zp segments */
167 /* Temporary data for writing segments */
168 unsigned long SegSize;
169 O65RelocTab* CurReloc;
173 /* Structure for parsing expression trees */
174 typedef struct ExprDesc ExprDesc;
176 O65Desc* D; /* File format descriptor */
177 long Val; /* The offset value */
178 int TooComplex; /* Expression too complex */
179 MemoryArea* MemRef; /* Memory reference if any */
180 Segment* SegRef; /* Segment reference if any */
181 Section* SecRef; /* Section reference if any */
182 ExtSym* ExtRef; /* External reference if any */
187 /*****************************************************************************/
188 /* Helper functions */
189 /*****************************************************************************/
193 static ExprDesc* InitExprDesc (ExprDesc* ED, O65Desc* D)
194 /* Initialize an ExprDesc structure for use with O65ParseExpr */
208 static void WriteSize (const O65Desc* D, unsigned long Val)
209 /* Write a "size" word to the file */
211 switch (D->Header.Mode & MF_SIZE_MASK) {
212 case MF_SIZE_16BIT: Write16 (D->F, (unsigned) Val); break;
213 case MF_SIZE_32BIT: Write32 (D->F, Val); break;
214 default: Internal ("Invalid size in header: %04X", D->Header.Mode);
220 static unsigned O65SegType (const SegDesc* S)
221 /* Map our own segment types into something o65 compatible */
223 /* Check the segment type. Readonly segments are assign to the o65
224 * text segment, writeable segments that contain data are assigned
225 * to data, bss and zp segments are handled respectively.
226 * Beware: Zeropage segments have the SF_BSS flag set, so be sure
227 * to check SF_ZP first.
229 if (S->Flags & SF_RO) {
231 } else if (S->Flags & SF_ZP) {
233 } else if (S->Flags & SF_BSS) {
242 static void CvtMemoryToSegment (ExprDesc* ED)
243 /* Convert a memory area into a segment by searching the list of run segments
244 * in this memory area and assigning the nearest one.
247 /* Get the memory area from the expression */
248 MemoryArea* M = ED->MemRef;
250 /* Remember the "nearest" segment and its offset */
251 Segment* Nearest = 0;
252 unsigned long Offs = ULONG_MAX;
254 /* Walk over all segments */
256 for (I = 0; I < CollCount (&M->SegList); ++I) {
258 /* Get the segment and check if it's a run segment */
259 SegDesc* S = CollAtUnchecked (&M->SegList, I);
264 /* Get the segment from the segment descriptor */
265 Segment* Seg = S->Seg;
268 if ((long) Seg->PC <= ED->Val && (O = (ED->Val - Seg->PC)) < Offs) {
269 /* This is the nearest segment for now */
273 /* If we found an exact match, don't look further */
281 /* If we found a segment, use it and adjust the offset */
283 ED->SegRef = Nearest;
285 ED->Val -= Nearest->PC;
291 static const SegDesc* FindSeg (SegDesc** const List, unsigned Count, const Segment* S)
292 /* Search for a segment in the given list of segment descriptors and return
293 * the descriptor for a segment if we found it, and NULL if not.
298 for (I = 0; I < Count; ++I) {
299 if (List[I]->Seg == S) {
311 static const SegDesc* O65FindSeg (const O65Desc* D, const Segment* S)
312 /* Search for a segment in the segment lists and return it's segment descriptor */
316 if ((SD = FindSeg (D->TextSeg, D->TextCount, S)) != 0) {
319 if ((SD = FindSeg (D->DataSeg, D->DataCount, S)) != 0) {
322 if ((SD = FindSeg (D->BssSeg, D->BssCount, S)) != 0) {
325 if ((SD = FindSeg (D->ZPSeg, D->ZPCount, S)) != 0) {
335 /*****************************************************************************/
336 /* Expression handling */
337 /*****************************************************************************/
341 static void O65ParseExpr (ExprNode* Expr, ExprDesc* D, int Sign)
342 /* Extract and evaluate all constant factors in an subtree that has only
343 * additions and subtractions. If anything other than additions and
344 * subtractions are found, D->TooComplex is set to true.
352 D->Val += (Sign * Expr->V.IVal);
356 /* Get the referenced Export */
357 E = GetExprExport (Expr);
358 /* If this export has a mark set, we've already encountered it.
359 * This means that the export is used to define it's own value,
360 * which in turn means, that we have a circular reference.
362 if (ExportHasMark (E)) {
363 CircularRefError (E);
364 } else if (E->Expr == 0) {
365 /* Dummy export, must be an o65 imported symbol */
366 ExtSym* S = O65GetImport (D->D, E->Name);
369 /* We cannot have more than one external reference in o65 */
372 /* Remember the external reference */
377 O65ParseExpr (E->Expr, D, Sign);
384 /* We cannot handle more than one segment reference in o65 */
387 /* Remember the segment reference */
388 D->SecRef = GetExprSection (Expr);
389 /* Add the offset of the section to the constant value */
390 D->Val += Sign * (D->SecRef->Offs + D->SecRef->Seg->PC);
396 /* We cannot handle more than one segment reference in o65 */
399 /* Remember the segment reference */
400 D->SegRef = Expr->V.Seg;
401 /* Add the offset of the segment to the constant value */
402 D->Val += (Sign * D->SegRef->PC);
408 /* We cannot handle more than one memory reference in o65 */
411 /* Remember the memory area reference */
412 D->MemRef = Expr->V.Mem;
413 /* Add the start address of the memory area to the constant
416 D->Val += (Sign * D->MemRef->Start);
421 O65ParseExpr (Expr->Left, D, Sign);
422 O65ParseExpr (Expr->Right, D, Sign);
426 O65ParseExpr (Expr->Left, D, Sign);
427 O65ParseExpr (Expr->Right, D, -Sign);
431 /* Expression contains illegal operators */
440 /*****************************************************************************/
441 /* Relocation tables */
442 /*****************************************************************************/
446 static O65RelocTab* NewO65RelocTab (void)
447 /* Create a new relocation table */
449 /* Allocate a new structure */
450 O65RelocTab* R = xmalloc (sizeof (O65RelocTab));
452 /* Initialize the data */
457 /* Return the created struct */
463 static void FreeO65RelocTab (O65RelocTab* R)
464 /* Free a relocation table */
472 static void O65RelocPutByte (O65RelocTab* R, unsigned B)
473 /* Put the byte into the relocation table */
475 /* Do we have enough space in the buffer? */
476 if (R->Fill == R->Size) {
477 /* We need to grow the buffer */
481 R->Size = 1024; /* Initial size */
483 R->Buf = xrealloc (R->Buf, R->Size);
486 /* Put the byte into the buffer */
487 R->Buf [R->Fill++] = (unsigned char) B;
492 static void O65RelocPutWord (O65RelocTab* R, unsigned W)
493 /* Put a word into the relocation table */
495 O65RelocPutByte (R, W);
496 O65RelocPutByte (R, W >> 8);
501 static void O65WriteReloc (O65RelocTab* R, FILE* F)
502 /* Write the relocation table to the given file */
504 WriteData (F, R->Buf, R->Fill);
509 /*****************************************************************************/
510 /* Option handling */
511 /*****************************************************************************/
515 static O65Option* NewO65Option (unsigned Type, const void* Data, unsigned DataLen)
516 /* Allocate and initialize a new option struct */
520 /* Check the length */
521 CHECK (DataLen <= 253);
523 /* Allocate memory */
524 O = xmalloc (sizeof (O65Option) - 1 + DataLen);
526 /* Initialize the structure */
530 memcpy (O->Data, Data, DataLen);
532 /* Return the created struct */
538 static void FreeO65Option (O65Option* O)
539 /* Free an O65Option struct */
546 /*****************************************************************************/
547 /* Subroutines to write o65 sections */
548 /*****************************************************************************/
552 static void O65WriteHeader (O65Desc* D)
553 /* Write the header of the executable to the given file */
555 static unsigned char Trailer [5] = {
556 0x01, 0x00, 0x6F, 0x36, 0x35
561 /* Write the fixed header */
562 WriteData (D->F, Trailer, sizeof (Trailer));
563 Write8 (D->F, D->Header.Version);
564 Write16 (D->F, D->Header.Mode);
565 WriteSize (D, D->Header.TextBase);
566 WriteSize (D, D->Header.TextSize);
567 WriteSize (D, D->Header.DataBase);
568 WriteSize (D, D->Header.DataSize);
569 WriteSize (D, D->Header.BssBase);
570 WriteSize (D, D->Header.BssSize);
571 WriteSize (D, D->Header.ZPBase);
572 WriteSize (D, D->Header.ZPSize);
573 WriteSize (D, D->Header.StackSize);
575 /* Write the options */
578 Write8 (D->F, O->Len + 2); /* Account for len and type bytes */
579 Write8 (D->F, O->Type);
581 WriteData (D->F, O->Data, O->Len);
586 /* Write the end-of-options byte */
592 static unsigned O65WriteExpr (ExprNode* E, int Signed, unsigned Size,
593 unsigned long Offs, void* Data)
594 /* Called from SegWrite for an expression. Evaluate the expression, check the
595 * range and write the expression value to the file, update the relocation
604 unsigned char RelocType;
606 /* Cast the Data pointer to its real type, an O65Desc */
607 O65Desc* D = (O65Desc*) Data;
609 /* Check for a constant expression */
610 if (IsConstExpr (E)) {
611 /* Write out the constant expression */
612 return SegWriteConstExpr (((O65Desc*)Data)->F, E, Signed, Size);
615 /* We have a relocatable expression that needs a relocation table entry.
616 * Calculate the number of bytes between this entry and the last one, and
617 * setup all necessary intermediate bytes in the relocation table.
619 Offs += D->SegSize; /* Calulate full offset */
620 Diff = ((long) Offs) - D->LastOffs;
621 while (Diff > 0xFE) {
622 O65RelocPutByte (D->CurReloc, 0xFF);
625 O65RelocPutByte (D->CurReloc, (unsigned char) Diff);
627 /* Remember this offset for the next time */
630 /* Determine the expression to relocate */
632 if (E->Op == EXPR_BYTE0 || E->Op == EXPR_BYTE1 ||
633 E->Op == EXPR_BYTE2 || E->Op == EXPR_BYTE3 ||
634 E->Op == EXPR_WORD0 || E->Op == EXPR_WORD1) {
635 /* Use the real expression */
639 /* Recursively collect information about this expression */
640 O65ParseExpr (Expr, InitExprDesc (&ED, D), 1);
642 /* We cannot handle more than one external reference */
643 RefCount = (ED.MemRef != 0) + (ED.SegRef != 0) +
644 (ED.SecRef != 0) + (ED.ExtRef != 0);
649 /* If we have a memory area reference, we need to convert it into a
650 * segment reference. If we cannot do that, we cannot handle the
654 CvtMemoryToSegment (&ED);
655 if (ED.SegRef == 0) {
656 return SEG_EXPR_TOO_COMPLEX;
660 /* Bail out if we cannot handle the expression */
662 return SEG_EXPR_TOO_COMPLEX;
665 /* Safety: Check that we have exactly one reference */
666 CHECK (RefCount == 1);
668 /* Write out the offset that goes into the segment. */
671 case EXPR_BYTE0: BinVal &= 0xFF; break;
672 case EXPR_BYTE1: BinVal = (BinVal >> 8) & 0xFF; break;
673 case EXPR_BYTE2: BinVal = (BinVal >> 16) & 0xFF; break;
674 case EXPR_BYTE3: BinVal = (BinVal >> 24) & 0xFF; break;
675 case EXPR_WORD0: BinVal &= 0xFFFF; break;
676 case EXPR_WORD1: BinVal = (BinVal >> 16) & 0xFFFF; break;
678 WriteVal (D->F, BinVal, Size);
680 /* Determine the actual type of relocation entry needed from the
681 * information gathered about the expression.
683 if (E->Op == EXPR_BYTE0) {
684 RelocType = O65RELOC_LOW;
685 } else if (E->Op == EXPR_BYTE1) {
686 RelocType = O65RELOC_HIGH;
687 } else if (E->Op == EXPR_BYTE2) {
688 RelocType = O65RELOC_SEG;
693 RelocType = O65RELOC_LOW;
697 RelocType = O65RELOC_WORD;
701 RelocType = O65RELOC_SEGADR;
705 /* 4 byte expression not supported by o65 */
706 return SEG_EXPR_TOO_COMPLEX;
709 Internal ("O65WriteExpr: Invalid expression size: %u", Size);
710 RelocType = 0; /* Avoid gcc warnings */
714 /* Determine which segment we're referencing */
715 if (ED.SegRef || ED.SecRef) {
719 /* Segment or section reference. */
721 /* Get segment from section */
722 ED.SegRef = ED.SecRef->Seg;
725 /* Search for the segment and map it to it's o65 segmentID */
726 Seg = O65FindSeg (D, ED.SegRef);
728 /* For some reason, we didn't find this segment in the list of
729 * segments written to the o65 file.
731 return SEG_EXPR_INVALID;
733 RelocType |= O65SegType (Seg);
734 O65RelocPutByte (D->CurReloc, RelocType);
736 /* Output additional data if needed */
737 switch (RelocType & O65RELOC_MASK) {
739 O65RelocPutByte (D->CurReloc, ED.Val & 0xFF);
742 O65RelocPutWord (D->CurReloc, ED.Val & 0xFFFF);
746 } else if (ED.ExtRef) {
747 /* Imported symbol */
748 RelocType |= O65SEG_UNDEF;
749 O65RelocPutByte (D->CurReloc, RelocType);
750 /* Put the number of the imported symbol into the table */
751 O65RelocPutWord (D->CurReloc, ExtSymNum (ED.ExtRef));
755 /* OOPS - something bad happened */
756 Internal ("External reference not handled");
766 static void O65WriteSeg (O65Desc* D, SegDesc** Seg, unsigned Count, int DoWrite)
767 /* Write one segment to the o65 output file */
772 /* Initialize variables */
776 /* Write out all segments */
777 for (I = 0; I < Count; ++I) {
779 /* Get the segment from the list node */
782 /* Relocate line info for this segment */
783 RelocLineInfo (S->Seg);
785 /* Keep the user happy */
786 Print (stdout, 1, " Writing `%s'\n", GetString (S->Name));
788 /* Write this segment */
790 SegWrite (D->Filename, D->F, S->Seg, O65WriteExpr, D);
793 /* Mark the segment as dumped */
796 /* Calculate the total size */
797 D->SegSize += S->Seg->Size;
800 /* Terminate the relocation table for this segment */
802 O65RelocPutByte (D->CurReloc, 0);
805 /* Check the size of the segment for overflow */
806 if ((D->Header.Mode & MF_SIZE_MASK) == MF_SIZE_16BIT && D->SegSize > 0xFFFF) {
807 Error ("Segment overflow in file `%s'", D->Filename);
814 static void O65WriteTextSeg (O65Desc* D)
815 /* Write the code segment to the o65 output file */
817 /* Initialize variables */
818 D->CurReloc = D->TextReloc;
820 /* Dump all text segments */
821 O65WriteSeg (D, D->TextSeg, D->TextCount, 1);
823 /* Set the size of the segment */
824 D->Header.TextSize = D->SegSize;
829 static void O65WriteDataSeg (O65Desc* D)
830 /* Write the data segment to the o65 output file */
832 /* Initialize variables */
833 D->CurReloc = D->DataReloc;
835 /* Dump all data segments */
836 O65WriteSeg (D, D->DataSeg, D->DataCount, 1);
838 /* Set the size of the segment */
839 D->Header.DataSize = D->SegSize;
844 static void O65WriteBssSeg (O65Desc* D)
845 /* "Write" the bss segments to the o65 output file. This will only update
846 * the relevant header fields.
849 /* Initialize variables */
852 /* Dump all data segments */
853 O65WriteSeg (D, D->BssSeg, D->BssCount, 0);
855 /* Set the size of the segment */
856 D->Header.BssSize = D->SegSize;
861 static void O65WriteZPSeg (O65Desc* D)
862 /* "Write" the zeropage segments to the o65 output file. This will only update
863 * the relevant header fields.
866 /* Initialize variables */
869 /* Dump all data segments */
870 O65WriteSeg (D, D->ZPSeg, D->ZPCount, 0);
872 /* Set the size of the segment */
873 D->Header.ZPSize = D->SegSize;
878 static void O65WriteImports (O65Desc* D)
879 /* Write the list of imported symbols to the O65 file */
883 /* Write the number of imports */
884 WriteSize (D, ExtSymCount (D->Imports));
886 /* Write out the symbol names, zero terminated */
887 S = ExtSymList (D->Imports);
890 const char* Name = GetString (ExtSymName (S));
891 /* And write it to the output file */
892 WriteData (D->F, Name, strlen (Name) + 1);
900 static void O65WriteTextReloc (O65Desc* D)
901 /* Write the relocation for the text segment to the output file */
903 O65WriteReloc (D->TextReloc, D->F);
908 static void O65WriteDataReloc (O65Desc* D)
909 /* Write the relocation for the data segment to the output file */
911 O65WriteReloc (D->DataReloc, D->F);
916 static void O65WriteExports (O65Desc* D)
917 /* Write the list of exports */
921 /* Write the number of exports */
922 WriteSize (D, ExtSymCount (D->Exports));
924 /* Write out the symbol information */
925 S = ExtSymList (D->Exports);
929 unsigned char SegmentID;
933 unsigned NameIdx = ExtSymName (S);
934 const char* Name = GetString (NameIdx);
936 /* Get the export for this symbol. We've checked before that this
937 * export does really exist, so if it is unresolved, or if we don't
938 * find it, there is an error in the linker code.
940 Export* E = FindExport (NameIdx);
941 if (E == 0 || IsUnresolvedExport (E)) {
942 Internal ("Unresolved export `%s' found in O65WriteExports", Name);
945 /* Get the expression for the symbol */
948 /* Recursively collect information about this expression */
949 O65ParseExpr (Expr, InitExprDesc (&ED, D), 1);
951 /* We cannot handle expressions with imported symbols, or expressions
952 * with more than one segment reference here
954 if (ED.ExtRef != 0 || (ED.SegRef != 0 && ED.SecRef != 0)) {
958 /* Bail out if we cannot handle the expression */
960 Error ("Expression for symbol `%s' is too complex", Name);
963 /* Determine the segment id for the expression */
964 if (ED.SegRef != 0 || ED.SecRef != 0) {
968 /* Segment or section reference */
969 if (ED.SecRef != 0) {
970 ED.SegRef = ED.SecRef->Seg; /* Get segment from section */
973 /* Search for the segment and map it to it's o65 segmentID */
974 Seg = O65FindSeg (D, ED.SegRef);
976 /* For some reason, we didn't find this segment in the list of
977 * segments written to the o65 file.
979 Error ("Segment for symbol `%s' is undefined", Name);
981 SegmentID = O65SegType (Seg);
986 SegmentID = O65SEG_ABS;
990 /* Write the name to the output file */
991 WriteData (D->F, Name, strlen (Name) + 1);
993 /* Output the segment id followed by the literal value */
994 Write8 (D->F, SegmentID);
995 WriteSize (D, ED.Val);
1004 /*****************************************************************************/
1006 /*****************************************************************************/
1010 O65Desc* NewO65Desc (void)
1011 /* Create, initialize and return a new O65 descriptor struct */
1013 /* Allocate a new structure */
1014 O65Desc* D = xmalloc (sizeof (O65Desc));
1016 /* Initialize the header */
1017 D->Header.Version = 0;
1019 D->Header.TextBase = 0;
1020 D->Header.TextSize = 0;
1021 D->Header.DataBase = 0;
1022 D->Header.DataSize = 0;
1023 D->Header.BssBase = 0;
1024 D->Header.BssSize = 0;
1025 D->Header.ZPBase = 0;
1026 D->Header.ZPSize = 0;
1027 D->Header.StackSize = 0; /* Let OS choose a good value */
1029 /* Initialize other data */
1031 D->Exports = NewExtSymTab ();
1032 D->Imports = NewExtSymTab ();
1036 D->TextReloc = NewO65RelocTab ();
1037 D->DataReloc = NewO65RelocTab ();
1047 /* Return the created struct */
1053 void FreeO65Desc (O65Desc* D)
1054 /* Delete the descriptor struct with cleanup */
1056 /* Free the segment arrays */
1062 /* Free the relocation tables */
1063 FreeO65RelocTab (D->DataReloc);
1064 FreeO65RelocTab (D->TextReloc);
1066 /* Free the option list */
1067 while (D->Options) {
1068 O65Option* O = D->Options;
1069 D->Options = D->Options->Next;
1073 /* Free the external symbol tables */
1074 FreeExtSymTab (D->Exports);
1075 FreeExtSymTab (D->Imports);
1077 /* Free the struct itself */
1083 void O65Set6502 (O65Desc* D)
1084 /* Enable 6502 mode */
1086 D->Header.Mode = (D->Header.Mode & ~MF_CPU_MASK) | MF_CPU_6502;
1091 void O65Set65816 (O65Desc* D)
1092 /* Enable 816 mode */
1094 D->Header.Mode = (D->Header.Mode & ~MF_CPU_MASK) | MF_CPU_65816;
1099 void O65SetSmallModel (O65Desc* D)
1100 /* Enable a small memory model executable */
1102 D->Header.Mode = (D->Header.Mode & ~MF_SIZE_MASK) | MF_SIZE_16BIT;
1107 void O65SetLargeModel (O65Desc* D)
1108 /* Enable a large memory model executable */
1110 D->Header.Mode = (D->Header.Mode & ~MF_SIZE_MASK) | MF_SIZE_32BIT;
1115 void O65SetAlignment (O65Desc* D, unsigned Align)
1116 /* Set the executable alignment */
1118 /* Remove all alignment bits from the mode word */
1119 D->Header.Mode &= ~MF_ALIGN_MASK;
1121 /* Set the alignment bits */
1123 case 1: D->Header.Mode |= MF_ALIGN_1; break;
1124 case 2: D->Header.Mode |= MF_ALIGN_2; break;
1125 case 4: D->Header.Mode |= MF_ALIGN_4; break;
1126 case 256: D->Header.Mode |= MF_ALIGN_256; break;
1127 default: Error ("Invalid alignment for O65 format: %u", Align);
1133 void O65SetOption (O65Desc* D, unsigned Type, const void* Data, unsigned DataLen)
1134 /* Set an o65 header option */
1136 /* Create a new option structure */
1137 O65Option* O = NewO65Option (Type, Data, DataLen);
1139 /* Insert it into the linked list */
1140 O->Next = D->Options;
1146 void O65SetOS (O65Desc* D, unsigned OS, unsigned Version, unsigned Id)
1147 /* Set an option describing the target operating system */
1149 /* Setup the option data */
1150 unsigned char Opt[4];
1154 /* Write the correct option length */
1158 /* Set the 16 bit id */
1159 Opt[2] = (unsigned char) Id;
1160 Opt[3] = (unsigned char) (Id >> 8);
1161 O65SetOption (D, O65OPT_OS, Opt, 4);
1165 /* No id for OS/A65, Lunix, and unknown OSes */
1166 O65SetOption (D, O65OPT_OS, Opt, 2);
1174 ExtSym* O65GetImport (O65Desc* D, unsigned Ident)
1175 /* Return the imported symbol or NULL if not found */
1177 /* Retrieve the symbol from the table */
1178 return GetExtSym (D->Imports, Ident);
1183 void O65SetImport (O65Desc* D, unsigned Ident)
1184 /* Set an imported identifier */
1186 /* Insert the entry into the table */
1187 NewExtSym (D->Imports, Ident);
1192 ExtSym* O65GetExport (O65Desc* D, unsigned Ident)
1193 /* Return the exported symbol or NULL if not found */
1195 /* Retrieve the symbol from the table */
1196 return GetExtSym (D->Exports, Ident);
1201 void O65SetExport (O65Desc* D, unsigned Ident)
1202 /* Set an exported identifier */
1204 /* Get the export for this symbol and check if it does exist and is
1205 * a resolved symbol.
1207 Export* E = FindExport (Ident);
1208 if (E == 0 || IsUnresolvedExport (E)) {
1209 Error ("Unresolved export: `%s'", GetString (Ident));
1212 /* Insert the entry into the table */
1213 NewExtSym (D->Exports, Ident);
1218 static void O65SetupSegments (O65Desc* D, File* F)
1219 /* Setup segment assignments */
1222 unsigned TextIdx, DataIdx, BssIdx, ZPIdx;
1224 /* Initialize the counters */
1230 /* Walk over the memory list */
1231 for (I = 0; I < CollCount (&F->MemoryAreas); ++I) {
1232 /* Get this entry */
1233 MemoryArea* M = CollAtUnchecked (&F->MemoryAreas, I);
1235 /* Walk through the segment list and count the segment types */
1237 for (J = 0; J < CollCount (&M->SegList); ++J) {
1239 /* Get the segment */
1240 SegDesc* S = CollAtUnchecked (&M->SegList, J);
1242 /* Check the segment type. */
1243 switch (O65SegType (S)) {
1244 case O65SEG_TEXT: D->TextCount++; break;
1245 case O65SEG_DATA: D->DataCount++; break;
1246 case O65SEG_BSS: D->BssCount++; break;
1247 case O65SEG_ZP: D->ZPCount++; break;
1248 default: Internal ("Invalid return from O65SegType");
1253 /* Allocate memory according to the numbers */
1254 D->TextSeg = xmalloc (D->TextCount * sizeof (SegDesc*));
1255 D->DataSeg = xmalloc (D->DataCount * sizeof (SegDesc*));
1256 D->BssSeg = xmalloc (D->BssCount * sizeof (SegDesc*));
1257 D->ZPSeg = xmalloc (D->ZPCount * sizeof (SegDesc*));
1259 /* Walk again through the list and setup the segment arrays */
1260 TextIdx = DataIdx = BssIdx = ZPIdx = 0;
1261 for (I = 0; I < CollCount (&F->MemoryAreas); ++I) {
1262 /* Get this entry */
1263 MemoryArea* M = CollAtUnchecked (&F->MemoryAreas, I);
1265 /* Walk over the segment list and check the segment types */
1267 for (J = 0; J < CollCount (&M->SegList); ++J) {
1269 /* Get the segment */
1270 SegDesc* S = CollAtUnchecked (&M->SegList, J);
1272 /* Check the segment type. */
1273 switch (O65SegType (S)) {
1274 case O65SEG_TEXT: D->TextSeg [TextIdx++] = S; break;
1275 case O65SEG_DATA: D->DataSeg [DataIdx++] = S; break;
1276 case O65SEG_BSS: D->BssSeg [BssIdx++] = S; break;
1277 case O65SEG_ZP: D->ZPSeg [ZPIdx++] = S; break;
1278 default: Internal ("Invalid return from O65SegType");
1286 static int O65Unresolved (unsigned Name, void* D)
1287 /* Called if an unresolved symbol is encountered */
1289 /* Check if the symbol is an imported o65 symbol */
1290 if (O65GetImport (D, Name) != 0) {
1291 /* This is an external symbol, relax... */
1294 /* This is actually an unresolved external. Bump the counter */
1295 ((O65Desc*) D)->Undef++;
1302 static void O65SetupHeader (O65Desc* D)
1303 /* Set additional stuff in the header */
1305 /* Set the base addresses of the segments */
1306 if (D->TextCount > 0) {
1307 SegDesc* FirstSeg = D->TextSeg [0];
1308 D->Header.TextBase = FirstSeg->Seg->PC;
1310 if (D->DataCount > 0) {
1311 SegDesc* FirstSeg = D->DataSeg [0];
1312 D->Header.DataBase = FirstSeg->Seg->PC;
1314 if (D->BssCount > 0) {
1315 SegDesc* FirstSeg = D->BssSeg [0];
1316 D->Header.BssBase = FirstSeg->Seg->PC;
1318 if (D->ZPCount > 0) {
1319 SegDesc* FirstSeg = D->ZPSeg [0];
1320 D->Header.ZPBase = FirstSeg->Seg->PC;
1323 /* If we have byte wise relocation and an alignment of 1, we can set
1324 * the "simple addressing" bit in the header.
1326 if ((D->Header.Mode & MF_RELOC_MASK) == MF_RELOC_BYTE &&
1327 (D->Header.Mode & MF_ALIGN_MASK) == MF_ALIGN_1) {
1328 D->Header.Mode = (D->Header.Mode & ~MF_ADDR_MASK) | MF_ADDR_SIMPLE;
1334 void O65WriteTarget (O65Desc* D, File* F)
1335 /* Write an o65 output file */
1337 char OptBuf [256]; /* Buffer for option strings */
1341 /* Place the filename in the control structure */
1342 D->Filename = GetString (F->Name);
1344 /* Check for unresolved symbols. The function O65Unresolved is called
1345 * if we get an unresolved symbol.
1347 D->Undef = 0; /* Reset the counter */
1348 CheckUnresolvedImports (O65Unresolved, D);
1350 /* We had unresolved symbols, cannot create output file */
1351 Error ("%u unresolved external(s) found - cannot create output file", D->Undef);
1354 /* Setup the segment arrays */
1355 O65SetupSegments (D, F);
1357 /* Setup additional stuff in the header */
1361 D->F = fopen (D->Filename, "wb");
1363 Error ("Cannot open `%s': %s", D->Filename, strerror (errno));
1366 /* Keep the user happy */
1367 Print (stdout, 1, "Opened `%s'...\n", D->Filename);
1369 /* Define some more options: A timestamp and the linker version */
1371 strcpy (OptBuf, ctime (&T));
1372 OptLen = strlen (OptBuf);
1373 while (OptLen > 0 && IsControl (OptBuf[OptLen-1])) {
1376 OptBuf[OptLen] = '\0';
1377 O65SetOption (D, O65OPT_TIMESTAMP, OptBuf, OptLen + 1);
1378 sprintf (OptBuf, "ld65 V%s", GetVersionAsString ());
1379 O65SetOption (D, O65OPT_ASM, OptBuf, strlen (OptBuf) + 1);
1381 /* Write the header */
1384 /* Write the text segment */
1385 O65WriteTextSeg (D);
1387 /* Write the data segment */
1388 O65WriteDataSeg (D);
1390 /* "Write" the bss segments */
1393 /* "Write" the zeropage segments */
1396 /* Write the undefined references list */
1397 O65WriteImports (D);
1399 /* Write the text segment relocation table */
1400 O65WriteTextReloc (D);
1402 /* Write the data segment relocation table */
1403 O65WriteDataReloc (D);
1405 /* Write the list of exports */
1406 O65WriteExports (D);
1408 /* Seek back to the start and write the updated header */
1409 fseek (D->F, 0, SEEK_SET);
1412 /* Close the file */
1413 if (fclose (D->F) != 0) {
1414 Error ("Cannot write to `%s': %s", D->Filename, strerror (errno));
1417 /* Reset the file and filename */