2 * File stabs.c - read stabs information from the modules
4 * Copyright (C) 1996, Eric Youngdale.
5 * 1999-2005, Eric Pouech
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 * Maintenance Information
23 * -----------------------
25 * For documentation on the stabs format see for example
26 * The "stabs" debug format
27 * by Julia Menapace, Jim Kingdon, David Mackenzie
29 * available (hopefully) from http:\\sources.redhat.com\gdb\onlinedocs
33 #include "wine/port.h"
35 #include <sys/types.h>
37 #ifdef HAVE_SYS_STAT_H
38 # include <sys/stat.h>
40 #ifdef HAVE_SYS_MMAN_H
51 #define PATH_MAX MAX_PATH
60 #include "dbghelp_private.h"
62 #include "wine/debug.h"
64 WINE_DEFAULT_DEBUG_CHANNEL(dbghelp_stabs
);
66 #define strtoull _strtoui64
98 struct stab_nlist
* n_next
;
101 unsigned char n_type
;
104 unsigned long n_value
;
107 static void stab_strcpy(char* dest
, int sz
, const char* source
)
111 * A strcpy routine that stops when we hit the ':' character.
112 * Faster than copying the whole thing, and then nuking the
114 * Takes also care of (valid) a::b constructs
116 while (*source
!= '\0')
118 if (source
[0] != ':' && sz
-- > 0) *ptr
++ = *source
++;
119 else if (source
[1] == ':' && (sz
-= 2) > 0)
127 /* GCC emits, in some cases, a .<digit>+ suffix.
128 * This is used for static variable inside functions, so
129 * that we can have several such variables with same name in
130 * the same compilation unit
131 * We simply ignore that suffix when present (we also get rid
132 * of it in ELF symtab parsing)
134 if (ptr
>= dest
&& isdigit(*ptr
))
136 while (ptr
> dest
&& isdigit(*ptr
)) ptr
--;
137 if (*ptr
== '.') *ptr
= '\0';
146 struct symt
** vector
;
150 #define MAX_INCLUDES 5120
152 static include_def
* include_defs
= NULL
;
153 static int num_include_def
= 0;
154 static int num_alloc_include_def
= 0;
155 static int cu_include_stack
[MAX_INCLUDES
];
156 static int cu_include_stk_idx
= 0;
157 static struct symt
** cu_vector
= NULL
;
158 static int cu_nrofentries
= 0;
159 static struct symt_basic
* stabs_basic
[36];
161 static int stabs_new_include(const char* file
, unsigned long val
)
163 if (num_include_def
== num_alloc_include_def
)
165 num_alloc_include_def
+= 256;
167 include_defs
= HeapAlloc(GetProcessHeap(), 0,
168 sizeof(include_defs
[0]) * num_alloc_include_def
);
170 include_defs
= HeapReAlloc(GetProcessHeap(), 0, include_defs
,
171 sizeof(include_defs
[0]) * num_alloc_include_def
);
172 memset(include_defs
+ num_include_def
, 0, sizeof(include_defs
[0]) * 256);
174 include_defs
[num_include_def
].name
= strcpy(HeapAlloc(GetProcessHeap(), 0, strlen(file
) + 1), file
);
175 include_defs
[num_include_def
].value
= val
;
176 include_defs
[num_include_def
].vector
= NULL
;
177 include_defs
[num_include_def
].nrofentries
= 0;
179 return num_include_def
++;
182 static int stabs_find_include(const char* file
, unsigned long val
)
186 for (i
= 0; i
< num_include_def
; i
++)
188 if (val
== include_defs
[i
].value
&&
189 strcmp(file
, include_defs
[i
].name
) == 0)
195 static int stabs_add_include(int idx
)
197 if (idx
< 0) return -1;
198 cu_include_stk_idx
++;
200 /* if this happens, just bump MAX_INCLUDES */
201 /* we could also handle this as another dynarray */
202 assert(cu_include_stk_idx
< MAX_INCLUDES
);
203 cu_include_stack
[cu_include_stk_idx
] = idx
;
204 return cu_include_stk_idx
;
207 static void stabs_reset_includes(void)
210 * The struct symt:s that we would need to use are reset when
211 * we start a new file. (at least the ones in filenr == 0)
213 cu_include_stk_idx
= 0;/* keep 0 as index for the .c file itself */
214 memset(cu_vector
, 0, sizeof(cu_vector
[0]) * cu_nrofentries
);
217 static void stabs_free_includes(void)
221 stabs_reset_includes();
222 for (i
= 0; i
< num_include_def
; i
++)
224 HeapFree(GetProcessHeap(), 0, include_defs
[i
].name
);
225 HeapFree(GetProcessHeap(), 0, include_defs
[i
].vector
);
227 HeapFree(GetProcessHeap(), 0, include_defs
);
230 num_alloc_include_def
= 0;
231 HeapFree(GetProcessHeap(), 0, cu_vector
);
236 static struct symt
** stabs_find_ref(long filenr
, long subnr
)
240 /* FIXME: I could perhaps create a dummy include_def for each compilation
241 * unit which would allow not to handle those two cases separately
245 if (cu_nrofentries
<= subnr
)
248 cu_vector
= HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY
,
249 sizeof(cu_vector
[0]) * (subnr
+1));
251 cu_vector
= HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY
,
252 cu_vector
, sizeof(cu_vector
[0]) * (subnr
+1));
253 cu_nrofentries
= subnr
+ 1;
255 ret
= &cu_vector
[subnr
];
261 assert(filenr
<= cu_include_stk_idx
);
262 idef
= &include_defs
[cu_include_stack
[filenr
]];
264 if (idef
->nrofentries
<= subnr
)
267 idef
->vector
= HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY
,
268 sizeof(idef
->vector
[0]) * (subnr
+1));
270 idef
->vector
= HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY
,
271 idef
->vector
, sizeof(idef
->vector
[0]) * (subnr
+1));
272 idef
->nrofentries
= subnr
+ 1;
274 ret
= &idef
->vector
[subnr
];
276 TRACE("(%ld,%ld) => %p (%p)\n", filenr
, subnr
, ret
, *ret
);
280 static struct symt
** stabs_read_type_enum(const char** x
)
290 filenr
= strtol(iter
, &end
, 10); /* <int> */
291 iter
= ++end
; /* ',' */
292 subnr
= strtol(iter
, &end
, 10); /* <int> */
293 iter
= ++end
; /* ')' */
298 subnr
= strtol(iter
, &end
, 10); /* <int> */
302 return stabs_find_ref(filenr
, subnr
);
306 struct ParseTypedefData
311 struct module
* module
;
323 static void stabs_pts_push(struct ParseTypedefData
* ptd
, unsigned line
)
325 assert(ptd
->err_idx
< sizeof(ptd
->errors
) / sizeof(ptd
->errors
[0]));
326 ptd
->errors
[ptd
->err_idx
].line
= line
;
327 ptd
->errors
[ptd
->err_idx
].ptr
= ptd
->ptr
;
330 #define PTS_ABORTIF(ptd, t) do { if (t) { stabs_pts_push((ptd), __LINE__); return -1;} } while (0)
332 #define PTS_ABORTIF(ptd, t) do { if (t) return -1; } while (0)
335 static int stabs_get_basic(struct ParseTypedefData
* ptd
, unsigned basic
, struct symt
** symt
)
337 PTS_ABORTIF(ptd
, basic
>= sizeof(stabs_basic
) / sizeof(stabs_basic
[0]));
339 if (!stabs_basic
[basic
])
343 case 1: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btInt
, "int", 4); break;
344 case 2: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btChar
, "char", 1); break;
345 case 3: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btInt
, "short int", 2); break;
346 case 4: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btInt
, "long int", 4); break;
347 case 5: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btUInt
, "unsigned char", 1); break;
348 case 6: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btInt
, "signed char", 1); break;
349 case 7: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btUInt
, "unsigned short int", 2); break;
350 case 8: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btUInt
, "unsigned int", 4); break;
351 case 9: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btUInt
, "unsigned", 2); break;
352 case 10: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btUInt
, "unsigned long int", 2); break;
353 case 11: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btVoid
, "void", 0); break;
354 case 12: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btFloat
, "float", 4); break;
355 case 13: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btFloat
, "double", 8); break;
356 case 14: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btFloat
, "long double", 12); break;
357 case 15: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btInt
, "integer", 4); break;
358 case 16: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btBool
, "bool", 1); break;
359 /* case 17: short real */
361 case 25: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btComplex
, "float complex", 8); break;
362 case 26: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btComplex
, "double complex", 16); break;
363 case 30: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btWChar
, "wchar_t", 2); break;
364 case 31: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btInt
, "long long int", 8); break;
365 case 32: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btUInt
, "long long unsigned", 8); break;
366 /* starting at 35 are wine extensions (especially for R implementation) */
367 case 35: stabs_basic
[basic
] = symt_new_basic(ptd
->module
, btComplex
, "long double complex", 24); break;
368 default: PTS_ABORTIF(ptd
, 1);
371 *symt
= &stabs_basic
[basic
]->symt
;
375 static int stabs_pts_read_type_def(struct ParseTypedefData
* ptd
,
376 const char* typename
, struct symt
** dt
);
378 static int stabs_pts_read_id(struct ParseTypedefData
* ptd
)
380 const char* first
= ptd
->ptr
;
381 unsigned int template = 0;
384 while ((ch
= *ptd
->ptr
++) != '\0')
391 unsigned int len
= ptd
->ptr
- first
- 1;
392 PTS_ABORTIF(ptd
, len
>= sizeof(ptd
->buf
) - ptd
->idx
);
393 memcpy(ptd
->buf
+ ptd
->idx
, first
, len
);
394 ptd
->buf
[ptd
->idx
+ len
] = '\0';
399 case '<': template++; break;
400 case '>': PTS_ABORTIF(ptd
, template == 0); template--; break;
406 static int stabs_pts_read_number(struct ParseTypedefData
* ptd
, long* v
)
410 *v
= strtol(ptd
->ptr
, &last
, 10);
411 PTS_ABORTIF(ptd
, last
== ptd
->ptr
);
416 static int stabs_pts_read_type_reference(struct ParseTypedefData
* ptd
,
417 long* filenr
, long* subnr
)
419 if (*ptd
->ptr
== '(')
421 /* '(' <int> ',' <int> ')' */
423 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, filenr
) == -1);
424 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ',');
425 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, subnr
) == -1);
426 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ')');
431 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, subnr
) == -1);
436 struct pts_range_value
442 static int stabs_pts_read_range_value(struct ParseTypedefData
* ptd
, struct pts_range_value
* prv
)
449 while (*ptd
->ptr
== '0') ptd
->ptr
++;
450 if (*ptd
->ptr
>= '1' && *ptd
->ptr
<= '7')
455 PTS_ABORTIF(ptd
, ptd
->ptr
[0] != '1');
458 while (isdigit(*ptd
->ptr
)) prv
->val
= (prv
->val
<< 3) + *ptd
->ptr
++ - '0';
463 while (isdigit(*ptd
->ptr
)) prv
->val
= (prv
->val
<< 3) + *ptd
->ptr
++ - '0';
465 default: PTS_ABORTIF(ptd
, 1); break;
467 } else prv
->sign
= 0;
471 prv
->val
= strtoull(++ptd
->ptr
, &last
, 10);
477 prv
->val
= strtoull(ptd
->ptr
, &last
, 10);
484 static int stabs_pts_read_range(struct ParseTypedefData
* ptd
, const char* typename
,
488 struct pts_range_value lo
;
489 struct pts_range_value hi
;
495 /* type ';' <int> ';' <int> ';' */
496 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &ref
) == -1);
497 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';'); /* ';' */
498 PTS_ABORTIF(ptd
, stabs_pts_read_range_value(ptd
, &lo
) == -1);
499 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';'); /* ';' */
500 PTS_ABORTIF(ptd
, stabs_pts_read_range_value(ptd
, &hi
) == -1);
501 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';'); /* ';' */
503 /* basically, we don't use ref... in some cases, for example, float is declared
504 * as a derived type of int... which won't help us... so we guess the types
505 * from the various formats
507 if (lo
.sign
== 0 && hi
.sign
< 0)
512 else if (lo
.sign
< 0 && hi
.sign
== 0)
517 else if (lo
.sign
> 0 && hi
.sign
== 0)
522 else if (lo
.sign
< 0 && hi
.sign
> 0)
525 for (i
= 7; i
< 64; i
+= 8)
527 if (lo
.val
== v
&& hi
.val
== v
- 1)
535 PTS_ABORTIF(ptd
, i
>= 64);
537 else if (lo
.sign
== 0 && hi
.sign
> 0)
539 if (hi
.val
== 127) /* specific case for char... */
547 for (i
= 8; i
<= 64; i
+= 8)
557 PTS_ABORTIF(ptd
, i
> 64);
560 else PTS_ABORTIF(ptd
, 1);
562 *dt
= &symt_new_basic(ptd
->module
, bt
, typename
, size
)->symt
;
566 static inline int stabs_pts_read_method_info(struct ParseTypedefData
* ptd
)
574 /* get type of return value */
575 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &dt
) == -1);
576 if (*ptd
->ptr
== ';') ptd
->ptr
++;
578 /* get types of parameters */
579 if (*ptd
->ptr
== ':')
581 PTS_ABORTIF(ptd
, !(tmp
= strchr(ptd
->ptr
+ 1, ';')));
584 PTS_ABORTIF(ptd
, !(*ptd
->ptr
>= '0' && *ptd
->ptr
<= '9'));
586 PTS_ABORTIF(ptd
, !(ptd
->ptr
[0] >= 'A' && *ptd
->ptr
<= 'D'));
588 PTS_ABORTIF(ptd
, mthd
!= '.' && mthd
!= '?' && mthd
!= '*');
595 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, &ofs
) == -1);
596 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';');
597 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &dt
) == -1);
598 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';');
600 } while (*ptd
->ptr
!= ';');
606 static inline int stabs_pts_read_aggregate(struct ParseTypedefData
* ptd
,
607 struct symt_udt
* sdt
)
611 struct symt
* dt
= NULL
;
615 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, &sz
) == -1);
617 doadd
= symt_set_udt_size(ptd
->module
, sdt
, sz
);
618 if (*ptd
->ptr
== '!') /* C++ inheritence */
623 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, &num_classes
) == -1);
624 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ',');
625 while (--num_classes
>= 0)
627 ptd
->ptr
+= 2; /* skip visibility and inheritence */
628 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, &ofs
) == -1);
629 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ',');
631 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &adt
) == -1);
639 symt_get_info(adt
, TI_GET_SYMNAME
, &name
);
640 strcpy(tmp
, "__inherited_class_");
641 WideCharToMultiByte(CP_ACP
, 0, name
, -1,
642 tmp
+ strlen(tmp
), sizeof(tmp
) - strlen(tmp
),
644 HeapFree(GetProcessHeap(), 0, name
);
645 /* FIXME: TI_GET_LENGTH will not always work, especially when adt
646 * has just been seen as a forward definition and not the real stuff
648 * As we don't use much the size of members in structs, this may not
649 * be much of a problem
651 symt_get_info(adt
, TI_GET_LENGTH
, &size
);
652 symt_add_udt_element(ptd
->module
, sdt
, tmp
, adt
, ofs
, (DWORD
)size
* 8);
654 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';');
658 /* if the structure has already been filled, just redo the parsing
659 * but don't store results into the struct
660 * FIXME: there's a quite ugly memory leak in there...
663 /* Now parse the individual elements of the structure/union. */
664 while (*ptd
->ptr
!= ';')
666 /* agg_name : type ',' <int:offset> ',' <int:size> */
669 if (ptd
->ptr
[0] == '$' && ptd
->ptr
[1] == 'v')
673 if (ptd
->ptr
[2] == 'f')
675 /* C++ virtual method table */
677 stabs_read_type_enum(&ptd
->ptr
);
678 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ':');
679 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &dt
) == -1);
680 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ',');
681 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, &x
) == -1);
682 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';');
686 else if (ptd
->ptr
[2] == 'b')
689 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &dt
) == -1);
690 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ':');
691 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &dt
) == -1);
692 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ',');
693 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, &x
) == -1);
694 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';');
700 PTS_ABORTIF(ptd
, stabs_pts_read_id(ptd
) == -1);
701 /* Ref. TSDF R2.130 Section 7.4. When the field name is a method name
702 * it is followed by two colons rather than one.
704 if (*ptd
->ptr
== ':')
707 stabs_pts_read_method_info(ptd
);
713 /* skip C++ member protection /0 /1 or /2 */
714 if (*ptd
->ptr
== '/') ptd
->ptr
+= 2;
716 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &adt
) == -1);
721 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, &ofs
) == -1);
722 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ',');
723 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, &sz
) == -1);
724 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';');
726 if (doadd
) symt_add_udt_element(ptd
->module
, sdt
, ptd
->buf
+ idx
, adt
, ofs
, sz
);
731 /* method parameters... terminated by ';' */
732 PTS_ABORTIF(ptd
, !(tmp
= strchr(ptd
->ptr
, ';')));
737 PTS_ABORTIF(ptd
, TRUE
);
741 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';');
742 if (*ptd
->ptr
== '~')
745 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != '%');
746 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &dt
) == -1);
747 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';');
752 static inline int stabs_pts_read_enum(struct ParseTypedefData
* ptd
,
753 struct symt_enum
* edt
)
758 while (*ptd
->ptr
!= ';')
761 PTS_ABORTIF(ptd
, stabs_pts_read_id(ptd
) == -1);
762 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, &value
) == -1);
763 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ',');
764 symt_add_enum_element(ptd
->module
, edt
, ptd
->buf
+ idx
, value
);
771 static inline int stabs_pts_read_array(struct ParseTypedefData
* ptd
,
775 struct symt
* range_dt
;
776 struct symt
* base_dt
;
778 /* ar<typeinfo_nodef>;<int>;<int>;<typeinfo> */
780 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != 'r');
782 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &range_dt
) == -1);
783 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';'); /* ';' */
784 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, &lo
) == -1);
785 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';'); /* ';' */
786 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, &hi
) == -1);
787 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';'); /* ';' */
789 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &base_dt
) == -1);
791 *adt
= &symt_new_array(ptd
->module
, lo
, hi
, base_dt
, range_dt
)->symt
;
795 static int stabs_pts_read_type_def(struct ParseTypedefData
* ptd
, const char* typename
,
796 struct symt
** ret_dt
)
800 struct symt
* new_dt
= NULL
; /* newly created data type */
801 struct symt
* ref_dt
; /* referenced data type (pointer...) */
802 long filenr1
, subnr1
, tmp
;
804 /* things are a bit complicated because of the way the typedefs are stored inside
805 * the file, because addresses can change when realloc is done, so we must call
806 * over and over stabs_find_ref() to keep the correct values around
808 PTS_ABORTIF(ptd
, stabs_pts_read_type_reference(ptd
, &filenr1
, &subnr1
) == -1);
810 while (*ptd
->ptr
== '=')
813 PTS_ABORTIF(ptd
, new_dt
!= NULL
);
815 /* first handle attribute if any */
819 if (*++ptd
->ptr
== 's')
822 if (stabs_pts_read_number(ptd
, &sz
) == -1)
824 ERR("Not an attribute... NIY\n");
828 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';');
832 /* then the real definitions */
837 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &ref_dt
) == -1);
838 new_dt
= &symt_new_pointer(ptd
->module
, ref_dt
)->symt
;
840 case 'k': /* 'const' modifier */
841 case 'B': /* 'volatile' modifier */
842 /* just kinda ignore the modifier, I guess -gmt */
843 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, typename
, &new_dt
) == -1);
847 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, typename
, &new_dt
) == -1);
850 PTS_ABORTIF(ptd
, stabs_pts_read_array(ptd
, &new_dt
) == -1);
853 PTS_ABORTIF(ptd
, stabs_pts_read_range(ptd
, typename
, &new_dt
) == -1);
854 assert(!*stabs_find_ref(filenr1
, subnr1
));
855 *stabs_find_ref(filenr1
, subnr1
) = new_dt
;
858 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &ref_dt
) == -1);
859 new_dt
= &symt_new_function_signature(ptd
->module
, ref_dt
, -1)->symt
;
862 stabs_get_basic(ptd
, 1 /* int */, &ref_dt
);
863 new_dt
= &symt_new_enum(ptd
->module
, typename
, ref_dt
)->symt
;
864 PTS_ABORTIF(ptd
, stabs_pts_read_enum(ptd
, (struct symt_enum
*)new_dt
) == -1);
869 struct symt_udt
* udt
;
870 enum UdtKind kind
= (ptd
->ptr
[-1] == 's') ? UdtStruct
: UdtUnion
;
871 /* udt can have been already defined in a forward definition */
872 udt
= (struct symt_udt
*)*stabs_find_ref(filenr1
, subnr1
);
875 udt
= symt_new_udt(ptd
->module
, typename
, 0, kind
);
876 /* we need to set it here, because a struct can hold a pointer
879 new_dt
= *stabs_find_ref(filenr1
, subnr1
) = &udt
->symt
;
884 if (udt
->symt
.tag
!= SymTagUDT
)
886 ERR("Forward declaration (%p/%s) is not an aggregate (%u)\n",
887 udt
, symt_get_name(&udt
->symt
), udt
->symt
.tag
);
890 /* FIXME: we currently don't correctly construct nested C++
891 * classes names. Therefore, we could be here with either:
892 * - typename and udt->hash_elt.name being the same string
893 * (non embedded case)
894 * - typename being foo::bar while udt->hash_elt.name being
896 * So, we twist the comparison to test both occurrences. When
897 * we have proper C++ types in this file, this twist has to be
900 l1
= strlen(udt
->hash_elt
.name
);
901 l2
= strlen(typename
);
902 if (l1
> l2
|| strcmp(udt
->hash_elt
.name
, typename
+ l2
- l1
))
903 ERR("Forward declaration name mismatch %s <> %s\n",
904 udt
->hash_elt
.name
, typename
);
907 PTS_ABORTIF(ptd
, stabs_pts_read_aggregate(ptd
, udt
) == -1);
913 PTS_ABORTIF(ptd
, stabs_pts_read_id(ptd
) == -1);
917 stabs_get_basic(ptd
, 1 /* int */, &ref_dt
);
918 new_dt
= &symt_new_enum(ptd
->module
, ptd
->buf
+ idx
, ref_dt
)->symt
;
921 new_dt
= &symt_new_udt(ptd
->module
, ptd
->buf
+ idx
, 0, UdtStruct
)->symt
;
924 new_dt
= &symt_new_udt(ptd
->module
, ptd
->buf
+ idx
, 0, UdtUnion
)->symt
;
933 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, &tmp
) == -1);
934 PTS_ABORTIF(ptd
, stabs_get_basic(ptd
, tmp
, &new_dt
) == -1);
935 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';');
939 if (*ptd
->ptr
== '#')
942 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &ref_dt
) == -1);
943 new_dt
= &symt_new_function_signature(ptd
->module
, ref_dt
, -1)->symt
;
950 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &cls_dt
) == -1);
951 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ',');
952 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &ref_dt
) == -1);
953 new_dt
= &symt_new_function_signature(ptd
->module
, ref_dt
, -1)->symt
;
954 while (*ptd
->ptr
== ',')
957 PTS_ABORTIF(ptd
, stabs_pts_read_type_def(ptd
, NULL
, &pmt_dt
) == -1);
966 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, &type
) == -1);
967 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';'); /* ';' */
968 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, &len
) == -1);
969 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';'); /* ';' */
970 PTS_ABORTIF(ptd
, stabs_pts_read_number(ptd
, &unk
) == -1);
971 PTS_ABORTIF(ptd
, *ptd
->ptr
++ != ';'); /* ';' */
973 switch (type
) /* see stabs_get_basic for the details */
975 case 1: basic
= 12; break;
976 case 2: basic
= 13; break;
977 case 3: basic
= 25; break;
978 case 4: basic
= 26; break;
979 case 5: basic
= 35; break;
980 case 6: basic
= 14; break;
981 default: PTS_ABORTIF(ptd
, 1);
983 PTS_ABORTIF(ptd
, stabs_get_basic(ptd
, basic
, &new_dt
) == -1);
987 ERR("Unknown type '%c'\n", ptd
->ptr
[-1]);
994 /* is it a forward declaration that has been filled ? */
995 new_dt
= *stabs_find_ref(filenr1
, subnr1
);
996 /* if not, this should be void (which is defined as a ref to itself, but we
997 * don't correctly catch it)
999 if (!new_dt
&& typename
)
1001 new_dt
= &symt_new_basic(ptd
->module
, btVoid
, typename
, 0)->symt
;
1002 PTS_ABORTIF(ptd
, strcmp(typename
, "void"));
1006 *stabs_find_ref(filenr1
, subnr1
) = *ret_dt
= new_dt
;
1008 TRACE("Adding (%ld,%ld) %s\n", filenr1
, subnr1
, debugstr_a(typename
));
1013 static int stabs_parse_typedef(struct module
* module
, const char* ptr
,
1014 const char* typename
)
1016 struct ParseTypedefData ptd
;
1020 /* check for already existing definition */
1022 TRACE("%s => %s\n", typename
, debugstr_a(ptr
));
1023 ptd
.module
= module
;
1028 for (ptd
.ptr
= ptr
- 1; ;)
1030 ptd
.ptr
= strchr(ptd
.ptr
+ 1, ':');
1031 if (ptd
.ptr
== NULL
|| *++ptd
.ptr
!= ':') break;
1035 if (*ptd
.ptr
!= '(') ptd
.ptr
++;
1036 /* most of type definitions take one char, except Tt */
1037 if (*ptd
.ptr
!= '(') ptd
.ptr
++;
1038 ret
= stabs_pts_read_type_def(&ptd
, typename
, &dt
);
1041 if (ret
== -1 || *ptd
.ptr
)
1045 TRACE("Failure on %s\n", debugstr_a(ptr
));
1048 for (i
= 0; i
< ptd
.err_idx
; i
++)
1050 TRACE("[%d]: line %d => %s\n",
1051 i
, ptd
.errors
[i
].line
, debugstr_a(ptd
.errors
[i
].ptr
));
1055 TRACE("[0]: => %s\n", debugstr_a(ptd
.ptr
));
1058 ERR("Failure on %s at %s\n", debugstr_a(ptr
), debugstr_a(ptd
.ptr
));
1066 static struct symt
* stabs_parse_type(const char* stab
)
1068 const char* c
= stab
- 1;
1071 * Look through the stab definition, and figure out what struct symt
1072 * this represents. If we have something we know about, assign the
1074 * According to "The \"stabs\" debug format" (Rev 2.130) the name may be
1075 * a C++ name and contain double colons e.g. foo::bar::baz:t5=*6.
1079 if ((c
= strchr(c
+ 1, ':')) == NULL
) return NULL
;
1080 } while (*++c
== ':');
1083 * The next characters say more about the type (i.e. data, function, etc)
1084 * of symbol. Skip them. (C++ for example may have Tt).
1085 * Actually this is a very weak description; I think Tt is the only
1086 * multiple combination we should see.
1088 while (*c
&& *c
!= '(' && !isdigit(*c
))
1091 * The next is either an integer or a (integer,integer).
1092 * The stabs_read_type_enum() takes care that stab_types is large enough.
1094 return *stabs_read_type_enum(&c
);
1097 struct pending_loc_var
1102 struct location loc
;
1105 struct pending_block
1107 struct pending_loc_var
* vars
;
1112 static inline void pending_add(struct pending_block
* pending
, const char* name
,
1113 enum DataKind dt
, const struct location
* loc
)
1115 if (pending
->num
== pending
->allocated
)
1117 pending
->allocated
+= 8;
1119 pending
->vars
= HeapAlloc(GetProcessHeap(), 0,
1120 pending
->allocated
* sizeof(pending
->vars
[0]));
1122 pending
->vars
= HeapReAlloc(GetProcessHeap(), 0, pending
->vars
,
1123 pending
->allocated
* sizeof(pending
->vars
[0]));
1125 stab_strcpy(pending
->vars
[pending
->num
].name
,
1126 sizeof(pending
->vars
[pending
->num
].name
), name
);
1127 pending
->vars
[pending
->num
].type
= stabs_parse_type(name
);
1128 pending
->vars
[pending
->num
].kind
= dt
;
1129 pending
->vars
[pending
->num
].loc
= *loc
;
1133 static void pending_flush(struct pending_block
* pending
, struct module
* module
,
1134 struct symt_function
* func
, struct symt_block
* block
)
1138 for (i
= 0; i
< pending
->num
; i
++)
1140 symt_add_func_local(module
, func
,
1141 pending
->vars
[i
].kind
, &pending
->vars
[i
].loc
,
1142 block
, pending
->vars
[i
].type
, pending
->vars
[i
].name
);
1147 /******************************************************************
1148 * stabs_finalize_function
1150 * Ends function creation: mainly:
1151 * - cleans up line number information
1152 * - tries to set up a debug-start tag (FIXME: heuristic to be enhanced)
1153 * - for stabs which have absolute address in them, initializes the size of the
1154 * function (assuming that current function ends where next function starts)
1156 static void stabs_finalize_function(struct module
* module
, struct symt_function
* func
,
1160 struct location loc
;
1163 symt_normalize_function(module
, func
);
1164 /* To define the debug-start of the function, we use the second line number.
1165 * Not 100% bullet proof, but better than nothing
1167 if (symt_fill_func_line_info(module
, func
, func
->address
, &il
) &&
1168 symt_get_func_line_next(module
, &il
))
1170 loc
.kind
= loc_absolute
;
1171 loc
.offset
= il
.Address
- func
->address
;
1172 symt_add_function_point(module
, func
, SymTagFuncDebugStart
,
1175 if (size
) func
->size
= size
;
1178 BOOL
stabs_parse(struct module
* module
, unsigned long load_offset
,
1179 const void* pv_stab_ptr
, int stablen
,
1180 const char* strs
, int strtablen
)
1182 struct symt_function
* curr_func
= NULL
;
1183 struct symt_block
* block
= NULL
;
1184 struct symt_compiland
* compiland
= NULL
;
1185 char srcpath
[PATH_MAX
]; /* path to directory source file is in */
1190 unsigned int stabbufflen
;
1191 const struct stab_nlist
* stab_ptr
= pv_stab_ptr
;
1192 const char* strs_end
;
1197 int source_idx
= -1;
1198 struct pending_block pending
;
1200 struct location loc
;
1202 nstab
= stablen
/ sizeof(struct stab_nlist
);
1203 strs_end
= strs
+ strtablen
;
1205 memset(srcpath
, 0, sizeof(srcpath
));
1206 memset(stabs_basic
, 0, sizeof(stabs_basic
));
1207 memset(&pending
, 0, sizeof(pending
));
1210 * Allocate a buffer into which we can build stab strings for cases
1211 * where the stab is continued over multiple lines.
1213 stabbufflen
= 65536;
1214 stabbuff
= HeapAlloc(GetProcessHeap(), 0, stabbufflen
);
1218 for (i
= 0; i
< nstab
; i
++, stab_ptr
++)
1220 ptr
= strs
+ stab_ptr
->n_un
.n_strx
;
1221 if ((ptr
> strs_end
) || (ptr
+ strlen(ptr
) > strs_end
))
1223 WARN("Bad stabs string %p\n", ptr
);
1226 if (*ptr
!= '\0' && (ptr
[strlen(ptr
) - 1] == '\\'))
1229 * Indicates continuation. Append this to the buffer, and go onto the
1230 * next record. Repeat the process until we find a stab without the
1231 * '/' character, as this indicates we have the whole thing.
1233 unsigned len
= strlen(ptr
);
1234 if (strlen(stabbuff
) + len
> stabbufflen
)
1236 stabbufflen
+= 65536;
1237 stabbuff
= HeapReAlloc(GetProcessHeap(), 0, stabbuff
, stabbufflen
);
1239 strncat(stabbuff
, ptr
, len
- 1);
1242 else if (stabbuff
[0] != '\0')
1244 strcat(stabbuff
, ptr
);
1248 /* only symbol entries contain a typedef */
1249 switch (stab_ptr
->n_type
)
1258 if (strchr(ptr
, '=') != NULL
)
1261 * The stabs aren't in writable memory, so copy it over so we are
1262 * sure we can scribble on it.
1264 if (ptr
!= stabbuff
)
1266 strcpy(stabbuff
, ptr
);
1269 stab_strcpy(symname
, sizeof(symname
), ptr
);
1270 if (!stabs_parse_typedef(module
, ptr
, symname
))
1272 /* skip this definition */
1279 switch (stab_ptr
->n_type
)
1283 * These are useless with ELF. They have no value, and you have to
1284 * read the normal symbol table to get the address. Thus we
1285 * ignore them, and when we process the normal symbol table
1286 * we should do the right thing.
1288 * With a.out or mingw, they actually do make some amount of sense.
1290 stab_strcpy(symname
, sizeof(symname
), ptr
);
1291 symt_new_global_variable(module
, compiland
, symname
, TRUE
/* FIXME */,
1292 load_offset
+ stab_ptr
->n_value
, 0,
1293 stabs_parse_type(ptr
));
1297 /* These are static symbols and BSS symbols. */
1298 stab_strcpy(symname
, sizeof(symname
), ptr
);
1299 symt_new_global_variable(module
, compiland
, symname
, TRUE
/* FIXME */,
1300 load_offset
+ stab_ptr
->n_value
, 0,
1301 stabs_parse_type(ptr
));
1306 block
= symt_open_func_block(module
, curr_func
, block
,
1307 stab_ptr
->n_value
, 0);
1308 pending_flush(&pending
, module
, curr_func
, block
);
1313 block
= symt_close_func_block(module
, curr_func
, block
,
1317 /* These are function parameters. */
1318 if (curr_func
!= NULL
)
1320 struct symt
* param_type
= stabs_parse_type(ptr
);
1321 stab_strcpy(symname
, sizeof(symname
), ptr
);
1322 loc
.kind
= loc_regrel
;
1323 loc
.reg
= 0; /* FIXME */
1324 loc
.offset
= stab_ptr
->n_value
;
1325 symt_add_func_local(module
, curr_func
,
1326 (long)stab_ptr
->n_value
>= 0 ? DataIsParam
: DataIsLocal
,
1327 &loc
, NULL
, param_type
, symname
);
1328 symt_add_function_signature_parameter(module
,
1329 (struct symt_function_signature
*)curr_func
->type
,
1334 /* These are registers (as local variables) */
1335 if (curr_func
!= NULL
)
1337 loc
.kind
= loc_register
;
1340 switch (stab_ptr
->n_value
)
1342 case 0: loc
.reg
= CV_REG_EAX
; break;
1343 case 1: loc
.reg
= CV_REG_ECX
; break;
1344 case 2: loc
.reg
= CV_REG_EDX
; break;
1345 case 3: loc
.reg
= CV_REG_EBX
; break;
1346 case 4: loc
.reg
= CV_REG_ESP
; break;
1347 case 5: loc
.reg
= CV_REG_EBP
; break;
1348 case 6: loc
.reg
= CV_REG_ESI
; break;
1349 case 7: loc
.reg
= CV_REG_EDI
; break;
1358 case 19: loc
.reg
= CV_REG_ST0
+ stab_ptr
->n_value
- 12; break;
1360 FIXME("Unknown register value (%lu)\n", stab_ptr
->n_value
);
1361 loc
.reg
= CV_REG_NONE
;
1364 stab_strcpy(symname
, sizeof(symname
), ptr
);
1365 if (ptr
[strlen(symname
) + 1] == 'P')
1367 struct symt
* param_type
= stabs_parse_type(ptr
);
1368 stab_strcpy(symname
, sizeof(symname
), ptr
);
1369 symt_add_func_local(module
, curr_func
, DataIsParam
, &loc
,
1370 NULL
, param_type
, symname
);
1371 symt_add_function_signature_parameter(module
,
1372 (struct symt_function_signature
*)curr_func
->type
,
1376 pending_add(&pending
, ptr
, DataIsLocal
, &loc
);
1380 /* These are local variables */
1381 loc
.kind
= loc_regrel
;
1382 loc
.reg
= 0; /* FIXME */
1383 loc
.offset
= stab_ptr
->n_value
;
1384 if (curr_func
!= NULL
) pending_add(&pending
, ptr
, DataIsLocal
, &loc
);
1388 * This is a line number. These are always relative to the start
1389 * of the function (N_FUN), and this makes the lookup easier.
1391 if (curr_func
!= NULL
)
1393 assert(source_idx
>= 0);
1394 symt_add_func_line(module
, curr_func
, source_idx
,
1395 stab_ptr
->n_desc
, stab_ptr
->n_value
);
1400 * For now, just declare the various functions. Later
1401 * on, we will add the line number information and the
1405 * Copy the string to a temp buffer so we
1406 * can kill everything after the ':'. We do
1407 * it this way because otherwise we end up dirtying
1408 * all of the pages related to the stabs, and that
1409 * sucks up swap space like crazy.
1411 stab_strcpy(symname
, sizeof(symname
), ptr
);
1414 struct symt_function_signature
* func_type
;
1418 /* First, clean up the previous function we were working on.
1419 * Assume size of the func is the delta between current offset
1420 * and offset of last function
1422 stabs_finalize_function(module
, curr_func
,
1424 (load_offset
+ stab_ptr
->n_value
- curr_func
->address
) : 0);
1426 func_type
= symt_new_function_signature(module
,
1427 stabs_parse_type(ptr
), -1);
1428 curr_func
= symt_new_function(module
, compiland
, symname
,
1429 load_offset
+ stab_ptr
->n_value
, 0,
1434 /* some versions of GCC to use a N_FUN "" to mark the end of a function
1435 * and n_value contains the size of the func
1437 stabs_finalize_function(module
, curr_func
, stab_ptr
->n_value
);
1443 * This indicates a new source file. Append the records
1444 * together, to build the correct path name.
1446 if (*ptr
== '\0') /* end of N_SO file */
1448 /* Nuke old path. */
1450 stabs_finalize_function(module
, curr_func
, 0);
1454 assert(block
== NULL
);
1459 int len
= strlen(ptr
);
1460 if (ptr
[len
-1] != '/')
1462 stabs_reset_includes();
1463 source_idx
= source_new(module
, srcpath
, ptr
);
1464 compiland
= symt_new_compiland(module
, 0 /* FIXME */, source_idx
);
1467 strcpy(srcpath
, ptr
);
1471 source_idx
= source_new(module
, srcpath
, ptr
);
1475 strtabinc
= stab_ptr
->n_value
;
1476 /* I'm not sure this is needed, so trace it before we obsolete it */
1479 FIXME("UNDF: curr_func %s\n", curr_func
->hash_elt
.name
);
1480 stabs_finalize_function(module
, curr_func
, 0); /* FIXME */
1485 /* Ignore this. We don't care what it points to. */
1488 stabs_add_include(stabs_new_include(ptr
, stab_ptr
->n_value
));
1489 assert(incl_stk
< (int)(sizeof(incl
) / sizeof(incl
[0])) - 1);
1490 incl
[++incl_stk
] = source_idx
;
1491 source_idx
= source_new(module
, NULL
, ptr
);
1494 assert(incl_stk
>= 0);
1495 source_idx
= incl
[incl_stk
--];
1498 if (stabs_add_include(stabs_find_include(ptr
, stab_ptr
->n_value
)) < 0)
1500 ERR("Excluded header not found (%s,%ld)\n", ptr
, stab_ptr
->n_value
);
1501 module_reset_debug_info(module
);
1507 /* Always ignore these. GCC doesn't even generate them. */
1511 /* Always ignore these, they seem to be used only on Darwin. */
1514 ERR("Unknown stab type 0x%02x\n", stab_ptr
->n_type
);
1518 TRACE("0x%02x %lx %s\n",
1519 stab_ptr
->n_type
, stab_ptr
->n_value
, debugstr_a(strs
+ stab_ptr
->n_un
.n_strx
));
1521 module
->module
.SymType
= SymDia
;
1522 module
->module
.CVSig
= 'S' | ('T' << 8) | ('A' << 16) | ('B' << 24);
1523 /* FIXME: we could have a finer grain here */
1524 module
->module
.LineNumbers
= TRUE
;
1525 module
->module
.GlobalSymbols
= TRUE
;
1526 module
->module
.TypeInfo
= TRUE
;
1527 module
->module
.SourceIndexed
= TRUE
;
1528 module
->module
.Publics
= TRUE
;
1530 HeapFree(GetProcessHeap(), 0, stabbuff
);
1531 stabs_free_includes();
1532 HeapFree(GetProcessHeap(), 0, pending
.vars
);