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
34 #include <sys/types.h>
36 #ifdef HAVE_SYS_STAT_H
37 # include <sys/stat.h>
39 #ifdef HAVE_SYS_MMAN_H
50 #define PATH_MAX MAX_PATH
59 #include "dbghelp_private.h"
61 #include "wine/debug.h"
63 WINE_DEFAULT_DEBUG_CHANNEL(dbghelp_stabs);
95 struct stab_nlist* n_next;
101 unsigned long n_value;
104 static void stab_strcpy(char* dest, int sz, const char* source)
108 * A strcpy routine that stops when we hit the ':' character.
109 * Faster than copying the whole thing, and then nuking the
111 * Takes also care of (valid) a::b constructs
113 while (*source != '\0')
115 if (source[0] != ':' && sz-- > 0) *ptr++ = *source++;
116 else if (source[1] == ':' && (sz -= 2) > 0)
124 /* GCC emits, in some cases, a .<digit>+ suffix.
125 * This is used for static variable inside functions, so
126 * that we can have several such variables with same name in
127 * the same compilation unit
128 * We simply ignore that suffix when present (we also get rid
129 * of it in ELF symtab parsing)
131 if (ptr >= dest && isdigit(*ptr))
133 while (ptr > dest && isdigit(*ptr)) ptr--;
134 if (*ptr == '.') *ptr = '\0';
143 struct symt** vector;
147 #define MAX_INCLUDES 5120
149 static include_def* include_defs = NULL;
150 static int num_include_def = 0;
151 static int num_alloc_include_def = 0;
152 static int cu_include_stack[MAX_INCLUDES];
153 static int cu_include_stk_idx = 0;
154 static struct symt** cu_vector = NULL;
155 static int cu_nrofentries = 0;
156 static struct symt_basic* stabs_basic[36];
158 static int stabs_new_include(const char* file, unsigned long val)
160 if (num_include_def == num_alloc_include_def)
162 num_alloc_include_def += 256;
164 include_defs = HeapAlloc(GetProcessHeap(), 0,
165 sizeof(include_defs[0]) * num_alloc_include_def);
167 include_defs = HeapReAlloc(GetProcessHeap(), 0, include_defs,
168 sizeof(include_defs[0]) * num_alloc_include_def);
169 memset(include_defs + num_include_def, 0, sizeof(include_defs[0]) * 256);
171 include_defs[num_include_def].name = strcpy(HeapAlloc(GetProcessHeap(), 0, strlen(file) + 1), file);
172 include_defs[num_include_def].value = val;
173 include_defs[num_include_def].vector = NULL;
174 include_defs[num_include_def].nrofentries = 0;
176 return num_include_def++;
179 static int stabs_find_include(const char* file, unsigned long val)
183 for (i = 0; i < num_include_def; i++)
185 if (val == include_defs[i].value &&
186 strcmp(file, include_defs[i].name) == 0)
192 static int stabs_add_include(int idx)
194 if (idx < 0) return -1;
195 cu_include_stk_idx++;
197 /* if this happens, just bump MAX_INCLUDES */
198 /* we could also handle this as another dynarray */
199 assert(cu_include_stk_idx < MAX_INCLUDES);
200 cu_include_stack[cu_include_stk_idx] = idx;
201 return cu_include_stk_idx;
204 static void stabs_reset_includes(void)
207 * The struct symt:s that we would need to use are reset when
208 * we start a new file. (at least the ones in filenr == 0)
210 cu_include_stk_idx = 0;/* keep 0 as index for the .c file itself */
211 memset(cu_vector, 0, sizeof(cu_vector[0]) * cu_nrofentries);
214 static void stabs_free_includes(void)
218 stabs_reset_includes();
219 for (i = 0; i < num_include_def; i++)
221 HeapFree(GetProcessHeap(), 0, include_defs[i].name);
222 HeapFree(GetProcessHeap(), 0, include_defs[i].vector);
224 HeapFree(GetProcessHeap(), 0, include_defs);
227 num_alloc_include_def = 0;
228 HeapFree(GetProcessHeap(), 0, cu_vector);
233 static struct symt** stabs_find_ref(long filenr, long subnr)
237 /* FIXME: I could perhaps create a dummy include_def for each compilation
238 * unit which would allow not to handle those two cases separately
242 if (cu_nrofentries <= subnr)
245 cu_vector = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
246 sizeof(cu_vector[0]) * (subnr+1));
248 cu_vector = HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
249 cu_vector, sizeof(cu_vector[0]) * (subnr+1));
250 cu_nrofentries = subnr + 1;
252 ret = &cu_vector[subnr];
258 assert(filenr <= cu_include_stk_idx);
259 idef = &include_defs[cu_include_stack[filenr]];
261 if (idef->nrofentries <= subnr)
264 idef->vector = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
265 sizeof(idef->vector[0]) * (subnr+1));
267 idef->vector = HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
268 idef->vector, sizeof(idef->vector[0]) * (subnr+1));
269 idef->nrofentries = subnr + 1;
271 ret = &idef->vector[subnr];
273 TRACE("(%ld,%ld) => %p (%p)\n", filenr, subnr, ret, *ret);
277 static struct symt** stabs_read_type_enum(const char** x)
287 filenr = strtol(iter, &end, 10); /* <int> */
288 iter = ++end; /* ',' */
289 subnr = strtol(iter, &end, 10); /* <int> */
290 iter = ++end; /* ')' */
295 subnr = strtol(iter, &end, 10); /* <int> */
299 return stabs_find_ref(filenr, subnr);
303 struct ParseTypedefData
308 struct module* module;
320 static void stabs_pts_push(struct ParseTypedefData* ptd, unsigned line)
322 assert(ptd->err_idx < sizeof(ptd->errors) / sizeof(ptd->errors[0]));
323 ptd->errors[ptd->err_idx].line = line;
324 ptd->errors[ptd->err_idx].ptr = ptd->ptr;
327 #define PTS_ABORTIF(ptd, t) do { if (t) { stabs_pts_push((ptd), __LINE__); return -1;} } while (0)
329 #define PTS_ABORTIF(ptd, t) do { if (t) return -1; } while (0)
332 static int stabs_get_basic(struct ParseTypedefData* ptd, unsigned basic, struct symt** symt)
334 PTS_ABORTIF(ptd, basic >= sizeof(stabs_basic) / sizeof(stabs_basic[0]));
336 if (!stabs_basic[basic])
340 case 1: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "int", 4); break;
341 case 2: stabs_basic[basic] = symt_new_basic(ptd->module, btChar, "char", 1); break;
342 case 3: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "short int", 2); break;
343 case 4: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "long int", 4); break;
344 case 5: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "unsigned char", 1); break;
345 case 6: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "signed char", 1); break;
346 case 7: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "unsigned short int", 2); break;
347 case 8: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "unsigned int", 4); break;
348 case 9: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "unsigned", 2); break;
349 case 10: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "unsigned long int", 2); break;
350 case 11: stabs_basic[basic] = symt_new_basic(ptd->module, btVoid, "void", 0); break;
351 case 12: stabs_basic[basic] = symt_new_basic(ptd->module, btFloat, "float", 4); break;
352 case 13: stabs_basic[basic] = symt_new_basic(ptd->module, btFloat, "double", 8); break;
353 case 14: stabs_basic[basic] = symt_new_basic(ptd->module, btFloat, "long double", 12); break;
354 case 15: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "integer", 4); break;
355 case 16: stabs_basic[basic] = symt_new_basic(ptd->module, btBool, "bool", 1); break;
356 /* case 17: short real */
358 case 25: stabs_basic[basic] = symt_new_basic(ptd->module, btComplex, "float complex", 8); break;
359 case 26: stabs_basic[basic] = symt_new_basic(ptd->module, btComplex, "double complex", 16); break;
360 case 30: stabs_basic[basic] = symt_new_basic(ptd->module, btWChar, "wchar_t", 2); break;
361 case 31: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "long long int", 8); break;
362 case 32: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "long long unsigned", 8); break;
363 /* starting at 35 are wine extensions (especially for R implementation) */
364 case 35: stabs_basic[basic] = symt_new_basic(ptd->module, btComplex, "long double complex", 24); break;
365 default: PTS_ABORTIF(ptd, 1);
368 *symt = &stabs_basic[basic]->symt;
372 static int stabs_pts_read_type_def(struct ParseTypedefData* ptd,
373 const char* typename, struct symt** dt);
375 static int stabs_pts_read_id(struct ParseTypedefData* ptd)
377 const char* first = ptd->ptr;
378 unsigned int template = 0;
381 while ((ch = *ptd->ptr++) != '\0')
388 unsigned int len = ptd->ptr - first - 1;
389 PTS_ABORTIF(ptd, len >= sizeof(ptd->buf) - ptd->idx);
390 memcpy(ptd->buf + ptd->idx, first, len);
391 ptd->buf[ptd->idx + len] = '\0';
396 case '<': template++; break;
397 case '>': PTS_ABORTIF(ptd, template == 0); template--; break;
403 static int stabs_pts_read_number(struct ParseTypedefData* ptd, long* v)
407 *v = strtol(ptd->ptr, &last, 10);
408 PTS_ABORTIF(ptd, last == ptd->ptr);
413 static int stabs_pts_read_type_reference(struct ParseTypedefData* ptd,
414 long* filenr, long* subnr)
416 if (*ptd->ptr == '(')
418 /* '(' <int> ',' <int> ')' */
420 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, filenr) == -1);
421 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
422 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, subnr) == -1);
423 PTS_ABORTIF(ptd, *ptd->ptr++ != ')');
428 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, subnr) == -1);
433 struct pts_range_value
439 static int stabs_pts_read_range_value(struct ParseTypedefData* ptd, struct pts_range_value* prv)
446 while (*ptd->ptr == '0') ptd->ptr++;
447 if (*ptd->ptr >= '1' && *ptd->ptr <= '7')
452 PTS_ABORTIF(ptd, ptd->ptr[0] != '1');
455 while (isdigit(*ptd->ptr)) prv->val = (prv->val << 3) + *ptd->ptr++ - '0';
460 while (isdigit(*ptd->ptr)) prv->val = (prv->val << 3) + *ptd->ptr++ - '0';
462 default: PTS_ABORTIF(ptd, 1); break;
464 } else prv->sign = 0;
468 prv->val = strtoull(++ptd->ptr, &last, 10);
474 prv->val = strtoull(ptd->ptr, &last, 10);
481 static int stabs_pts_read_range(struct ParseTypedefData* ptd, const char* typename,
485 struct pts_range_value lo;
486 struct pts_range_value hi;
492 /* type ';' <int> ';' <int> ';' */
493 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &ref) == -1);
494 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
495 PTS_ABORTIF(ptd, stabs_pts_read_range_value(ptd, &lo) == -1);
496 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
497 PTS_ABORTIF(ptd, stabs_pts_read_range_value(ptd, &hi) == -1);
498 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
500 /* basically, we don't use ref... in some cases, for example, float is declared
501 * as a derivated type of int... which won't help us... so we guess the types
502 * from the various formats
504 if (lo.sign == 0 && hi.sign < 0)
509 else if (lo.sign < 0 && hi.sign == 0)
514 else if (lo.sign > 0 && hi.sign == 0)
519 else if (lo.sign < 0 && hi.sign > 0)
522 for (i = 7; i < 64; i += 8)
524 if (lo.val == v && hi.val == v - 1)
532 PTS_ABORTIF(ptd, i >= 64);
534 else if (lo.sign == 0 && hi.sign > 0)
536 if (hi.val == 127) /* specific case for char... */
544 for (i = 8; i <= 64; i += 8)
554 PTS_ABORTIF(ptd, i > 64);
557 else PTS_ABORTIF(ptd, 1);
559 *dt = &symt_new_basic(ptd->module, bt, typename, size)->symt;
563 static inline int stabs_pts_read_method_info(struct ParseTypedefData* ptd)
571 /* get type of return value */
572 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
573 if (*ptd->ptr == ';') ptd->ptr++;
575 /* get types of parameters */
576 if (*ptd->ptr == ':')
578 PTS_ABORTIF(ptd, !(tmp = strchr(ptd->ptr + 1, ';')));
581 PTS_ABORTIF(ptd, !(*ptd->ptr >= '0' && *ptd->ptr <= '9'));
583 PTS_ABORTIF(ptd, !(ptd->ptr[0] >= 'A' && *ptd->ptr <= 'D'));
585 PTS_ABORTIF(ptd, mthd != '.' && mthd != '?' && mthd != '*');
592 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &ofs) == -1);
593 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
594 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
595 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
597 } while (*ptd->ptr != ';');
603 static inline int stabs_pts_read_aggregate(struct ParseTypedefData* ptd,
604 struct symt_udt* sdt)
608 struct symt* dt = NULL;
612 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &sz) == -1);
614 doadd = symt_set_udt_size(ptd->module, sdt, sz);
615 if (*ptd->ptr == '!') /* C++ inheritence */
620 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &num_classes) == -1);
621 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
622 while (--num_classes >= 0)
624 ptd->ptr += 2; /* skip visibility and inheritence */
625 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &ofs) == -1);
626 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
628 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &adt) == -1);
636 symt_get_info(adt, TI_GET_SYMNAME, &name);
637 strcpy(tmp, "__inherited_class_");
638 WideCharToMultiByte(CP_ACP, 0, name, -1,
639 tmp + strlen(tmp), sizeof(tmp) - strlen(tmp),
641 HeapFree(GetProcessHeap(), 0, name);
642 /* FIXME: TI_GET_LENGTH will not always work, especially when adt
643 * has just been seen as a forward definition and not the real stuff
645 * As we don't use much the size of members in structs, this may not
646 * be much of a problem
648 symt_get_info(adt, TI_GET_LENGTH, &size);
649 symt_add_udt_element(ptd->module, sdt, tmp, adt, ofs, (DWORD)size * 8);
651 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
655 /* if the structure has already been filled, just redo the parsing
656 * but don't store results into the struct
657 * FIXME: there's a quite ugly memory leak in there...
660 /* Now parse the individual elements of the structure/union. */
661 while (*ptd->ptr != ';')
663 /* agg_name : type ',' <int:offset> ',' <int:size> */
666 if (ptd->ptr[0] == '$' && ptd->ptr[1] == 'v')
670 if (ptd->ptr[2] == 'f')
672 /* C++ virtual method table */
674 stabs_read_type_enum(&ptd->ptr);
675 PTS_ABORTIF(ptd, *ptd->ptr++ != ':');
676 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
677 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
678 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &x) == -1);
679 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
683 else if (ptd->ptr[2] == 'b')
686 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
687 PTS_ABORTIF(ptd, *ptd->ptr++ != ':');
688 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
689 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
690 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &x) == -1);
691 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
697 PTS_ABORTIF(ptd, stabs_pts_read_id(ptd) == -1);
698 /* Ref. TSDF R2.130 Section 7.4. When the field name is a method name
699 * it is followed by two colons rather than one.
701 if (*ptd->ptr == ':')
704 stabs_pts_read_method_info(ptd);
710 /* skip C++ member protection /0 /1 or /2 */
711 if (*ptd->ptr == '/') ptd->ptr += 2;
713 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &adt) == -1);
718 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &ofs) == -1);
719 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
720 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &sz) == -1);
721 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
723 if (doadd) symt_add_udt_element(ptd->module, sdt, ptd->buf + idx, adt, ofs, sz);
728 /* method parameters... terminated by ';' */
729 PTS_ABORTIF(ptd, !(tmp = strchr(ptd->ptr, ';')));
734 PTS_ABORTIF(ptd, TRUE);
738 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
739 if (*ptd->ptr == '~')
742 PTS_ABORTIF(ptd, *ptd->ptr++ != '%');
743 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
744 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
749 static inline int stabs_pts_read_enum(struct ParseTypedefData* ptd,
750 struct symt_enum* edt)
755 while (*ptd->ptr != ';')
758 PTS_ABORTIF(ptd, stabs_pts_read_id(ptd) == -1);
759 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &value) == -1);
760 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
761 symt_add_enum_element(ptd->module, edt, ptd->buf + idx, value);
768 static inline int stabs_pts_read_array(struct ParseTypedefData* ptd,
772 struct symt* range_dt;
773 struct symt* base_dt;
775 /* ar<typeinfo_nodef>;<int>;<int>;<typeinfo> */
777 PTS_ABORTIF(ptd, *ptd->ptr++ != 'r');
779 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &range_dt) == -1);
780 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
781 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &lo) == -1);
782 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
783 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &hi) == -1);
784 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
786 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &base_dt) == -1);
788 *adt = &symt_new_array(ptd->module, lo, hi, base_dt, range_dt)->symt;
792 static int stabs_pts_read_type_def(struct ParseTypedefData* ptd, const char* typename,
793 struct symt** ret_dt)
797 struct symt* new_dt = NULL; /* newly created data type */
798 struct symt* ref_dt; /* referenced data type (pointer...) */
799 long filenr1, subnr1, tmp;
801 /* things are a bit complicated because of the way the typedefs are stored inside
802 * the file, because addresses can change when realloc is done, so we must call
803 * over and over stabs_find_ref() to keep the correct values around
805 PTS_ABORTIF(ptd, stabs_pts_read_type_reference(ptd, &filenr1, &subnr1) == -1);
807 while (*ptd->ptr == '=')
810 PTS_ABORTIF(ptd, new_dt != btNoType);
812 /* first handle attribute if any */
816 if (*++ptd->ptr == 's')
819 if (stabs_pts_read_number(ptd, &sz) == -1)
821 ERR("Not an attribute... NIY\n");
825 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
829 /* then the real definitions */
834 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &ref_dt) == -1);
835 new_dt = &symt_new_pointer(ptd->module, ref_dt)->symt;
837 case 'k': /* 'const' modifier */
838 case 'B': /* 'volatile' modifier */
839 /* just kinda ignore the modifier, I guess -gmt */
840 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, typename, &new_dt) == -1);
844 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, typename, &new_dt) == -1);
847 PTS_ABORTIF(ptd, stabs_pts_read_array(ptd, &new_dt) == -1);
850 PTS_ABORTIF(ptd, stabs_pts_read_range(ptd, typename, &new_dt) == -1);
851 assert(!*stabs_find_ref(filenr1, subnr1));
852 *stabs_find_ref(filenr1, subnr1) = new_dt;
855 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &ref_dt) == -1);
856 new_dt = &symt_new_function_signature(ptd->module, ref_dt, -1)->symt;
859 new_dt = &symt_new_enum(ptd->module, typename)->symt;
860 PTS_ABORTIF(ptd, stabs_pts_read_enum(ptd, (struct symt_enum*)new_dt) == -1);
865 struct symt_udt* udt;
866 enum UdtKind kind = (ptd->ptr[-1] == 's') ? UdtStruct : UdtUnion;
867 /* udt can have been already defined in a forward definition */
868 udt = (struct symt_udt*)*stabs_find_ref(filenr1, subnr1);
871 udt = symt_new_udt(ptd->module, typename, 0, kind);
872 /* we need to set it here, because a struct can hold a pointer
875 new_dt = *stabs_find_ref(filenr1, subnr1) = &udt->symt;
880 if (udt->symt.tag != SymTagUDT)
882 ERR("Forward declaration (%p/%s) is not an aggregate (%u)\n",
883 udt, symt_get_name(&udt->symt), udt->symt.tag);
886 /* FIXME: we currently don't correctly construct nested C++
887 * classes names. Therefore, we could be here with either:
888 * - typename and udt->hash_elt.name being the same string
889 * (non embedded case)
890 * - typename being foo::bar while udt->hash_elt.name being
892 * So, we twist the comparison to test both occurrences. When
893 * we have proper C++ types in this file, this twist has to be
896 l1 = strlen(udt->hash_elt.name);
897 l2 = strlen(typename);
898 if (l1 > l2 || strcmp(udt->hash_elt.name, typename + l2 - l1))
899 ERR("Forward declaration name mismatch %s <> %s\n",
900 udt->hash_elt.name, typename);
903 PTS_ABORTIF(ptd, stabs_pts_read_aggregate(ptd, udt) == -1);
909 PTS_ABORTIF(ptd, stabs_pts_read_id(ptd) == -1);
913 new_dt = &symt_new_enum(ptd->module, ptd->buf + idx)->symt;
916 new_dt = &symt_new_udt(ptd->module, ptd->buf + idx, 0, UdtStruct)->symt;
919 new_dt = &symt_new_udt(ptd->module, ptd->buf + idx, 0, UdtUnion)->symt;
928 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &tmp) == -1);
929 PTS_ABORTIF(ptd, stabs_get_basic(ptd, tmp, &new_dt) == -1);
930 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
934 if (*ptd->ptr == '#')
937 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &ref_dt) == -1);
938 new_dt = &symt_new_function_signature(ptd->module, ref_dt, -1)->symt;
945 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &cls_dt) == -1);
946 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
947 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &ref_dt) == -1);
948 new_dt = &symt_new_function_signature(ptd->module, ref_dt, -1)->symt;
949 while (*ptd->ptr == ',')
952 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &pmt_dt) == -1);
961 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &type) == -1);
962 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
963 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &len) == -1);
964 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
965 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &unk) == -1);
966 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
968 switch (type) /* see stabs_get_basic for the details */
970 case 1: basic = 12; break;
971 case 2: basic = 13; break;
972 case 3: basic = 25; break;
973 case 4: basic = 26; break;
974 case 5: basic = 35; break;
975 case 6: basic = 14; break;
976 default: PTS_ABORTIF(ptd, 1);
978 PTS_ABORTIF(ptd, stabs_get_basic(ptd, basic, &new_dt) == -1);
982 ERR("Unknown type '%c'\n", ptd->ptr[-1]);
989 /* is it a forward declaration that has been filled ? */
990 new_dt = *stabs_find_ref(filenr1, subnr1);
991 /* if not, this should be void (which is defined as a ref to itself, but we
992 * don't correctly catch it)
994 if (!new_dt && typename)
996 new_dt = &symt_new_basic(ptd->module, btVoid, typename, 0)->symt;
997 PTS_ABORTIF(ptd, strcmp(typename, "void"));
1001 *stabs_find_ref(filenr1, subnr1) = *ret_dt = new_dt;
1003 TRACE("Adding (%ld,%ld) %s\n", filenr1, subnr1, typename);
1008 static int stabs_parse_typedef(struct module* module, const char* ptr,
1009 const char* typename)
1011 struct ParseTypedefData ptd;
1015 /* check for already existing definition */
1017 TRACE("%s => %s\n", typename, debugstr_a(ptr));
1018 ptd.module = module;
1023 for (ptd.ptr = ptr - 1; ;)
1025 ptd.ptr = strchr(ptd.ptr + 1, ':');
1026 if (ptd.ptr == NULL || *++ptd.ptr != ':') break;
1030 if (*ptd.ptr != '(') ptd.ptr++;
1031 /* most of type definitions take one char, except Tt */
1032 if (*ptd.ptr != '(') ptd.ptr++;
1033 ret = stabs_pts_read_type_def(&ptd, typename, &dt);
1036 if (ret == -1 || *ptd.ptr)
1040 TRACE("Failure on %s\n", debugstr_a(ptr));
1043 for (i = 0; i < ptd.err_idx; i++)
1045 TRACE("[%d]: line %d => %s\n",
1046 i, ptd.errors[i].line, debugstr_a(ptd.errors[i].ptr));
1050 TRACE("[0]: => %s\n", debugstr_a(ptd.ptr));
1053 ERR("Failure on %s at %s\n", debugstr_a(ptr), debugstr_a(ptd.ptr));
1061 static struct symt* stabs_parse_type(const char* stab)
1063 const char* c = stab - 1;
1066 * Look through the stab definition, and figure out what struct symt
1067 * this represents. If we have something we know about, assign the
1069 * According to "The \"stabs\" debug format" (Rev 2.130) the name may be
1070 * a C++ name and contain double colons e.g. foo::bar::baz:t5=*6.
1074 if ((c = strchr(c + 1, ':')) == NULL) return NULL;
1075 } while (*++c == ':');
1078 * The next characters say more about the type (i.e. data, function, etc)
1079 * of symbol. Skip them. (C++ for example may have Tt).
1080 * Actually this is a very weak description; I think Tt is the only
1081 * multiple combination we should see.
1083 while (*c && *c != '(' && !isdigit(*c))
1086 * The next is either an integer or a (integer,integer).
1087 * The stabs_read_type_enum() takes care that stab_types is large enough.
1089 return *stabs_read_type_enum(&c);
1092 struct pending_loc_var
1097 struct location loc;
1100 struct pending_block
1102 struct pending_loc_var* vars;
1107 static inline void pending_add(struct pending_block* pending, const char* name,
1108 enum DataKind dt, const struct location* loc)
1110 if (pending->num == pending->allocated)
1112 pending->allocated += 8;
1114 pending->vars = HeapAlloc(GetProcessHeap(), 0,
1115 pending->allocated * sizeof(pending->vars[0]));
1117 pending->vars = HeapReAlloc(GetProcessHeap(), 0, pending->vars,
1118 pending->allocated * sizeof(pending->vars[0]));
1120 stab_strcpy(pending->vars[pending->num].name,
1121 sizeof(pending->vars[pending->num].name), name);
1122 pending->vars[pending->num].type = stabs_parse_type(name);
1123 pending->vars[pending->num].kind = dt;
1124 pending->vars[pending->num].loc = *loc;
1128 static void pending_flush(struct pending_block* pending, struct module* module,
1129 struct symt_function* func, struct symt_block* block)
1133 for (i = 0; i < pending->num; i++)
1135 symt_add_func_local(module, func,
1136 pending->vars[i].kind, &pending->vars[i].loc,
1137 block, pending->vars[i].type, pending->vars[i].name);
1142 /******************************************************************
1143 * stabs_finalize_function
1145 * Ends function creation: mainly:
1146 * - cleans up line number information
1147 * - tries to set up a debug-start tag (FIXME: heuristic to be enhanced)
1148 * - for stabs which have abolute address in them, initializes the size of the
1149 * function (assuming that current function ends where next function starts)
1151 static void stabs_finalize_function(struct module* module, struct symt_function* func,
1155 struct location loc;
1158 symt_normalize_function(module, func);
1159 /* To define the debug-start of the function, we use the second line number.
1160 * Not 100% bullet proof, but better than nothing
1162 if (symt_fill_func_line_info(module, func, func->address, &il) &&
1163 symt_get_func_line_next(module, &il))
1165 loc.kind = loc_absolute;
1166 loc.offset = il.Address - func->address;
1167 symt_add_function_point(module, func, SymTagFuncDebugStart,
1170 if (size) func->size = size;
1173 BOOL stabs_parse(struct module* module, unsigned long load_offset,
1174 const void* pv_stab_ptr, int stablen,
1175 const char* strs, int strtablen)
1177 struct symt_function* curr_func = NULL;
1178 struct symt_block* block = NULL;
1179 struct symt_compiland* compiland = NULL;
1180 char srcpath[PATH_MAX]; /* path to directory source file is in */
1185 unsigned int stabbufflen;
1186 const struct stab_nlist* stab_ptr = pv_stab_ptr;
1187 const char* strs_end;
1192 int source_idx = -1;
1193 struct pending_block pending;
1195 struct location loc;
1197 nstab = stablen / sizeof(struct stab_nlist);
1198 strs_end = strs + strtablen;
1200 memset(srcpath, 0, sizeof(srcpath));
1201 memset(stabs_basic, 0, sizeof(stabs_basic));
1202 memset(&pending, 0, sizeof(pending));
1205 * Allocate a buffer into which we can build stab strings for cases
1206 * where the stab is continued over multiple lines.
1208 stabbufflen = 65536;
1209 stabbuff = HeapAlloc(GetProcessHeap(), 0, stabbufflen);
1213 for (i = 0; i < nstab; i++, stab_ptr++)
1215 ptr = strs + stab_ptr->n_un.n_strx;
1216 if ((ptr > strs_end) || (ptr + strlen(ptr) > strs_end))
1218 WARN("Bad stabs string %p\n", ptr);
1221 if (*ptr != '\0' && (ptr[strlen(ptr) - 1] == '\\'))
1224 * Indicates continuation. Append this to the buffer, and go onto the
1225 * next record. Repeat the process until we find a stab without the
1226 * '/' character, as this indicates we have the whole thing.
1228 unsigned len = strlen(ptr);
1229 if (strlen(stabbuff) + len > stabbufflen)
1231 stabbufflen += 65536;
1232 stabbuff = HeapReAlloc(GetProcessHeap(), 0, stabbuff, stabbufflen);
1234 strncat(stabbuff, ptr, len - 1);
1237 else if (stabbuff[0] != '\0')
1239 strcat(stabbuff, ptr);
1243 /* only symbol entries contain a typedef */
1244 switch (stab_ptr->n_type)
1253 if (strchr(ptr, '=') != NULL)
1256 * The stabs aren't in writable memory, so copy it over so we are
1257 * sure we can scribble on it.
1259 if (ptr != stabbuff)
1261 strcpy(stabbuff, ptr);
1264 stab_strcpy(symname, sizeof(symname), ptr);
1265 if (!stabs_parse_typedef(module, ptr, symname))
1267 /* skip this definition */
1274 switch (stab_ptr->n_type)
1278 * These are useless with ELF. They have no value, and you have to
1279 * read the normal symbol table to get the address. Thus we
1280 * ignore them, and when we process the normal symbol table
1281 * we should do the right thing.
1283 * With a.out or mingw, they actually do make some amount of sense.
1285 stab_strcpy(symname, sizeof(symname), ptr);
1286 symt_new_global_variable(module, compiland, symname, TRUE /* FIXME */,
1287 load_offset + stab_ptr->n_value, 0,
1288 stabs_parse_type(ptr));
1292 /* These are static symbols and BSS symbols. */
1293 stab_strcpy(symname, sizeof(symname), ptr);
1294 symt_new_global_variable(module, compiland, symname, TRUE /* FIXME */,
1295 load_offset + stab_ptr->n_value, 0,
1296 stabs_parse_type(ptr));
1301 block = symt_open_func_block(module, curr_func, block,
1302 stab_ptr->n_value, 0);
1303 pending_flush(&pending, module, curr_func, block);
1308 block = symt_close_func_block(module, curr_func, block,
1312 /* These are function parameters. */
1313 if (curr_func != NULL)
1315 struct symt* param_type = stabs_parse_type(ptr);
1316 stab_strcpy(symname, sizeof(symname), ptr);
1317 loc.kind = loc_regrel;
1318 loc.reg = 0; /* FIXME */
1319 loc.offset = stab_ptr->n_value;
1320 symt_add_func_local(module, curr_func,
1321 (long)stab_ptr->n_value >= 0 ? DataIsParam : DataIsLocal,
1322 &loc, NULL, param_type, symname);
1323 symt_add_function_signature_parameter(module,
1324 (struct symt_function_signature*)curr_func->type,
1329 /* These are registers (as local variables) */
1330 if (curr_func != NULL)
1332 loc.kind = loc_register;
1335 switch (stab_ptr->n_value)
1337 case 0: loc.reg = CV_REG_EAX; break;
1338 case 1: loc.reg = CV_REG_ECX; break;
1339 case 2: loc.reg = CV_REG_EDX; break;
1340 case 3: loc.reg = CV_REG_EBX; break;
1341 case 4: loc.reg = CV_REG_ESP; break;
1342 case 5: loc.reg = CV_REG_EBP; break;
1343 case 6: loc.reg = CV_REG_ESI; break;
1344 case 7: loc.reg = CV_REG_EDI; break;
1353 case 19: loc.reg = CV_REG_ST0 + stab_ptr->n_value - 12; break;
1355 FIXME("Unknown register value (%lu)\n", stab_ptr->n_value);
1356 loc.reg = CV_REG_NONE;
1359 stab_strcpy(symname, sizeof(symname), ptr);
1360 if (ptr[strlen(symname) + 1] == 'P')
1362 struct symt* param_type = stabs_parse_type(ptr);
1363 stab_strcpy(symname, sizeof(symname), ptr);
1364 symt_add_func_local(module, curr_func, DataIsParam, &loc,
1365 NULL, param_type, symname);
1366 symt_add_function_signature_parameter(module,
1367 (struct symt_function_signature*)curr_func->type,
1371 pending_add(&pending, ptr, DataIsLocal, &loc);
1375 /* These are local variables */
1376 loc.kind = loc_regrel;
1377 loc.reg = 0; /* FIXME */
1378 loc.offset = stab_ptr->n_value;
1379 if (curr_func != NULL) pending_add(&pending, ptr, DataIsLocal, &loc);
1383 * This is a line number. These are always relative to the start
1384 * of the function (N_FUN), and this makes the lookup easier.
1386 if (curr_func != NULL)
1388 assert(source_idx >= 0);
1389 symt_add_func_line(module, curr_func, source_idx,
1390 stab_ptr->n_desc, stab_ptr->n_value);
1395 * For now, just declare the various functions. Later
1396 * on, we will add the line number information and the
1400 * Copy the string to a temp buffer so we
1401 * can kill everything after the ':'. We do
1402 * it this way because otherwise we end up dirtying
1403 * all of the pages related to the stabs, and that
1404 * sucks up swap space like crazy.
1406 stab_strcpy(symname, sizeof(symname), ptr);
1409 struct symt_function_signature* func_type;
1413 /* First, clean up the previous function we were working on.
1414 * Assume size of the func is the delta between current offset
1415 * and offset of last function
1417 stabs_finalize_function(module, curr_func,
1419 (load_offset + stab_ptr->n_value - curr_func->address) : 0);
1421 func_type = symt_new_function_signature(module,
1422 stabs_parse_type(ptr), -1);
1423 curr_func = symt_new_function(module, compiland, symname,
1424 load_offset + stab_ptr->n_value, 0,
1429 /* some versions of GCC to use a N_FUN "" to mark the end of a function
1430 * and n_value contains the size of the func
1432 stabs_finalize_function(module, curr_func, stab_ptr->n_value);
1438 * This indicates a new source file. Append the records
1439 * together, to build the correct path name.
1441 if (*ptr == '\0') /* end of N_SO file */
1443 /* Nuke old path. */
1445 stabs_finalize_function(module, curr_func, 0);
1449 assert(block == NULL);
1454 int len = strlen(ptr);
1455 if (ptr[len-1] != '/')
1457 stabs_reset_includes();
1458 source_idx = source_new(module, srcpath, ptr);
1459 compiland = symt_new_compiland(module, 0 /* FIXME */, source_idx);
1462 strcpy(srcpath, ptr);
1466 source_idx = source_new(module, srcpath, ptr);
1470 strtabinc = stab_ptr->n_value;
1471 /* I'm not sure this is needed, so trace it before we obsolete it */
1474 FIXME("UNDF: curr_func %s\n", curr_func->hash_elt.name);
1475 stabs_finalize_function(module, curr_func, 0); /* FIXME */
1480 /* Ignore this. We don't care what it points to. */
1483 stabs_add_include(stabs_new_include(ptr, stab_ptr->n_value));
1484 assert(incl_stk < (int)(sizeof(incl) / sizeof(incl[0])) - 1);
1485 incl[++incl_stk] = source_idx;
1486 source_idx = source_new(module, NULL, ptr);
1489 assert(incl_stk >= 0);
1490 source_idx = incl[incl_stk--];
1493 if (stabs_add_include(stabs_find_include(ptr, stab_ptr->n_value)) < 0)
1495 ERR("Excluded header not found (%s,%ld)\n", ptr, stab_ptr->n_value);
1496 module_reset_debug_info(module);
1502 /* Always ignore these. GCC doesn't even generate them. */
1506 /* Always ignore these, they seem to be used only on Darwin. */
1509 ERR("Unknown stab type 0x%02x\n", stab_ptr->n_type);
1513 TRACE("0x%02x %lx %s\n",
1514 stab_ptr->n_type, stab_ptr->n_value, debugstr_a(strs + stab_ptr->n_un.n_strx));
1516 module->module.SymType = SymDia;
1517 module->module.CVSig = 'S' | ('T' << 8) | ('A' << 16) | ('B' << 24);
1518 /* FIXME: we could have a finer grain here */
1519 module->module.LineNumbers = TRUE;
1520 module->module.GlobalSymbols = TRUE;
1521 module->module.TypeInfo = TRUE;
1522 module->module.SourceIndexed = TRUE;
1523 module->module.Publics = TRUE;
1525 HeapFree(GetProcessHeap(), 0, stabbuff);
1526 stabs_free_includes();
1527 HeapFree(GetProcessHeap(), 0, pending.vars);