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
53 #ifdef HAVE_MACH_O_NLIST_H
54 # include <mach-o/nlist.h>
61 #include "dbghelp_private.h"
63 #include "wine/debug.h"
65 WINE_DEFAULT_DEBUG_CHANNEL(dbghelp_stabs);
67 /* Masks for n_type field */
78 /* Values for (n_type & N_TYPE) */
111 unsigned char n_type;
117 static void stab_strcpy(char* dest, int sz, const char* source)
121 * A strcpy routine that stops when we hit the ':' character.
122 * Faster than copying the whole thing, and then nuking the
124 * Takes also care of (valid) a::b constructs
126 while (*source != '\0')
128 if (source[0] != ':' && sz-- > 0) *ptr++ = *source++;
129 else if (source[1] == ':' && (sz -= 2) > 0)
137 /* GCC emits, in some cases, a .<digit>+ suffix.
138 * This is used for static variable inside functions, so
139 * that we can have several such variables with same name in
140 * the same compilation unit
141 * We simply ignore that suffix when present (we also get rid
142 * of it in ELF symtab parsing)
144 if (ptr >= dest && isdigit(*ptr))
146 while (ptr > dest && isdigit(*ptr)) ptr--;
147 if (*ptr == '.') *ptr = '\0';
156 struct symt** vector;
160 #define MAX_INCLUDES 5120
162 static include_def* include_defs = NULL;
163 static int num_include_def = 0;
164 static int num_alloc_include_def = 0;
165 static int cu_include_stack[MAX_INCLUDES];
166 static int cu_include_stk_idx = 0;
167 static struct symt** cu_vector = NULL;
168 static int cu_nrofentries = 0;
169 static struct symt_basic* stabs_basic[36];
171 static int stabs_new_include(const char* file, unsigned long val)
173 if (num_include_def == num_alloc_include_def)
177 num_alloc_include_def = 256;
178 include_defs = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
179 sizeof(include_defs[0]) * num_alloc_include_def);
183 num_alloc_include_def *= 2;
184 include_defs = HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, include_defs,
185 sizeof(include_defs[0]) * num_alloc_include_def);
188 include_defs[num_include_def].name = strcpy(HeapAlloc(GetProcessHeap(), 0, strlen(file) + 1), file);
189 include_defs[num_include_def].value = val;
190 include_defs[num_include_def].vector = NULL;
191 include_defs[num_include_def].nrofentries = 0;
193 return num_include_def++;
196 static int stabs_find_include(const char* file, unsigned long val)
200 for (i = 0; i < num_include_def; i++)
202 if (val == include_defs[i].value &&
203 strcmp(file, include_defs[i].name) == 0)
209 static int stabs_add_include(int idx)
211 if (idx < 0) return -1;
212 cu_include_stk_idx++;
214 /* if this happens, just bump MAX_INCLUDES */
215 /* we could also handle this as another dynarray */
216 assert(cu_include_stk_idx < MAX_INCLUDES);
217 cu_include_stack[cu_include_stk_idx] = idx;
218 return cu_include_stk_idx;
221 static void stabs_reset_includes(void)
224 * The struct symt:s that we would need to use are reset when
225 * we start a new file. (at least the ones in filenr == 0)
227 cu_include_stk_idx = 0;/* keep 0 as index for the .c file itself */
228 memset(cu_vector, 0, sizeof(cu_vector[0]) * cu_nrofentries);
231 static void stabs_free_includes(void)
235 stabs_reset_includes();
236 for (i = 0; i < num_include_def; i++)
238 HeapFree(GetProcessHeap(), 0, include_defs[i].name);
239 HeapFree(GetProcessHeap(), 0, include_defs[i].vector);
241 HeapFree(GetProcessHeap(), 0, include_defs);
244 num_alloc_include_def = 0;
245 HeapFree(GetProcessHeap(), 0, cu_vector);
250 static struct symt** stabs_find_ref(long filenr, long subnr)
254 /* FIXME: I could perhaps create a dummy include_def for each compilation
255 * unit which would allow not to handle those two cases separately
259 if (cu_nrofentries <= subnr)
261 cu_nrofentries = max( cu_nrofentries * 2, subnr + 1 );
263 cu_vector = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
264 sizeof(cu_vector[0]) * cu_nrofentries);
266 cu_vector = HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
267 cu_vector, sizeof(cu_vector[0]) * cu_nrofentries);
269 ret = &cu_vector[subnr];
275 assert(filenr <= cu_include_stk_idx);
276 idef = &include_defs[cu_include_stack[filenr]];
278 if (idef->nrofentries <= subnr)
280 idef->nrofentries = max( idef->nrofentries * 2, subnr + 1 );
282 idef->vector = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
283 sizeof(idef->vector[0]) * idef->nrofentries);
285 idef->vector = HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
286 idef->vector, sizeof(idef->vector[0]) * idef->nrofentries);
288 ret = &idef->vector[subnr];
290 TRACE("(%ld,%ld) => %p (%p)\n", filenr, subnr, ret, *ret);
294 static struct symt** stabs_read_type_enum(const char** x)
304 filenr = strtol(iter, &end, 10); /* <int> */
305 iter = ++end; /* ',' */
306 subnr = strtol(iter, &end, 10); /* <int> */
307 iter = ++end; /* ')' */
312 subnr = strtol(iter, &end, 10); /* <int> */
316 return stabs_find_ref(filenr, subnr);
320 struct ParseTypedefData
325 struct module* module;
337 static void stabs_pts_push(struct ParseTypedefData* ptd, unsigned line)
339 assert(ptd->err_idx < sizeof(ptd->errors) / sizeof(ptd->errors[0]));
340 ptd->errors[ptd->err_idx].line = line;
341 ptd->errors[ptd->err_idx].ptr = ptd->ptr;
344 #define PTS_ABORTIF(ptd, t) do { if (t) { stabs_pts_push((ptd), __LINE__); return -1;} } while (0)
346 #define PTS_ABORTIF(ptd, t) do { if (t) return -1; } while (0)
349 static int stabs_get_basic(struct ParseTypedefData* ptd, unsigned basic, struct symt** symt)
351 PTS_ABORTIF(ptd, basic >= sizeof(stabs_basic) / sizeof(stabs_basic[0]));
353 if (!stabs_basic[basic])
357 case 1: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "int", 4); break;
358 case 2: stabs_basic[basic] = symt_new_basic(ptd->module, btChar, "char", 1); break;
359 case 3: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "short int", 2); break;
360 case 4: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "long int", 4); break;
361 case 5: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "unsigned char", 1); break;
362 case 6: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "signed char", 1); break;
363 case 7: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "unsigned short int", 2); break;
364 case 8: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "unsigned int", 4); break;
365 case 9: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "unsigned", 2); break;
366 case 10: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "unsigned long int", 2); break;
367 case 11: stabs_basic[basic] = symt_new_basic(ptd->module, btVoid, "void", 0); break;
368 case 12: stabs_basic[basic] = symt_new_basic(ptd->module, btFloat, "float", 4); break;
369 case 13: stabs_basic[basic] = symt_new_basic(ptd->module, btFloat, "double", 8); break;
370 case 14: stabs_basic[basic] = symt_new_basic(ptd->module, btFloat, "long double", 12); break;
371 case 15: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "integer", 4); break;
372 case 16: stabs_basic[basic] = symt_new_basic(ptd->module, btBool, "bool", 1); break;
373 /* case 17: short real */
375 case 25: stabs_basic[basic] = symt_new_basic(ptd->module, btComplex, "float complex", 8); break;
376 case 26: stabs_basic[basic] = symt_new_basic(ptd->module, btComplex, "double complex", 16); break;
377 case 30: stabs_basic[basic] = symt_new_basic(ptd->module, btWChar, "wchar_t", 2); break;
378 case 31: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "long long int", 8); break;
379 case 32: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "long long unsigned", 8); break;
380 /* starting at 35 are wine extensions (especially for R implementation) */
381 case 35: stabs_basic[basic] = symt_new_basic(ptd->module, btComplex, "long double complex", 24); break;
382 default: PTS_ABORTIF(ptd, 1);
385 *symt = &stabs_basic[basic]->symt;
389 static int stabs_pts_read_type_def(struct ParseTypedefData* ptd,
390 const char* typename, struct symt** dt);
392 static int stabs_pts_read_id(struct ParseTypedefData* ptd)
394 const char* first = ptd->ptr;
395 unsigned int template = 0;
398 while ((ch = *ptd->ptr++) != '\0')
405 unsigned int len = ptd->ptr - first - 1;
406 PTS_ABORTIF(ptd, len >= sizeof(ptd->buf) - ptd->idx);
407 memcpy(ptd->buf + ptd->idx, first, len);
408 ptd->buf[ptd->idx + len] = '\0';
413 case '<': template++; break;
414 case '>': PTS_ABORTIF(ptd, template == 0); template--; break;
420 static int stabs_pts_read_number(struct ParseTypedefData* ptd, long* v)
424 *v = strtol(ptd->ptr, &last, 10);
425 PTS_ABORTIF(ptd, last == ptd->ptr);
430 static int stabs_pts_read_type_reference(struct ParseTypedefData* ptd,
431 long* filenr, long* subnr)
433 if (*ptd->ptr == '(')
435 /* '(' <int> ',' <int> ')' */
437 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, filenr) == -1);
438 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
439 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, subnr) == -1);
440 PTS_ABORTIF(ptd, *ptd->ptr++ != ')');
445 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, subnr) == -1);
450 struct pts_range_value
456 static int stabs_pts_read_range_value(struct ParseTypedefData* ptd, struct pts_range_value* prv)
463 while (*ptd->ptr == '0') ptd->ptr++;
464 if (*ptd->ptr >= '1' && *ptd->ptr <= '7')
469 PTS_ABORTIF(ptd, ptd->ptr[0] != '1');
472 while (isdigit(*ptd->ptr)) prv->val = (prv->val << 3) + *ptd->ptr++ - '0';
477 while (isdigit(*ptd->ptr)) prv->val = (prv->val << 3) + *ptd->ptr++ - '0';
479 default: PTS_ABORTIF(ptd, 1); break;
481 } else prv->sign = 0;
485 prv->val = strtoull(++ptd->ptr, &last, 10);
491 prv->val = strtoull(ptd->ptr, &last, 10);
498 static int stabs_pts_read_range(struct ParseTypedefData* ptd, const char* typename,
502 struct pts_range_value lo;
503 struct pts_range_value hi;
509 /* type ';' <int> ';' <int> ';' */
510 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &ref) == -1);
511 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
512 PTS_ABORTIF(ptd, stabs_pts_read_range_value(ptd, &lo) == -1);
513 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
514 PTS_ABORTIF(ptd, stabs_pts_read_range_value(ptd, &hi) == -1);
515 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
517 /* basically, we don't use ref... in some cases, for example, float is declared
518 * as a derived type of int... which won't help us... so we guess the types
519 * from the various formats
521 if (lo.sign == 0 && hi.sign < 0)
526 else if (lo.sign < 0 && hi.sign == 0)
531 else if (lo.sign > 0 && hi.sign == 0)
536 else if (lo.sign < 0 && hi.sign > 0)
539 for (i = 7; i < 64; i += 8)
541 if (lo.val == v && hi.val == v - 1)
549 PTS_ABORTIF(ptd, i >= 64);
551 else if (lo.sign == 0 && hi.sign > 0)
553 if (hi.val == 127) /* specific case for char... */
561 for (i = 8; i <= 64; i += 8)
571 PTS_ABORTIF(ptd, i > 64);
574 else PTS_ABORTIF(ptd, 1);
576 *dt = &symt_new_basic(ptd->module, bt, typename, size)->symt;
580 static inline int stabs_pts_read_method_info(struct ParseTypedefData* ptd)
588 /* get type of return value */
589 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
590 if (*ptd->ptr == ';') ptd->ptr++;
592 /* get types of parameters */
593 if (*ptd->ptr == ':')
595 PTS_ABORTIF(ptd, !(tmp = strchr(ptd->ptr + 1, ';')));
598 PTS_ABORTIF(ptd, !(*ptd->ptr >= '0' && *ptd->ptr <= '9'));
600 PTS_ABORTIF(ptd, !(ptd->ptr[0] >= 'A' && *ptd->ptr <= 'D'));
602 PTS_ABORTIF(ptd, mthd != '.' && mthd != '?' && mthd != '*');
609 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &ofs) == -1);
610 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
611 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
612 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
614 } while (*ptd->ptr != ';');
620 static inline int stabs_pts_read_aggregate(struct ParseTypedefData* ptd,
621 struct symt_udt* sdt)
625 struct symt* dt = NULL;
629 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &sz) == -1);
631 doadd = symt_set_udt_size(ptd->module, sdt, sz);
632 if (*ptd->ptr == '!') /* C++ inheritence */
637 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &num_classes) == -1);
638 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
639 while (--num_classes >= 0)
641 ptd->ptr += 2; /* skip visibility and inheritence */
642 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &ofs) == -1);
643 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
645 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &adt) == -1);
652 strcpy(tmp, "__inherited_class_");
653 strcat(tmp, symt_get_name(adt));
655 /* FIXME: TI_GET_LENGTH will not always work, especially when adt
656 * has just been seen as a forward definition and not the real stuff
658 * As we don't use much the size of members in structs, this may not
659 * be much of a problem
661 symt_get_info(ptd->module, adt, TI_GET_LENGTH, &size);
662 symt_add_udt_element(ptd->module, sdt, tmp, adt, ofs, (DWORD)size * 8);
664 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
668 /* if the structure has already been filled, just redo the parsing
669 * but don't store results into the struct
670 * FIXME: there's a quite ugly memory leak in there...
673 /* Now parse the individual elements of the structure/union. */
674 while (*ptd->ptr != ';')
676 /* agg_name : type ',' <int:offset> ',' <int:size> */
679 if (ptd->ptr[0] == '$' && ptd->ptr[1] == 'v')
683 if (ptd->ptr[2] == 'f')
685 /* C++ virtual method table */
687 stabs_read_type_enum(&ptd->ptr);
688 PTS_ABORTIF(ptd, *ptd->ptr++ != ':');
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_number(ptd, &x) == -1);
692 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
696 else if (ptd->ptr[2] == 'b')
699 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
700 PTS_ABORTIF(ptd, *ptd->ptr++ != ':');
701 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
702 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
703 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &x) == -1);
704 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
710 PTS_ABORTIF(ptd, stabs_pts_read_id(ptd) == -1);
711 /* Ref. TSDF R2.130 Section 7.4. When the field name is a method name
712 * it is followed by two colons rather than one.
714 if (*ptd->ptr == ':')
717 stabs_pts_read_method_info(ptd);
723 /* skip C++ member protection /0 /1 or /2 */
724 if (*ptd->ptr == '/') ptd->ptr += 2;
726 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &adt) == -1);
731 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &ofs) == -1);
732 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
733 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &sz) == -1);
734 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
736 if (doadd) symt_add_udt_element(ptd->module, sdt, ptd->buf + idx, adt, ofs, sz);
741 /* method parameters... terminated by ';' */
742 PTS_ABORTIF(ptd, !(tmp = strchr(ptd->ptr, ';')));
747 PTS_ABORTIF(ptd, TRUE);
751 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
752 if (*ptd->ptr == '~')
755 PTS_ABORTIF(ptd, *ptd->ptr++ != '%');
756 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
757 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
762 static inline int stabs_pts_read_enum(struct ParseTypedefData* ptd,
763 struct symt_enum* edt)
768 while (*ptd->ptr != ';')
771 PTS_ABORTIF(ptd, stabs_pts_read_id(ptd) == -1);
772 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &value) == -1);
773 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
774 symt_add_enum_element(ptd->module, edt, ptd->buf + idx, value);
781 static inline int stabs_pts_read_array(struct ParseTypedefData* ptd,
785 struct symt* range_dt;
786 struct symt* base_dt;
788 /* ar<typeinfo_nodef>;<int>;<int>;<typeinfo> */
790 PTS_ABORTIF(ptd, *ptd->ptr++ != 'r');
792 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &range_dt) == -1);
793 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
794 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &lo) == -1);
795 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
796 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &hi) == -1);
797 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
799 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &base_dt) == -1);
801 *adt = &symt_new_array(ptd->module, lo, hi, base_dt, range_dt)->symt;
805 static int stabs_pts_read_type_def(struct ParseTypedefData* ptd, const char* typename,
806 struct symt** ret_dt)
810 struct symt* new_dt = NULL; /* newly created data type */
811 struct symt* ref_dt; /* referenced data type (pointer...) */
812 long filenr1, subnr1, tmp;
814 /* things are a bit complicated because of the way the typedefs are stored inside
815 * the file, because addresses can change when realloc is done, so we must call
816 * over and over stabs_find_ref() to keep the correct values around
818 PTS_ABORTIF(ptd, stabs_pts_read_type_reference(ptd, &filenr1, &subnr1) == -1);
820 while (*ptd->ptr == '=')
823 PTS_ABORTIF(ptd, new_dt != NULL);
825 /* first handle attribute if any */
829 if (*++ptd->ptr == 's')
832 if (stabs_pts_read_number(ptd, &sz) == -1)
834 ERR("Not an attribute... NIY\n");
838 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
842 /* then the real definitions */
847 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &ref_dt) == -1);
848 new_dt = &symt_new_pointer(ptd->module, ref_dt, sizeof(void*))->symt;
850 case 'k': /* 'const' modifier */
851 case 'B': /* 'volatile' modifier */
852 /* just kinda ignore the modifier, I guess -gmt */
853 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, typename, &new_dt) == -1);
857 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, typename, &new_dt) == -1);
860 PTS_ABORTIF(ptd, stabs_pts_read_array(ptd, &new_dt) == -1);
863 PTS_ABORTIF(ptd, stabs_pts_read_range(ptd, typename, &new_dt) == -1);
864 assert(!*stabs_find_ref(filenr1, subnr1));
865 *stabs_find_ref(filenr1, subnr1) = new_dt;
868 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &ref_dt) == -1);
869 new_dt = &symt_new_function_signature(ptd->module, ref_dt, -1)->symt;
872 stabs_get_basic(ptd, 1 /* int */, &ref_dt);
873 new_dt = &symt_new_enum(ptd->module, typename, ref_dt)->symt;
874 PTS_ABORTIF(ptd, stabs_pts_read_enum(ptd, (struct symt_enum*)new_dt) == -1);
879 struct symt_udt* udt;
880 enum UdtKind kind = (ptd->ptr[-1] == 's') ? UdtStruct : UdtUnion;
881 /* udt can have been already defined in a forward definition */
882 udt = (struct symt_udt*)*stabs_find_ref(filenr1, subnr1);
885 udt = symt_new_udt(ptd->module, typename, 0, kind);
886 /* we need to set it here, because a struct can hold a pointer
889 new_dt = *stabs_find_ref(filenr1, subnr1) = &udt->symt;
894 if (udt->symt.tag != SymTagUDT)
896 ERR("Forward declaration (%p/%s) is not an aggregate (%u)\n",
897 udt, symt_get_name(&udt->symt), udt->symt.tag);
900 /* FIXME: we currently don't correctly construct nested C++
901 * classes names. Therefore, we could be here with either:
902 * - typename and udt->hash_elt.name being the same string
903 * (non embedded case)
904 * - typename being foo::bar while udt->hash_elt.name being
906 * So, we twist the comparison to test both occurrences. When
907 * we have proper C++ types in this file, this twist has to be
910 l1 = strlen(udt->hash_elt.name);
911 l2 = strlen(typename);
912 if (l1 > l2 || strcmp(udt->hash_elt.name, typename + l2 - l1))
913 ERR("Forward declaration name mismatch %s <> %s\n",
914 udt->hash_elt.name, typename);
917 PTS_ABORTIF(ptd, stabs_pts_read_aggregate(ptd, udt) == -1);
923 PTS_ABORTIF(ptd, stabs_pts_read_id(ptd) == -1);
927 stabs_get_basic(ptd, 1 /* int */, &ref_dt);
928 new_dt = &symt_new_enum(ptd->module, ptd->buf + idx, ref_dt)->symt;
931 new_dt = &symt_new_udt(ptd->module, ptd->buf + idx, 0, UdtStruct)->symt;
934 new_dt = &symt_new_udt(ptd->module, ptd->buf + idx, 0, UdtUnion)->symt;
943 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &tmp) == -1);
944 PTS_ABORTIF(ptd, stabs_get_basic(ptd, tmp, &new_dt) == -1);
945 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
949 if (*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;
960 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &cls_dt) == -1);
961 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
962 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &ref_dt) == -1);
963 new_dt = &symt_new_function_signature(ptd->module, ref_dt, -1)->symt;
964 while (*ptd->ptr == ',')
967 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &pmt_dt) == -1);
976 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &type) == -1);
977 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
978 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &len) == -1);
979 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
980 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &unk) == -1);
981 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
983 switch (type) /* see stabs_get_basic for the details */
985 case 1: basic = 12; break;
986 case 2: basic = 13; break;
987 case 3: basic = 25; break;
988 case 4: basic = 26; break;
989 case 5: basic = 35; break;
990 case 6: basic = 14; break;
991 default: PTS_ABORTIF(ptd, 1);
993 PTS_ABORTIF(ptd, stabs_get_basic(ptd, basic, &new_dt) == -1);
997 ERR("Unknown type '%c'\n", ptd->ptr[-1]);
1004 /* is it a forward declaration that has been filled ? */
1005 new_dt = *stabs_find_ref(filenr1, subnr1);
1006 /* if not, this should be void (which is defined as a ref to itself, but we
1007 * don't correctly catch it)
1009 if (!new_dt && typename)
1011 new_dt = &symt_new_basic(ptd->module, btVoid, typename, 0)->symt;
1012 PTS_ABORTIF(ptd, strcmp(typename, "void"));
1016 *stabs_find_ref(filenr1, subnr1) = *ret_dt = new_dt;
1018 TRACE("Adding (%ld,%ld) %s\n", filenr1, subnr1, debugstr_a(typename));
1023 static int stabs_parse_typedef(struct module* module, const char* ptr,
1024 const char* typename)
1026 struct ParseTypedefData ptd;
1030 /* check for already existing definition */
1032 TRACE("%s => %s\n", typename, debugstr_a(ptr));
1033 ptd.module = module;
1038 for (ptd.ptr = ptr - 1; ;)
1040 ptd.ptr = strchr(ptd.ptr + 1, ':');
1041 if (ptd.ptr == NULL || *++ptd.ptr != ':') break;
1045 if (*ptd.ptr != '(') ptd.ptr++;
1046 /* most of type definitions take one char, except Tt */
1047 if (*ptd.ptr != '(') ptd.ptr++;
1048 ret = stabs_pts_read_type_def(&ptd, typename, &dt);
1051 if (ret == -1 || *ptd.ptr)
1055 TRACE("Failure on %s\n", debugstr_a(ptr));
1058 for (i = 0; i < ptd.err_idx; i++)
1060 TRACE("[%d]: line %d => %s\n",
1061 i, ptd.errors[i].line, debugstr_a(ptd.errors[i].ptr));
1065 TRACE("[0]: => %s\n", debugstr_a(ptd.ptr));
1068 ERR("Failure on %s at %s\n", debugstr_a(ptr), debugstr_a(ptd.ptr));
1076 static struct symt* stabs_parse_type(const char* stab)
1078 const char* c = stab - 1;
1081 * Look through the stab definition, and figure out what struct symt
1082 * this represents. If we have something we know about, assign the
1084 * According to "The \"stabs\" debug format" (Rev 2.130) the name may be
1085 * a C++ name and contain double colons e.g. foo::bar::baz:t5=*6.
1089 if ((c = strchr(c + 1, ':')) == NULL) return NULL;
1090 } while (*++c == ':');
1093 * The next characters say more about the type (i.e. data, function, etc)
1094 * of symbol. Skip them. (C++ for example may have Tt).
1095 * Actually this is a very weak description; I think Tt is the only
1096 * multiple combination we should see.
1098 while (*c && *c != '(' && !isdigit(*c))
1101 * The next is either an integer or a (integer,integer).
1102 * The stabs_read_type_enum() takes care that stab_types is large enough.
1104 return *stabs_read_type_enum(&c);
1107 enum pending_obj_kind
1113 struct pending_loc_var
1118 struct location loc;
1125 unsigned long offset;
1126 unsigned long load_offset;
1129 struct pending_object
1131 enum pending_obj_kind tag;
1133 struct pending_loc_var var;
1134 struct pending_line line;
1140 struct pending_object* objs;
1145 static inline void pending_make_room(struct pending_list* pending)
1147 if (pending->num == pending->allocated)
1151 pending->allocated = 8;
1152 pending->objs = HeapAlloc(GetProcessHeap(), 0,
1153 pending->allocated * sizeof(pending->objs[0]));
1157 pending->allocated *= 2;
1158 pending->objs = HeapReAlloc(GetProcessHeap(), 0, pending->objs,
1159 pending->allocated * sizeof(pending->objs[0]));
1164 static inline void pending_add_var(struct pending_list* pending, const char* name,
1165 enum DataKind dt, const struct location* loc)
1167 pending_make_room(pending);
1168 pending->objs[pending->num].tag = PENDING_VAR;
1169 stab_strcpy(pending->objs[pending->num].u.var.name,
1170 sizeof(pending->objs[pending->num].u.var.name), name);
1171 pending->objs[pending->num].u.var.type = stabs_parse_type(name);
1172 pending->objs[pending->num].u.var.kind = dt;
1173 pending->objs[pending->num].u.var.loc = *loc;
1177 static inline void pending_add_line(struct pending_list* pending, int source_idx,
1178 int line_num, unsigned long offset,
1179 unsigned long load_offset)
1181 pending_make_room(pending);
1182 pending->objs[pending->num].tag = PENDING_LINE;
1183 pending->objs[pending->num].u.line.source_idx = source_idx;
1184 pending->objs[pending->num].u.line.line_num = line_num;
1185 pending->objs[pending->num].u.line.offset = offset;
1186 pending->objs[pending->num].u.line.load_offset = load_offset;
1190 static void pending_flush(struct pending_list* pending, struct module* module,
1191 struct symt_function* func, struct symt_block* block)
1195 for (i = 0; i < pending->num; i++)
1197 switch (pending->objs[i].tag)
1200 symt_add_func_local(module, func,
1201 pending->objs[i].u.var.kind, &pending->objs[i].u.var.loc,
1202 block, pending->objs[i].u.var.type, pending->objs[i].u.var.name);
1205 if (module->type == DMT_MACHO)
1206 pending->objs[i].u.line.offset -= func->address - pending->objs[i].u.line.load_offset;
1207 symt_add_func_line(module, func, pending->objs[i].u.line.source_idx,
1208 pending->objs[i].u.line.line_num, pending->objs[i].u.line.offset);
1211 ERR("Unknown pending object tag %u\n", (unsigned)pending->objs[i].tag);
1218 /******************************************************************
1219 * stabs_finalize_function
1221 * Ends function creation: mainly:
1222 * - cleans up line number information
1223 * - tries to set up a debug-start tag (FIXME: heuristic to be enhanced)
1224 * - for stabs which have absolute address in them, initializes the size of the
1225 * function (assuming that current function ends where next function starts)
1227 static void stabs_finalize_function(struct module* module, struct symt_function* func,
1231 struct location loc;
1234 symt_normalize_function(module, func);
1235 /* To define the debug-start of the function, we use the second line number.
1236 * Not 100% bullet proof, but better than nothing
1238 if (symt_fill_func_line_info(module, func, func->address, &il) &&
1239 symt_get_func_line_next(module, &il))
1241 loc.kind = loc_absolute;
1242 loc.offset = il.Address - func->address;
1243 symt_add_function_point(module, func, SymTagFuncDebugStart,
1246 if (size) func->size = size;
1249 static inline void stabbuf_append(char **buf, unsigned *buf_size, const char *str)
1251 unsigned str_len, buf_len;
1253 str_len = strlen(str);
1254 buf_len = strlen(*buf);
1256 if(str_len+buf_len >= *buf_size) {
1257 *buf_size += buf_len + str_len;
1258 *buf = HeapReAlloc(GetProcessHeap(), 0, *buf, *buf_size);
1261 strcpy(*buf+buf_len, str);
1264 BOOL stabs_parse(struct module* module, unsigned long load_offset,
1265 const void* pv_stab_ptr, int stablen,
1266 const char* strs, int strtablen,
1267 stabs_def_cb callback, void* user)
1269 struct symt_function* curr_func = NULL;
1270 struct symt_block* block = NULL;
1271 struct symt_compiland* compiland = NULL;
1272 char* srcpath = NULL;
1277 unsigned int stabbufflen;
1278 const struct stab_nlist* stab_ptr = pv_stab_ptr;
1279 const char* strs_end;
1284 int source_idx = -1;
1285 struct pending_list pending_block;
1286 struct pending_list pending_func;
1288 struct location loc;
1291 nstab = stablen / sizeof(struct stab_nlist);
1292 strs_end = strs + strtablen;
1294 memset(stabs_basic, 0, sizeof(stabs_basic));
1295 memset(&pending_block, 0, sizeof(pending_block));
1296 memset(&pending_func, 0, sizeof(pending_func));
1299 * Allocate a buffer into which we can build stab strings for cases
1300 * where the stab is continued over multiple lines.
1302 stabbufflen = 65536;
1303 stabbuff = HeapAlloc(GetProcessHeap(), 0, stabbufflen);
1307 for (i = 0; i < nstab; i++, stab_ptr++)
1309 ptr = strs + stab_ptr->n_strx;
1310 if ((ptr > strs_end) || (ptr + strlen(ptr) > strs_end))
1312 WARN("Bad stabs string %p\n", ptr);
1315 if (*ptr != '\0' && (ptr[strlen(ptr) - 1] == '\\'))
1318 * Indicates continuation. Append this to the buffer, and go onto the
1319 * next record. Repeat the process until we find a stab without the
1320 * '/' character, as this indicates we have the whole thing.
1322 stabbuf_append(&stabbuff, &stabbufflen, ptr);
1325 else if (stabbuff[0] != '\0')
1327 stabbuf_append(&stabbuff, &stabbufflen, ptr);
1331 if (stab_ptr->n_type & N_STAB)
1332 type = stab_ptr->n_type;
1334 type = (stab_ptr->n_type & N_TYPE);
1336 /* only symbol entries contain a typedef */
1346 if (strchr(ptr, '=') != NULL)
1349 * The stabs aren't in writable memory, so copy it over so we are
1350 * sure we can scribble on it.
1352 if (ptr != stabbuff)
1355 stabbuf_append(&stabbuff, &stabbufflen, ptr);
1358 stab_strcpy(symname, sizeof(symname), ptr);
1359 if (!stabs_parse_typedef(module, ptr, symname))
1361 /* skip this definition */
1372 * These are useless with ELF. They have no value, and you have to
1373 * read the normal symbol table to get the address. Thus we
1374 * ignore them, and when we process the normal symbol table
1375 * we should do the right thing.
1377 * With a.out or mingw, they actually do make some amount of sense.
1379 stab_strcpy(symname, sizeof(symname), ptr);
1380 loc.kind = loc_absolute;
1382 loc.offset = load_offset + stab_ptr->n_value;
1383 symt_new_global_variable(module, compiland, symname, TRUE /* FIXME */,
1384 loc, 0, stabs_parse_type(ptr));
1388 /* These are static symbols and BSS symbols. */
1389 stab_strcpy(symname, sizeof(symname), ptr);
1390 loc.kind = loc_absolute;
1392 loc.offset = load_offset + stab_ptr->n_value;
1393 symt_new_global_variable(module, compiland, symname, TRUE /* FIXME */,
1394 loc, 0, stabs_parse_type(ptr));
1399 block = symt_open_func_block(module, curr_func, block,
1400 stab_ptr->n_value, 0);
1401 pending_flush(&pending_block, module, curr_func, block);
1406 block = symt_close_func_block(module, curr_func, block,
1410 /* These are function parameters. */
1411 if (curr_func != NULL)
1413 struct symt* param_type = stabs_parse_type(ptr);
1414 stab_strcpy(symname, sizeof(symname), ptr);
1415 loc.kind = loc_regrel;
1416 loc.reg = dbghelp_current_cpu->frame_regno;
1417 loc.offset = stab_ptr->n_value;
1418 symt_add_func_local(module, curr_func,
1419 (int)stab_ptr->n_value >= 0 ? DataIsParam : DataIsLocal,
1420 &loc, NULL, param_type, symname);
1421 symt_add_function_signature_parameter(module,
1422 (struct symt_function_signature*)curr_func->type,
1427 /* These are registers (as local variables) */
1428 if (curr_func != NULL)
1430 loc.kind = loc_register;
1433 switch (stab_ptr->n_value)
1435 case 0: loc.reg = CV_REG_EAX; break;
1436 case 1: loc.reg = CV_REG_ECX; break;
1437 case 2: loc.reg = CV_REG_EDX; break;
1438 case 3: loc.reg = CV_REG_EBX; break;
1439 case 4: loc.reg = CV_REG_ESP; break;
1440 case 5: loc.reg = CV_REG_EBP; break;
1441 case 6: loc.reg = CV_REG_ESI; break;
1442 case 7: loc.reg = CV_REG_EDI; break;
1451 case 19: loc.reg = CV_REG_ST0 + stab_ptr->n_value - 12; break;
1459 case 28: loc.reg = CV_REG_XMM0 + stab_ptr->n_value - 21; break;
1467 case 36: loc.reg = CV_REG_MM0 + stab_ptr->n_value - 29; break;
1469 FIXME("Unknown register value (%u)\n", stab_ptr->n_value);
1470 loc.reg = CV_REG_NONE;
1473 stab_strcpy(symname, sizeof(symname), ptr);
1474 if (ptr[strlen(symname) + 1] == 'P')
1476 struct symt* param_type = stabs_parse_type(ptr);
1477 stab_strcpy(symname, sizeof(symname), ptr);
1478 symt_add_func_local(module, curr_func, DataIsParam, &loc,
1479 NULL, param_type, symname);
1480 symt_add_function_signature_parameter(module,
1481 (struct symt_function_signature*)curr_func->type,
1485 pending_add_var(&pending_block, ptr, DataIsLocal, &loc);
1489 /* These are local variables */
1490 loc.kind = loc_regrel;
1491 loc.reg = dbghelp_current_cpu->frame_regno;
1492 loc.offset = stab_ptr->n_value;
1493 if (curr_func != NULL) pending_add_var(&pending_block, ptr, DataIsLocal, &loc);
1497 * This is a line number. These are always relative to the start
1498 * of the function (N_FUN), and this makes the lookup easier.
1500 assert(source_idx >= 0);
1501 if (curr_func != NULL)
1503 unsigned long offset = stab_ptr->n_value;
1504 if (module->type == DMT_MACHO)
1505 offset -= curr_func->address - load_offset;
1506 symt_add_func_line(module, curr_func, source_idx,
1507 stab_ptr->n_desc, offset);
1509 else pending_add_line(&pending_func, source_idx, stab_ptr->n_desc,
1510 stab_ptr->n_value, load_offset);
1514 * For now, just declare the various functions. Later
1515 * on, we will add the line number information and the
1519 * Copy the string to a temp buffer so we
1520 * can kill everything after the ':'. We do
1521 * it this way because otherwise we end up dirtying
1522 * all of the pages related to the stabs, and that
1523 * sucks up swap space like crazy.
1525 stab_strcpy(symname, sizeof(symname), ptr);
1528 struct symt_function_signature* func_type;
1532 /* First, clean up the previous function we were working on.
1533 * Assume size of the func is the delta between current offset
1534 * and offset of last function
1536 stabs_finalize_function(module, curr_func,
1538 (load_offset + stab_ptr->n_value - curr_func->address) : 0);
1540 func_type = symt_new_function_signature(module,
1541 stabs_parse_type(ptr), -1);
1542 curr_func = symt_new_function(module, compiland, symname,
1543 load_offset + stab_ptr->n_value, 0,
1545 pending_flush(&pending_func, module, curr_func, NULL);
1549 /* some versions of GCC to use a N_FUN "" to mark the end of a function
1550 * and n_value contains the size of the func
1552 stabs_finalize_function(module, curr_func, stab_ptr->n_value);
1558 * This indicates a new source file. Append the records
1559 * together, to build the correct path name.
1561 if (*ptr == '\0') /* end of N_SO file */
1563 /* Nuke old path. */
1564 HeapFree(GetProcessHeap(), 0, srcpath);
1566 stabs_finalize_function(module, curr_func, 0);
1570 assert(block == NULL);
1575 int len = strlen(ptr);
1576 if (ptr[len-1] != '/')
1578 stabs_reset_includes();
1579 source_idx = source_new(module, srcpath, ptr);
1580 compiland = symt_new_compiland(module, 0 /* FIXME */, source_idx);
1584 srcpath = HeapAlloc(GetProcessHeap(), 0, len + 1);
1585 strcpy(srcpath, ptr);
1590 source_idx = source_new(module, srcpath, ptr);
1594 strtabinc = stab_ptr->n_value;
1595 /* I'm not sure this is needed, so trace it before we obsolete it */
1598 FIXME("UNDF: curr_func %s\n", curr_func->hash_elt.name);
1599 stabs_finalize_function(module, curr_func, 0); /* FIXME */
1604 /* Ignore this. We don't care what it points to. */
1607 stabs_add_include(stabs_new_include(ptr, stab_ptr->n_value));
1608 assert(incl_stk < (int)(sizeof(incl) / sizeof(incl[0])) - 1);
1609 incl[++incl_stk] = source_idx;
1610 source_idx = source_new(module, NULL, ptr);
1613 assert(incl_stk >= 0);
1614 source_idx = incl[incl_stk--];
1617 if (stabs_add_include(stabs_find_include(ptr, stab_ptr->n_value)) < 0)
1619 ERR("Excluded header not found (%s,%d)\n", ptr, stab_ptr->n_value);
1620 module_reset_debug_info(module);
1626 /* Always ignore these. GCC doesn't even generate them. */
1631 /* Always ignore these, they seem to be used only on Darwin. */
1637 /* FIXME: Other definition types (N_TEXT, N_DATA, N_BSS, ...)? */
1640 BOOL is_public = (stab_ptr->n_type & N_EXT);
1641 BOOL is_global = is_public;
1644 /* "private extern"; shared among compilation units in a shared
1645 * library, but not accessible from outside the library. */
1646 if (stab_ptr->n_type & N_PEXT)
1653 if (*ptr == '_') ptr++;
1654 stab_strcpy(symname, sizeof(symname), ptr);
1656 callback(module, load_offset, symname, stab_ptr->n_value,
1657 is_public, is_global, stab_ptr->n_other, compiland, user);
1661 ERR("Unknown stab type 0x%02x\n", type);
1665 TRACE("0x%02x %x %s\n",
1666 stab_ptr->n_type, stab_ptr->n_value, debugstr_a(strs + stab_ptr->n_strx));
1668 module->module.SymType = SymDia;
1669 module->module.CVSig = 'S' | ('T' << 8) | ('A' << 16) | ('B' << 24);
1670 /* FIXME: we could have a finer grain here */
1671 module->module.LineNumbers = TRUE;
1672 module->module.GlobalSymbols = TRUE;
1673 module->module.TypeInfo = TRUE;
1674 module->module.SourceIndexed = TRUE;
1675 module->module.Publics = TRUE;
1677 HeapFree(GetProcessHeap(), 0, stabbuff);
1678 stabs_free_includes();
1679 HeapFree(GetProcessHeap(), 0, pending_block.objs);
1680 HeapFree(GetProcessHeap(), 0, pending_func.objs);