1 /*****************************************************************************/
5 /* Object file writing routines for the ca65 macroassembler */
9 /* (C) 1998-2003 Ullrich von Bassewitz */
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 /*****************************************************************************/
52 /*****************************************************************************/
54 /*****************************************************************************/
61 /* Default extension */
64 /* Header structure */
65 static ObjHeader Header = {
66 OBJ_MAGIC, /* 32: Magic number */
67 OBJ_VERSION, /* 16: Version number */
69 0, /* 32: Offset to option table */
70 0, /* 32: Size of options */
71 0, /* 32: Offset to file table */
72 0, /* 32: Size of files */
73 0, /* 32: Offset to segment table */
74 0, /* 32: Size of segment table */
75 0, /* 32: Offset to import list */
76 0, /* 32: Size of import list */
77 0, /* 32: Offset to export list */
78 0, /* 32: Size of export list */
79 0, /* 32: Offset to list of debug symbols */
80 0, /* 32: Size of debug symbols */
81 0, /* 32: Offset to list of line infos */
82 0, /* 32: Size of line infos */
83 0, /* 32: Offset to string pool */
84 0, /* 32: Size of string pool */
85 0, /* 32: Offset to assertion table */
86 0, /* 32: Size of assertion table */
87 0, /* 32: Offset into scope table */
88 0, /* 32: Size of scope table */
93 /*****************************************************************************/
94 /* Internally used functions */
95 /*****************************************************************************/
99 static void ObjWriteError (void)
100 /* Called on a write error. Will try to close and remove the file, then
101 * print a fatal error.
104 /* Remember the error */
107 /* Force a close of the file, ignoring errors */
110 /* Try to remove the file, also ignoring errors */
113 /* Now abort with a fatal error */
114 Fatal ("Cannot write to output file `%s': %s", OutFile, strerror (Error));
119 static void ObjWriteHeader (void)
120 /* Write the object file header to the current file position */
122 ObjWrite32 (Header.Magic);
123 ObjWrite16 (Header.Version);
124 ObjWrite16 (Header.Flags);
125 ObjWrite32 (Header.OptionOffs);
126 ObjWrite32 (Header.OptionSize);
127 ObjWrite32 (Header.FileOffs);
128 ObjWrite32 (Header.FileSize);
129 ObjWrite32 (Header.SegOffs);
130 ObjWrite32 (Header.SegSize);
131 ObjWrite32 (Header.ImportOffs);
132 ObjWrite32 (Header.ImportSize);
133 ObjWrite32 (Header.ExportOffs);
134 ObjWrite32 (Header.ExportSize);
135 ObjWrite32 (Header.DbgSymOffs);
136 ObjWrite32 (Header.DbgSymSize);
137 ObjWrite32 (Header.LineInfoOffs);
138 ObjWrite32 (Header.LineInfoSize);
139 ObjWrite32 (Header.StrPoolOffs);
140 ObjWrite32 (Header.StrPoolSize);
141 ObjWrite32 (Header.AssertOffs);
142 ObjWrite32 (Header.AssertSize);
143 ObjWrite32 (Header.ScopeOffs);
144 ObjWrite32 (Header.ScopeSize);
149 /*****************************************************************************/
151 /*****************************************************************************/
156 /* Open the object file for writing, write a dummy header */
158 /* Do we have a name for the output file? */
160 /* We don't have an output name explicitly given, construct one from
161 * the name of the input file.
163 OutFile = MakeFilename (InFile, OBJ_EXT);
166 /* Create the output file */
167 F = fopen (OutFile, "w+b");
169 Fatal ("Cannot open output file `%s': %s", OutFile, strerror (errno));
172 /* Write a dummy header */
179 /* Write an update header and close the object file. */
181 /* Go back to the beginning */
182 if (fseek (F, 0, SEEK_SET) != 0) {
186 /* If we have debug infos, set the flag in the header */
188 Header.Flags |= OBJ_FLAGS_DBGINFO;
191 /* Write the updated header */
195 if (fclose (F) != 0) {
202 unsigned long ObjGetFilePos (void)
203 /* Get the current file position */
205 long Pos = ftell (F);
214 void ObjSetFilePos (unsigned long Pos)
215 /* Set the file position */
217 if (fseek (F, Pos, SEEK_SET) != 0) {
224 void ObjWrite8 (unsigned V)
225 /* Write an 8 bit value to the file */
227 if (putc (V, F) == EOF) {
234 void ObjWrite16 (unsigned V)
235 /* Write a 16 bit value to the file */
243 void ObjWrite24 (unsigned long V)
244 /* Write a 24 bit value to the file */
253 void ObjWrite32 (unsigned long V)
254 /* Write a 32 bit value to the file */
264 void ObjWriteVar (unsigned long V)
265 /* Write a variable sized value to the file in special encoding */
267 /* We will write the value to the file in 7 bit chunks. If the 8th bit
268 * is clear, we're done, if it is set, another chunk follows. This will
269 * allow us to encode smaller values with less bytes, at the expense of
270 * needing 5 bytes if a 32 bit value is written to file.
273 unsigned char C = (V & 0x7F);
284 void ObjWriteStr (const char* S)
285 /* Write a string to the object file */
287 unsigned Len = strlen (S);
289 /* Write the string with the length preceeded (this is easier for
290 * the reading routine than the C format since the length is known in
294 ObjWriteData (S, Len);
299 void ObjWriteBuf (const StrBuf* S)
300 /* Write a string to the object file */
302 /* Write the string with the length preceeded (this is easier for
303 * the reading routine than the C format since the length is known in
306 ObjWriteVar (SB_GetLen (S));
307 ObjWriteData (SB_GetConstBuf (S), SB_GetLen (S));
312 void ObjWriteData (const void* Data, unsigned Size)
313 /* Write literal data to the file */
315 if (fwrite (Data, 1, Size, F) != Size) {
322 void ObjWritePos (const FilePos* Pos)
323 /* Write a file position to the object file */
325 /* Write the data entries */
326 ObjWriteVar (Pos->Line);
327 ObjWriteVar (Pos->Col);
328 if (Pos->Name == 0) {
329 /* Position is outside file scope, use the main file instead */
332 ObjWriteVar (Pos->Name - 1);
338 void ObjStartOptions (void)
339 /* Mark the start of the option section */
341 Header.OptionOffs = ftell (F);
346 void ObjEndOptions (void)
347 /* Mark the end of the option section */
349 Header.OptionSize = ftell (F) - Header.OptionOffs;
354 void ObjStartFiles (void)
355 /* Mark the start of the files section */
357 Header.FileOffs = ftell (F);
362 void ObjEndFiles (void)
363 /* Mark the end of the files section */
365 Header.FileSize = ftell (F) - Header.FileOffs;
370 void ObjStartSegments (void)
371 /* Mark the start of the segment section */
373 Header.SegOffs = ftell (F);
378 void ObjEndSegments (void)
379 /* Mark the end of the segment section */
381 Header.SegSize = ftell (F) - Header.SegOffs;
386 void ObjStartImports (void)
387 /* Mark the start of the import section */
389 Header.ImportOffs = ftell (F);
394 void ObjEndImports (void)
395 /* Mark the end of the import section */
397 Header.ImportSize = ftell (F) - Header.ImportOffs;
402 void ObjStartExports (void)
403 /* Mark the start of the export section */
405 Header.ExportOffs = ftell (F);
410 void ObjEndExports (void)
411 /* Mark the end of the export section */
413 Header.ExportSize = ftell (F) - Header.ExportOffs;
418 void ObjStartDbgSyms (void)
419 /* Mark the start of the debug symbol section */
421 Header.DbgSymOffs = ftell (F);
426 void ObjEndDbgSyms (void)
427 /* Mark the end of the debug symbol section */
429 Header.DbgSymSize = ftell (F) - Header.DbgSymOffs;
434 void ObjStartLineInfos (void)
435 /* Mark the start of the line info section */
437 Header.LineInfoOffs = ftell (F);
442 void ObjEndLineInfos (void)
443 /* Mark the end of the line info section */
445 Header.LineInfoSize = ftell (F) - Header.LineInfoOffs;
450 void ObjStartStrPool (void)
451 /* Mark the start of the string pool section */
453 Header.StrPoolOffs = ftell (F);
458 void ObjEndStrPool (void)
459 /* Mark the end of the string pool section */
461 Header.StrPoolSize = ftell (F) - Header.StrPoolOffs;
466 void ObjStartAssertions (void)
467 /* Mark the start of the assertion table */
469 Header.AssertOffs = ftell (F);
474 void ObjEndAssertions (void)
475 /* Mark the end of the assertion table */
477 Header.AssertSize = ftell (F) - Header.AssertOffs;
482 void ObjStartScopes (void)
483 /* Mark the start of the scope table */
485 Header.ScopeOffs = ftell (F);
490 void ObjEndScopes (void)
491 /* Mark the end of the scope table */
493 Header.ScopeSize = ftell (F) - Header.ScopeOffs;