1 /*****************************************************************************/
5 /* Debug symbol handling for the ld65 linker */
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 /*****************************************************************************/
55 /*****************************************************************************/
57 /*****************************************************************************/
61 /* We will collect all debug symbols in the following array and remove
62 * duplicates before outputing them.
64 static DbgSym* DbgSymPool[256];
68 /*****************************************************************************/
70 /*****************************************************************************/
74 static DbgSym* NewDbgSym (unsigned char Type, unsigned char AddrSize, ObjData* O)
75 /* Create a new DbgSym and return it */
78 DbgSym* D = xmalloc (sizeof (DbgSym));
80 /* Initialize the fields */
87 D->AddrSize = AddrSize;
89 /* Return the new entry */
95 static DbgSym* GetDbgSym (DbgSym* D, long Val)
96 /* Check if we find the same debug symbol in the table. If we find it, return
97 * a pointer to the other occurrence, if we didn't find it, return NULL.
100 /* Create the hash. We hash over the symbol value */
101 unsigned Hash = ((Val >> 24) & 0xFF) ^
102 ((Val >> 16) & 0xFF) ^
103 ((Val >> 8) & 0xFF) ^
106 /* Check for this symbol */
107 DbgSym* Sym = DbgSymPool[Hash];
109 /* Is this symbol identical? */
110 if (Sym->Name == D->Name && EqualExpr (Sym->Expr, D->Expr)) {
119 /* This is the first symbol of it's kind */
125 static void InsertDbgSym (DbgSym* D, long Val)
126 /* Insert the symbol into the hashed symbol pool */
128 /* Create the hash. We hash over the symbol value */
129 unsigned Hash = ((Val >> 24) & 0xFF) ^
130 ((Val >> 16) & 0xFF) ^
131 ((Val >> 8) & 0xFF) ^
134 /* Insert the symbol */
135 D->Next = DbgSymPool [Hash];
136 DbgSymPool [Hash] = D;
141 DbgSym* ReadDbgSym (FILE* F, ObjData* O)
142 /* Read a debug symbol from a file, insert and return it */
144 /* Read the type and address size */
145 unsigned char Type = Read8 (F);
146 unsigned char AddrSize = Read8 (F);
148 /* Create a new debug symbol */
149 DbgSym* D = NewDbgSym (Type, AddrSize, O);
151 /* Read and assign the name */
152 D->Name = MakeGlobalStringId (O, ReadVar (F));
155 if (IS_EXP_EXPR (D->Type)) {
156 D->Expr = ReadExpr (F, O);
158 D->Expr = LiteralExpr (Read32 (F), O);
161 /* Last is the file position where the definition was done */
162 ReadFilePos (F, &D->Pos);
164 /* Return the new DbgSym */
170 void ClearDbgSymTable (void)
171 /* Clear the debug symbol table */
174 for (I = 0; I < sizeof (DbgSymPool) / sizeof (DbgSymPool[0]); ++I) {
175 DbgSym* Sym = DbgSymPool[I];
178 DbgSym* NextSym = Sym->Next;
187 long GetDbgSymVal (DbgSym* D)
188 /* Get the value of this symbol */
190 CHECK (D->Expr != 0);
191 return GetExprVal (D->Expr);
196 void PrintDbgSyms (ObjData* O, FILE* F)
197 /* Print the debug symbols in a debug file */
201 /* Walk through all debug symbols in this module */
202 for (I = 0; I < O->DbgSymCount; ++I) {
206 /* Get the next debug symbol */
207 DbgSym* D = O->DbgSyms [I];
209 /* Get the symbol value */
210 Val = GetDbgSymVal (D);
212 /* Lookup this symbol in the table. If it is found in the table, it was
213 * already written to the file, so don't emit it twice. If it is not in
214 * the table, insert and output it.
216 if (GetDbgSym (D, Val) == 0) {
218 /* Emit the debug file line */
220 "sym\t\"%s\",value=0x%08lX,addrsize=%s,type=%s\n",
223 AddrSizeToStr (D->AddrSize),
224 IS_EXP_LABEL (D->Type)? "label" : "equate");
226 /* Insert the symbol into the table */
227 InsertDbgSym (D, Val);
234 void PrintDbgSymLabels (ObjData* O, FILE* F)
235 /* Print the debug symbols in a VICE label file */
239 /* Walk through all debug symbols in this module */
240 for (I = 0; I < O->DbgSymCount; ++I) {
244 /* Get the next debug symbol */
245 DbgSym* D = O->DbgSyms [I];
247 /* Emit this symbol only if it is a label (ignore equates) */
248 if (IS_EXP_EQUATE (D->Type)) {
252 /* Get the symbol value */
253 Val = GetDbgSymVal (D);
255 /* Lookup this symbol in the table. If it is found in the table, it was
256 * already written to the file, so don't emit it twice. If it is not in
257 * the table, insert and output it.
259 if (GetDbgSym (D, Val) == 0) {
261 /* Emit the VICE label line */
262 fprintf (F, "al %06lX .%s\n", Val, GetString (D->Name));
264 /* Insert the symbol into the table */
265 InsertDbgSym (D, Val);