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
56 #ifdef HAVE_MACH_O_NLIST_H
57 # include <mach-o/nlist.h>
64 #include "dbghelp_private.h"
66 #include "wine/debug.h"
68 WINE_DEFAULT_DEBUG_CHANNEL(dbghelp_stabs);
70 /* Masks for n_type field */
81 /* Values for (n_type & N_TYPE) */
116 struct stab_nlist* n_next;
119 unsigned char n_type;
122 unsigned long n_value;
125 static void stab_strcpy(char* dest, int sz, const char* source)
129 * A strcpy routine that stops when we hit the ':' character.
130 * Faster than copying the whole thing, and then nuking the
132 * Takes also care of (valid) a::b constructs
134 while (*source != '\0')
136 if (source[0] != ':' && sz-- > 0) *ptr++ = *source++;
137 else if (source[1] == ':' && (sz -= 2) > 0)
145 /* GCC emits, in some cases, a .<digit>+ suffix.
146 * This is used for static variable inside functions, so
147 * that we can have several such variables with same name in
148 * the same compilation unit
149 * We simply ignore that suffix when present (we also get rid
150 * of it in ELF symtab parsing)
152 if (ptr >= dest && isdigit(*ptr))
154 while (ptr > dest && isdigit(*ptr)) ptr--;
155 if (*ptr == '.') *ptr = '\0';
164 struct symt** vector;
168 #define MAX_INCLUDES 5120
170 static include_def* include_defs = NULL;
171 static int num_include_def = 0;
172 static int num_alloc_include_def = 0;
173 static int cu_include_stack[MAX_INCLUDES];
174 static int cu_include_stk_idx = 0;
175 static struct symt** cu_vector = NULL;
176 static int cu_nrofentries = 0;
177 static struct symt_basic* stabs_basic[36];
179 static int stabs_new_include(const char* file, unsigned long val)
181 if (num_include_def == num_alloc_include_def)
185 num_alloc_include_def = 256;
186 include_defs = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
187 sizeof(include_defs[0]) * num_alloc_include_def);
191 num_alloc_include_def *= 2;
192 include_defs = HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, include_defs,
193 sizeof(include_defs[0]) * num_alloc_include_def);
196 include_defs[num_include_def].name = strcpy(HeapAlloc(GetProcessHeap(), 0, strlen(file) + 1), file);
197 include_defs[num_include_def].value = val;
198 include_defs[num_include_def].vector = NULL;
199 include_defs[num_include_def].nrofentries = 0;
201 return num_include_def++;
204 static int stabs_find_include(const char* file, unsigned long val)
208 for (i = 0; i < num_include_def; i++)
210 if (val == include_defs[i].value &&
211 strcmp(file, include_defs[i].name) == 0)
217 static int stabs_add_include(int idx)
219 if (idx < 0) return -1;
220 cu_include_stk_idx++;
222 /* if this happens, just bump MAX_INCLUDES */
223 /* we could also handle this as another dynarray */
224 assert(cu_include_stk_idx < MAX_INCLUDES);
225 cu_include_stack[cu_include_stk_idx] = idx;
226 return cu_include_stk_idx;
229 static void stabs_reset_includes(void)
232 * The struct symt:s that we would need to use are reset when
233 * we start a new file. (at least the ones in filenr == 0)
235 cu_include_stk_idx = 0;/* keep 0 as index for the .c file itself */
236 memset(cu_vector, 0, sizeof(cu_vector[0]) * cu_nrofentries);
239 static void stabs_free_includes(void)
243 stabs_reset_includes();
244 for (i = 0; i < num_include_def; i++)
246 HeapFree(GetProcessHeap(), 0, include_defs[i].name);
247 HeapFree(GetProcessHeap(), 0, include_defs[i].vector);
249 HeapFree(GetProcessHeap(), 0, include_defs);
252 num_alloc_include_def = 0;
253 HeapFree(GetProcessHeap(), 0, cu_vector);
258 static struct symt** stabs_find_ref(long filenr, long subnr)
262 /* FIXME: I could perhaps create a dummy include_def for each compilation
263 * unit which would allow not to handle those two cases separately
267 if (cu_nrofentries <= subnr)
269 cu_nrofentries = max( cu_nrofentries * 2, subnr + 1 );
271 cu_vector = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
272 sizeof(cu_vector[0]) * cu_nrofentries);
274 cu_vector = HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
275 cu_vector, sizeof(cu_vector[0]) * cu_nrofentries);
277 ret = &cu_vector[subnr];
283 assert(filenr <= cu_include_stk_idx);
284 idef = &include_defs[cu_include_stack[filenr]];
286 if (idef->nrofentries <= subnr)
288 idef->nrofentries = max( idef->nrofentries * 2, subnr + 1 );
290 idef->vector = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
291 sizeof(idef->vector[0]) * idef->nrofentries);
293 idef->vector = HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
294 idef->vector, sizeof(idef->vector[0]) * idef->nrofentries);
296 ret = &idef->vector[subnr];
298 TRACE("(%ld,%ld) => %p (%p)\n", filenr, subnr, ret, *ret);
302 static struct symt** stabs_read_type_enum(const char** x)
312 filenr = strtol(iter, &end, 10); /* <int> */
313 iter = ++end; /* ',' */
314 subnr = strtol(iter, &end, 10); /* <int> */
315 iter = ++end; /* ')' */
320 subnr = strtol(iter, &end, 10); /* <int> */
324 return stabs_find_ref(filenr, subnr);
328 struct ParseTypedefData
333 struct module* module;
345 static void stabs_pts_push(struct ParseTypedefData* ptd, unsigned line)
347 assert(ptd->err_idx < sizeof(ptd->errors) / sizeof(ptd->errors[0]));
348 ptd->errors[ptd->err_idx].line = line;
349 ptd->errors[ptd->err_idx].ptr = ptd->ptr;
352 #define PTS_ABORTIF(ptd, t) do { if (t) { stabs_pts_push((ptd), __LINE__); return -1;} } while (0)
354 #define PTS_ABORTIF(ptd, t) do { if (t) return -1; } while (0)
357 static int stabs_get_basic(struct ParseTypedefData* ptd, unsigned basic, struct symt** symt)
359 PTS_ABORTIF(ptd, basic >= sizeof(stabs_basic) / sizeof(stabs_basic[0]));
361 if (!stabs_basic[basic])
365 case 1: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "int", 4); break;
366 case 2: stabs_basic[basic] = symt_new_basic(ptd->module, btChar, "char", 1); break;
367 case 3: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "short int", 2); break;
368 case 4: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "long int", 4); break;
369 case 5: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "unsigned char", 1); break;
370 case 6: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "signed char", 1); break;
371 case 7: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "unsigned short int", 2); break;
372 case 8: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "unsigned int", 4); break;
373 case 9: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "unsigned", 2); break;
374 case 10: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "unsigned long int", 2); break;
375 case 11: stabs_basic[basic] = symt_new_basic(ptd->module, btVoid, "void", 0); break;
376 case 12: stabs_basic[basic] = symt_new_basic(ptd->module, btFloat, "float", 4); break;
377 case 13: stabs_basic[basic] = symt_new_basic(ptd->module, btFloat, "double", 8); break;
378 case 14: stabs_basic[basic] = symt_new_basic(ptd->module, btFloat, "long double", 12); break;
379 case 15: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "integer", 4); break;
380 case 16: stabs_basic[basic] = symt_new_basic(ptd->module, btBool, "bool", 1); break;
381 /* case 17: short real */
383 case 25: stabs_basic[basic] = symt_new_basic(ptd->module, btComplex, "float complex", 8); break;
384 case 26: stabs_basic[basic] = symt_new_basic(ptd->module, btComplex, "double complex", 16); break;
385 case 30: stabs_basic[basic] = symt_new_basic(ptd->module, btWChar, "wchar_t", 2); break;
386 case 31: stabs_basic[basic] = symt_new_basic(ptd->module, btInt, "long long int", 8); break;
387 case 32: stabs_basic[basic] = symt_new_basic(ptd->module, btUInt, "long long unsigned", 8); break;
388 /* starting at 35 are wine extensions (especially for R implementation) */
389 case 35: stabs_basic[basic] = symt_new_basic(ptd->module, btComplex, "long double complex", 24); break;
390 default: PTS_ABORTIF(ptd, 1);
393 *symt = &stabs_basic[basic]->symt;
397 static int stabs_pts_read_type_def(struct ParseTypedefData* ptd,
398 const char* typename, struct symt** dt);
400 static int stabs_pts_read_id(struct ParseTypedefData* ptd)
402 const char* first = ptd->ptr;
403 unsigned int template = 0;
406 while ((ch = *ptd->ptr++) != '\0')
413 unsigned int len = ptd->ptr - first - 1;
414 PTS_ABORTIF(ptd, len >= sizeof(ptd->buf) - ptd->idx);
415 memcpy(ptd->buf + ptd->idx, first, len);
416 ptd->buf[ptd->idx + len] = '\0';
421 case '<': template++; break;
422 case '>': PTS_ABORTIF(ptd, template == 0); template--; break;
428 static int stabs_pts_read_number(struct ParseTypedefData* ptd, long* v)
432 *v = strtol(ptd->ptr, &last, 10);
433 PTS_ABORTIF(ptd, last == ptd->ptr);
438 static int stabs_pts_read_type_reference(struct ParseTypedefData* ptd,
439 long* filenr, long* subnr)
441 if (*ptd->ptr == '(')
443 /* '(' <int> ',' <int> ')' */
445 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, filenr) == -1);
446 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
447 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, subnr) == -1);
448 PTS_ABORTIF(ptd, *ptd->ptr++ != ')');
453 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, subnr) == -1);
458 struct pts_range_value
464 static int stabs_pts_read_range_value(struct ParseTypedefData* ptd, struct pts_range_value* prv)
471 while (*ptd->ptr == '0') ptd->ptr++;
472 if (*ptd->ptr >= '1' && *ptd->ptr <= '7')
477 PTS_ABORTIF(ptd, ptd->ptr[0] != '1');
480 while (isdigit(*ptd->ptr)) prv->val = (prv->val << 3) + *ptd->ptr++ - '0';
485 while (isdigit(*ptd->ptr)) prv->val = (prv->val << 3) + *ptd->ptr++ - '0';
487 default: PTS_ABORTIF(ptd, 1); break;
489 } else prv->sign = 0;
493 prv->val = strtoull(++ptd->ptr, &last, 10);
499 prv->val = strtoull(ptd->ptr, &last, 10);
506 static int stabs_pts_read_range(struct ParseTypedefData* ptd, const char* typename,
510 struct pts_range_value lo;
511 struct pts_range_value hi;
517 /* type ';' <int> ';' <int> ';' */
518 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &ref) == -1);
519 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
520 PTS_ABORTIF(ptd, stabs_pts_read_range_value(ptd, &lo) == -1);
521 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
522 PTS_ABORTIF(ptd, stabs_pts_read_range_value(ptd, &hi) == -1);
523 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
525 /* basically, we don't use ref... in some cases, for example, float is declared
526 * as a derived type of int... which won't help us... so we guess the types
527 * from the various formats
529 if (lo.sign == 0 && hi.sign < 0)
534 else if (lo.sign < 0 && hi.sign == 0)
539 else if (lo.sign > 0 && hi.sign == 0)
544 else if (lo.sign < 0 && hi.sign > 0)
547 for (i = 7; i < 64; i += 8)
549 if (lo.val == v && hi.val == v - 1)
557 PTS_ABORTIF(ptd, i >= 64);
559 else if (lo.sign == 0 && hi.sign > 0)
561 if (hi.val == 127) /* specific case for char... */
569 for (i = 8; i <= 64; i += 8)
579 PTS_ABORTIF(ptd, i > 64);
582 else PTS_ABORTIF(ptd, 1);
584 *dt = &symt_new_basic(ptd->module, bt, typename, size)->symt;
588 static inline int stabs_pts_read_method_info(struct ParseTypedefData* ptd)
596 /* get type of return value */
597 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
598 if (*ptd->ptr == ';') ptd->ptr++;
600 /* get types of parameters */
601 if (*ptd->ptr == ':')
603 PTS_ABORTIF(ptd, !(tmp = strchr(ptd->ptr + 1, ';')));
606 PTS_ABORTIF(ptd, !(*ptd->ptr >= '0' && *ptd->ptr <= '9'));
608 PTS_ABORTIF(ptd, !(ptd->ptr[0] >= 'A' && *ptd->ptr <= 'D'));
610 PTS_ABORTIF(ptd, mthd != '.' && mthd != '?' && mthd != '*');
617 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &ofs) == -1);
618 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
619 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
620 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
622 } while (*ptd->ptr != ';');
628 static inline int stabs_pts_read_aggregate(struct ParseTypedefData* ptd,
629 struct symt_udt* sdt)
633 struct symt* dt = NULL;
637 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &sz) == -1);
639 doadd = symt_set_udt_size(ptd->module, sdt, sz);
640 if (*ptd->ptr == '!') /* C++ inheritence */
645 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &num_classes) == -1);
646 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
647 while (--num_classes >= 0)
649 ptd->ptr += 2; /* skip visibility and inheritence */
650 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &ofs) == -1);
651 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
653 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &adt) == -1);
660 strcpy(tmp, "__inherited_class_");
661 strcat(tmp, symt_get_name(adt));
663 /* FIXME: TI_GET_LENGTH will not always work, especially when adt
664 * has just been seen as a forward definition and not the real stuff
666 * As we don't use much the size of members in structs, this may not
667 * be much of a problem
669 symt_get_info(adt, TI_GET_LENGTH, &size);
670 symt_add_udt_element(ptd->module, sdt, tmp, adt, ofs, (DWORD)size * 8);
672 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
676 /* if the structure has already been filled, just redo the parsing
677 * but don't store results into the struct
678 * FIXME: there's a quite ugly memory leak in there...
681 /* Now parse the individual elements of the structure/union. */
682 while (*ptd->ptr != ';')
684 /* agg_name : type ',' <int:offset> ',' <int:size> */
687 if (ptd->ptr[0] == '$' && ptd->ptr[1] == 'v')
691 if (ptd->ptr[2] == 'f')
693 /* C++ virtual method table */
695 stabs_read_type_enum(&ptd->ptr);
696 PTS_ABORTIF(ptd, *ptd->ptr++ != ':');
697 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
698 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
699 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &x) == -1);
700 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
704 else if (ptd->ptr[2] == 'b')
707 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
708 PTS_ABORTIF(ptd, *ptd->ptr++ != ':');
709 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
710 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
711 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &x) == -1);
712 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
718 PTS_ABORTIF(ptd, stabs_pts_read_id(ptd) == -1);
719 /* Ref. TSDF R2.130 Section 7.4. When the field name is a method name
720 * it is followed by two colons rather than one.
722 if (*ptd->ptr == ':')
725 stabs_pts_read_method_info(ptd);
731 /* skip C++ member protection /0 /1 or /2 */
732 if (*ptd->ptr == '/') ptd->ptr += 2;
734 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &adt) == -1);
739 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &ofs) == -1);
740 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
741 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &sz) == -1);
742 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
744 if (doadd) symt_add_udt_element(ptd->module, sdt, ptd->buf + idx, adt, ofs, sz);
749 /* method parameters... terminated by ';' */
750 PTS_ABORTIF(ptd, !(tmp = strchr(ptd->ptr, ';')));
755 PTS_ABORTIF(ptd, TRUE);
759 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
760 if (*ptd->ptr == '~')
763 PTS_ABORTIF(ptd, *ptd->ptr++ != '%');
764 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &dt) == -1);
765 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
770 static inline int stabs_pts_read_enum(struct ParseTypedefData* ptd,
771 struct symt_enum* edt)
776 while (*ptd->ptr != ';')
779 PTS_ABORTIF(ptd, stabs_pts_read_id(ptd) == -1);
780 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &value) == -1);
781 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
782 symt_add_enum_element(ptd->module, edt, ptd->buf + idx, value);
789 static inline int stabs_pts_read_array(struct ParseTypedefData* ptd,
793 struct symt* range_dt;
794 struct symt* base_dt;
796 /* ar<typeinfo_nodef>;<int>;<int>;<typeinfo> */
798 PTS_ABORTIF(ptd, *ptd->ptr++ != 'r');
800 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &range_dt) == -1);
801 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
802 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &lo) == -1);
803 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
804 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &hi) == -1);
805 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
807 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &base_dt) == -1);
809 *adt = &symt_new_array(ptd->module, lo, hi, base_dt, range_dt)->symt;
813 static int stabs_pts_read_type_def(struct ParseTypedefData* ptd, const char* typename,
814 struct symt** ret_dt)
818 struct symt* new_dt = NULL; /* newly created data type */
819 struct symt* ref_dt; /* referenced data type (pointer...) */
820 long filenr1, subnr1, tmp;
822 /* things are a bit complicated because of the way the typedefs are stored inside
823 * the file, because addresses can change when realloc is done, so we must call
824 * over and over stabs_find_ref() to keep the correct values around
826 PTS_ABORTIF(ptd, stabs_pts_read_type_reference(ptd, &filenr1, &subnr1) == -1);
828 while (*ptd->ptr == '=')
831 PTS_ABORTIF(ptd, new_dt != NULL);
833 /* first handle attribute if any */
837 if (*++ptd->ptr == 's')
840 if (stabs_pts_read_number(ptd, &sz) == -1)
842 ERR("Not an attribute... NIY\n");
846 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
850 /* then the real definitions */
855 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &ref_dt) == -1);
856 new_dt = &symt_new_pointer(ptd->module, ref_dt)->symt;
858 case 'k': /* 'const' modifier */
859 case 'B': /* 'volatile' modifier */
860 /* just kinda ignore the modifier, I guess -gmt */
861 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, typename, &new_dt) == -1);
865 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, typename, &new_dt) == -1);
868 PTS_ABORTIF(ptd, stabs_pts_read_array(ptd, &new_dt) == -1);
871 PTS_ABORTIF(ptd, stabs_pts_read_range(ptd, typename, &new_dt) == -1);
872 assert(!*stabs_find_ref(filenr1, subnr1));
873 *stabs_find_ref(filenr1, subnr1) = new_dt;
876 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &ref_dt) == -1);
877 new_dt = &symt_new_function_signature(ptd->module, ref_dt, -1)->symt;
880 stabs_get_basic(ptd, 1 /* int */, &ref_dt);
881 new_dt = &symt_new_enum(ptd->module, typename, ref_dt)->symt;
882 PTS_ABORTIF(ptd, stabs_pts_read_enum(ptd, (struct symt_enum*)new_dt) == -1);
887 struct symt_udt* udt;
888 enum UdtKind kind = (ptd->ptr[-1] == 's') ? UdtStruct : UdtUnion;
889 /* udt can have been already defined in a forward definition */
890 udt = (struct symt_udt*)*stabs_find_ref(filenr1, subnr1);
893 udt = symt_new_udt(ptd->module, typename, 0, kind);
894 /* we need to set it here, because a struct can hold a pointer
897 new_dt = *stabs_find_ref(filenr1, subnr1) = &udt->symt;
902 if (udt->symt.tag != SymTagUDT)
904 ERR("Forward declaration (%p/%s) is not an aggregate (%u)\n",
905 udt, symt_get_name(&udt->symt), udt->symt.tag);
908 /* FIXME: we currently don't correctly construct nested C++
909 * classes names. Therefore, we could be here with either:
910 * - typename and udt->hash_elt.name being the same string
911 * (non embedded case)
912 * - typename being foo::bar while udt->hash_elt.name being
914 * So, we twist the comparison to test both occurrences. When
915 * we have proper C++ types in this file, this twist has to be
918 l1 = strlen(udt->hash_elt.name);
919 l2 = strlen(typename);
920 if (l1 > l2 || strcmp(udt->hash_elt.name, typename + l2 - l1))
921 ERR("Forward declaration name mismatch %s <> %s\n",
922 udt->hash_elt.name, typename);
925 PTS_ABORTIF(ptd, stabs_pts_read_aggregate(ptd, udt) == -1);
931 PTS_ABORTIF(ptd, stabs_pts_read_id(ptd) == -1);
935 stabs_get_basic(ptd, 1 /* int */, &ref_dt);
936 new_dt = &symt_new_enum(ptd->module, ptd->buf + idx, ref_dt)->symt;
939 new_dt = &symt_new_udt(ptd->module, ptd->buf + idx, 0, UdtStruct)->symt;
942 new_dt = &symt_new_udt(ptd->module, ptd->buf + idx, 0, UdtUnion)->symt;
951 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &tmp) == -1);
952 PTS_ABORTIF(ptd, stabs_get_basic(ptd, tmp, &new_dt) == -1);
953 PTS_ABORTIF(ptd, *ptd->ptr++ != ';');
957 if (*ptd->ptr == '#')
960 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &ref_dt) == -1);
961 new_dt = &symt_new_function_signature(ptd->module, ref_dt, -1)->symt;
968 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &cls_dt) == -1);
969 PTS_ABORTIF(ptd, *ptd->ptr++ != ',');
970 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &ref_dt) == -1);
971 new_dt = &symt_new_function_signature(ptd->module, ref_dt, -1)->symt;
972 while (*ptd->ptr == ',')
975 PTS_ABORTIF(ptd, stabs_pts_read_type_def(ptd, NULL, &pmt_dt) == -1);
984 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &type) == -1);
985 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
986 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &len) == -1);
987 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
988 PTS_ABORTIF(ptd, stabs_pts_read_number(ptd, &unk) == -1);
989 PTS_ABORTIF(ptd, *ptd->ptr++ != ';'); /* ';' */
991 switch (type) /* see stabs_get_basic for the details */
993 case 1: basic = 12; break;
994 case 2: basic = 13; break;
995 case 3: basic = 25; break;
996 case 4: basic = 26; break;
997 case 5: basic = 35; break;
998 case 6: basic = 14; break;
999 default: PTS_ABORTIF(ptd, 1);
1001 PTS_ABORTIF(ptd, stabs_get_basic(ptd, basic, &new_dt) == -1);
1005 ERR("Unknown type '%c'\n", ptd->ptr[-1]);
1012 /* is it a forward declaration that has been filled ? */
1013 new_dt = *stabs_find_ref(filenr1, subnr1);
1014 /* if not, this should be void (which is defined as a ref to itself, but we
1015 * don't correctly catch it)
1017 if (!new_dt && typename)
1019 new_dt = &symt_new_basic(ptd->module, btVoid, typename, 0)->symt;
1020 PTS_ABORTIF(ptd, strcmp(typename, "void"));
1024 *stabs_find_ref(filenr1, subnr1) = *ret_dt = new_dt;
1026 TRACE("Adding (%ld,%ld) %s\n", filenr1, subnr1, debugstr_a(typename));
1031 static int stabs_parse_typedef(struct module* module, const char* ptr,
1032 const char* typename)
1034 struct ParseTypedefData ptd;
1038 /* check for already existing definition */
1040 TRACE("%s => %s\n", typename, debugstr_a(ptr));
1041 ptd.module = module;
1046 for (ptd.ptr = ptr - 1; ;)
1048 ptd.ptr = strchr(ptd.ptr + 1, ':');
1049 if (ptd.ptr == NULL || *++ptd.ptr != ':') break;
1053 if (*ptd.ptr != '(') ptd.ptr++;
1054 /* most of type definitions take one char, except Tt */
1055 if (*ptd.ptr != '(') ptd.ptr++;
1056 ret = stabs_pts_read_type_def(&ptd, typename, &dt);
1059 if (ret == -1 || *ptd.ptr)
1063 TRACE("Failure on %s\n", debugstr_a(ptr));
1066 for (i = 0; i < ptd.err_idx; i++)
1068 TRACE("[%d]: line %d => %s\n",
1069 i, ptd.errors[i].line, debugstr_a(ptd.errors[i].ptr));
1073 TRACE("[0]: => %s\n", debugstr_a(ptd.ptr));
1076 ERR("Failure on %s at %s\n", debugstr_a(ptr), debugstr_a(ptd.ptr));
1084 static struct symt* stabs_parse_type(const char* stab)
1086 const char* c = stab - 1;
1089 * Look through the stab definition, and figure out what struct symt
1090 * this represents. If we have something we know about, assign the
1092 * According to "The \"stabs\" debug format" (Rev 2.130) the name may be
1093 * a C++ name and contain double colons e.g. foo::bar::baz:t5=*6.
1097 if ((c = strchr(c + 1, ':')) == NULL) return NULL;
1098 } while (*++c == ':');
1101 * The next characters say more about the type (i.e. data, function, etc)
1102 * of symbol. Skip them. (C++ for example may have Tt).
1103 * Actually this is a very weak description; I think Tt is the only
1104 * multiple combination we should see.
1106 while (*c && *c != '(' && !isdigit(*c))
1109 * The next is either an integer or a (integer,integer).
1110 * The stabs_read_type_enum() takes care that stab_types is large enough.
1112 return *stabs_read_type_enum(&c);
1115 enum pending_obj_kind
1121 struct pending_loc_var
1126 struct location loc;
1133 unsigned long offset;
1134 unsigned long load_offset;
1137 struct pending_object
1139 enum pending_obj_kind tag;
1141 struct pending_loc_var var;
1142 struct pending_line line;
1148 struct pending_object* objs;
1153 static inline void pending_make_room(struct pending_list* pending)
1155 if (pending->num == pending->allocated)
1159 pending->allocated = 8;
1160 pending->objs = HeapAlloc(GetProcessHeap(), 0,
1161 pending->allocated * sizeof(pending->objs[0]));
1165 pending->allocated *= 2;
1166 pending->objs = HeapReAlloc(GetProcessHeap(), 0, pending->objs,
1167 pending->allocated * sizeof(pending->objs[0]));
1172 static inline void pending_add_var(struct pending_list* pending, const char* name,
1173 enum DataKind dt, const struct location* loc)
1175 pending_make_room(pending);
1176 pending->objs[pending->num].tag = PENDING_VAR;
1177 stab_strcpy(pending->objs[pending->num].u.var.name,
1178 sizeof(pending->objs[pending->num].u.var.name), name);
1179 pending->objs[pending->num].u.var.type = stabs_parse_type(name);
1180 pending->objs[pending->num].u.var.kind = dt;
1181 pending->objs[pending->num].u.var.loc = *loc;
1185 static inline void pending_add_line(struct pending_list* pending, int source_idx,
1186 int line_num, unsigned long offset,
1187 unsigned long load_offset)
1189 pending_make_room(pending);
1190 pending->objs[pending->num].tag = PENDING_LINE;
1191 pending->objs[pending->num].u.line.source_idx = source_idx;
1192 pending->objs[pending->num].u.line.line_num = line_num;
1193 pending->objs[pending->num].u.line.offset = offset;
1194 pending->objs[pending->num].u.line.load_offset = load_offset;
1198 static void pending_flush(struct pending_list* pending, struct module* module,
1199 struct symt_function* func, struct symt_block* block)
1203 for (i = 0; i < pending->num; i++)
1205 switch (pending->objs[i].tag)
1208 symt_add_func_local(module, func,
1209 pending->objs[i].u.var.kind, &pending->objs[i].u.var.loc,
1210 block, pending->objs[i].u.var.type, pending->objs[i].u.var.name);
1213 if (module->type == DMT_MACHO)
1214 pending->objs[i].u.line.offset -= func->address - pending->objs[i].u.line.load_offset;
1215 symt_add_func_line(module, func, pending->objs[i].u.line.source_idx,
1216 pending->objs[i].u.line.line_num, pending->objs[i].u.line.offset);
1219 ERR("Unknown pending object tag %u\n", (unsigned)pending->objs[i].tag);
1226 /******************************************************************
1227 * stabs_finalize_function
1229 * Ends function creation: mainly:
1230 * - cleans up line number information
1231 * - tries to set up a debug-start tag (FIXME: heuristic to be enhanced)
1232 * - for stabs which have absolute address in them, initializes the size of the
1233 * function (assuming that current function ends where next function starts)
1235 static void stabs_finalize_function(struct module* module, struct symt_function* func,
1239 struct location loc;
1242 symt_normalize_function(module, func);
1243 /* To define the debug-start of the function, we use the second line number.
1244 * Not 100% bullet proof, but better than nothing
1246 if (symt_fill_func_line_info(module, func, func->address, &il) &&
1247 symt_get_func_line_next(module, &il))
1249 loc.kind = loc_absolute;
1250 loc.offset = il.Address - func->address;
1251 symt_add_function_point(module, func, SymTagFuncDebugStart,
1254 if (size) func->size = size;
1257 static inline void stabbuf_append(char **buf, unsigned *buf_size, const char *str)
1259 unsigned str_len, buf_len;
1261 str_len = strlen(str);
1262 buf_len = strlen(*buf);
1264 if(str_len+buf_len >= *buf_size) {
1265 *buf_size += buf_len + str_len;
1266 *buf = HeapReAlloc(GetProcessHeap(), 0, *buf, *buf_size);
1269 strcpy(*buf+buf_len, str);
1272 BOOL stabs_parse(struct module* module, unsigned long load_offset,
1273 const void* pv_stab_ptr, int stablen,
1274 const char* strs, int strtablen,
1275 stabs_def_cb callback, void* user)
1277 struct symt_function* curr_func = NULL;
1278 struct symt_block* block = NULL;
1279 struct symt_compiland* compiland = NULL;
1280 char srcpath[PATH_MAX]; /* path to directory source file is in */
1285 unsigned int stabbufflen;
1286 const struct stab_nlist* stab_ptr = pv_stab_ptr;
1287 const char* strs_end;
1292 int source_idx = -1;
1293 struct pending_list pending_block;
1294 struct pending_list pending_func;
1296 struct location loc;
1299 nstab = stablen / sizeof(struct stab_nlist);
1300 strs_end = strs + strtablen;
1302 memset(srcpath, 0, sizeof(srcpath));
1303 memset(stabs_basic, 0, sizeof(stabs_basic));
1304 memset(&pending_block, 0, sizeof(pending_block));
1305 memset(&pending_func, 0, sizeof(pending_func));
1308 * Allocate a buffer into which we can build stab strings for cases
1309 * where the stab is continued over multiple lines.
1311 stabbufflen = 65536;
1312 stabbuff = HeapAlloc(GetProcessHeap(), 0, stabbufflen);
1316 for (i = 0; i < nstab; i++, stab_ptr++)
1318 ptr = strs + stab_ptr->n_un.n_strx;
1319 if ((ptr > strs_end) || (ptr + strlen(ptr) > strs_end))
1321 WARN("Bad stabs string %p\n", ptr);
1324 if (*ptr != '\0' && (ptr[strlen(ptr) - 1] == '\\'))
1327 * Indicates continuation. Append this to the buffer, and go onto the
1328 * next record. Repeat the process until we find a stab without the
1329 * '/' character, as this indicates we have the whole thing.
1331 stabbuf_append(&stabbuff, &stabbufflen, ptr);
1334 else if (stabbuff[0] != '\0')
1336 stabbuf_append(&stabbuff, &stabbufflen, ptr);
1340 if (stab_ptr->n_type & N_STAB)
1341 type = stab_ptr->n_type;
1343 type = (stab_ptr->n_type & N_TYPE);
1345 /* only symbol entries contain a typedef */
1355 if (strchr(ptr, '=') != NULL)
1358 * The stabs aren't in writable memory, so copy it over so we are
1359 * sure we can scribble on it.
1361 if (ptr != stabbuff)
1364 stabbuf_append(&stabbuff, &stabbufflen, ptr);
1367 stab_strcpy(symname, sizeof(symname), ptr);
1368 if (!stabs_parse_typedef(module, ptr, symname))
1370 /* skip this definition */
1381 * These are useless with ELF. They have no value, and you have to
1382 * read the normal symbol table to get the address. Thus we
1383 * ignore them, and when we process the normal symbol table
1384 * we should do the right thing.
1386 * With a.out or mingw, they actually do make some amount of sense.
1388 stab_strcpy(symname, sizeof(symname), ptr);
1389 symt_new_global_variable(module, compiland, symname, TRUE /* FIXME */,
1390 load_offset + stab_ptr->n_value, 0,
1391 stabs_parse_type(ptr));
1395 /* These are static symbols and BSS symbols. */
1396 stab_strcpy(symname, sizeof(symname), ptr);
1397 symt_new_global_variable(module, compiland, symname, TRUE /* FIXME */,
1398 load_offset + stab_ptr->n_value, 0,
1399 stabs_parse_type(ptr));
1404 block = symt_open_func_block(module, curr_func, block,
1405 stab_ptr->n_value, 0);
1406 pending_flush(&pending_block, module, curr_func, block);
1411 block = symt_close_func_block(module, curr_func, block,
1415 /* These are function parameters. */
1416 if (curr_func != NULL)
1418 struct symt* param_type = stabs_parse_type(ptr);
1419 stab_strcpy(symname, sizeof(symname), ptr);
1420 loc.kind = loc_regrel;
1421 loc.reg = 0; /* FIXME */
1422 loc.offset = stab_ptr->n_value;
1423 symt_add_func_local(module, curr_func,
1424 (long)stab_ptr->n_value >= 0 ? DataIsParam : DataIsLocal,
1425 &loc, NULL, param_type, symname);
1426 symt_add_function_signature_parameter(module,
1427 (struct symt_function_signature*)curr_func->type,
1432 /* These are registers (as local variables) */
1433 if (curr_func != NULL)
1435 loc.kind = loc_register;
1438 switch (stab_ptr->n_value)
1440 case 0: loc.reg = CV_REG_EAX; break;
1441 case 1: loc.reg = CV_REG_ECX; break;
1442 case 2: loc.reg = CV_REG_EDX; break;
1443 case 3: loc.reg = CV_REG_EBX; break;
1444 case 4: loc.reg = CV_REG_ESP; break;
1445 case 5: loc.reg = CV_REG_EBP; break;
1446 case 6: loc.reg = CV_REG_ESI; break;
1447 case 7: loc.reg = CV_REG_EDI; break;
1456 case 19: loc.reg = CV_REG_ST0 + stab_ptr->n_value - 12; break;
1464 case 28: loc.reg = CV_REG_XMM0 + stab_ptr->n_value - 21; break;
1472 case 36: loc.reg = CV_REG_MM0 + stab_ptr->n_value - 29; break;
1474 FIXME("Unknown register value (%lu)\n", stab_ptr->n_value);
1475 loc.reg = CV_REG_NONE;
1478 stab_strcpy(symname, sizeof(symname), ptr);
1479 if (ptr[strlen(symname) + 1] == 'P')
1481 struct symt* param_type = stabs_parse_type(ptr);
1482 stab_strcpy(symname, sizeof(symname), ptr);
1483 symt_add_func_local(module, curr_func, DataIsParam, &loc,
1484 NULL, param_type, symname);
1485 symt_add_function_signature_parameter(module,
1486 (struct symt_function_signature*)curr_func->type,
1490 pending_add_var(&pending_block, ptr, DataIsLocal, &loc);
1494 /* These are local variables */
1495 loc.kind = loc_regrel;
1496 loc.reg = 0; /* FIXME */
1497 loc.offset = stab_ptr->n_value;
1498 if (curr_func != NULL) pending_add_var(&pending_block, ptr, DataIsLocal, &loc);
1502 * This is a line number. These are always relative to the start
1503 * of the function (N_FUN), and this makes the lookup easier.
1505 assert(source_idx >= 0);
1506 if (curr_func != NULL)
1508 unsigned long offset = stab_ptr->n_value;
1509 if (module->type == DMT_MACHO)
1510 offset -= curr_func->address - load_offset;
1511 symt_add_func_line(module, curr_func, source_idx,
1512 stab_ptr->n_desc, offset);
1514 else pending_add_line(&pending_func, source_idx, stab_ptr->n_desc,
1515 stab_ptr->n_value, load_offset);
1519 * For now, just declare the various functions. Later
1520 * on, we will add the line number information and the
1524 * Copy the string to a temp buffer so we
1525 * can kill everything after the ':'. We do
1526 * it this way because otherwise we end up dirtying
1527 * all of the pages related to the stabs, and that
1528 * sucks up swap space like crazy.
1530 stab_strcpy(symname, sizeof(symname), ptr);
1533 struct symt_function_signature* func_type;
1537 /* First, clean up the previous function we were working on.
1538 * Assume size of the func is the delta between current offset
1539 * and offset of last function
1541 stabs_finalize_function(module, curr_func,
1543 (load_offset + stab_ptr->n_value - curr_func->address) : 0);
1545 func_type = symt_new_function_signature(module,
1546 stabs_parse_type(ptr), -1);
1547 curr_func = symt_new_function(module, compiland, symname,
1548 load_offset + stab_ptr->n_value, 0,
1550 pending_flush(&pending_func, module, curr_func, NULL);
1554 /* some versions of GCC to use a N_FUN "" to mark the end of a function
1555 * and n_value contains the size of the func
1557 stabs_finalize_function(module, curr_func, stab_ptr->n_value);
1563 * This indicates a new source file. Append the records
1564 * together, to build the correct path name.
1566 if (*ptr == '\0') /* end of N_SO file */
1568 /* Nuke old path. */
1570 stabs_finalize_function(module, curr_func, 0);
1574 assert(block == NULL);
1579 int len = strlen(ptr);
1580 if (ptr[len-1] != '/')
1582 stabs_reset_includes();
1583 source_idx = source_new(module, srcpath, ptr);
1584 compiland = symt_new_compiland(module, 0 /* FIXME */, source_idx);
1587 strcpy(srcpath, ptr);
1591 source_idx = source_new(module, srcpath, ptr);
1595 strtabinc = stab_ptr->n_value;
1596 /* I'm not sure this is needed, so trace it before we obsolete it */
1599 FIXME("UNDF: curr_func %s\n", curr_func->hash_elt.name);
1600 stabs_finalize_function(module, curr_func, 0); /* FIXME */
1605 /* Ignore this. We don't care what it points to. */
1608 stabs_add_include(stabs_new_include(ptr, stab_ptr->n_value));
1609 assert(incl_stk < (int)(sizeof(incl) / sizeof(incl[0])) - 1);
1610 incl[++incl_stk] = source_idx;
1611 source_idx = source_new(module, NULL, ptr);
1614 assert(incl_stk >= 0);
1615 source_idx = incl[incl_stk--];
1618 if (stabs_add_include(stabs_find_include(ptr, stab_ptr->n_value)) < 0)
1620 ERR("Excluded header not found (%s,%ld)\n", ptr, stab_ptr->n_value);
1621 module_reset_debug_info(module);
1627 /* Always ignore these. GCC doesn't even generate them. */
1632 /* Always ignore these, they seem to be used only on Darwin. */
1638 /* FIXME: Other definition types (N_TEXT, N_DATA, N_BSS, ...)? */
1641 BOOL is_public = (stab_ptr->n_type & N_EXT);
1642 BOOL is_global = is_public;
1645 /* "private extern"; shared among compilation units in a shared
1646 * library, but not accessible from outside the library. */
1647 if (stab_ptr->n_type & N_PEXT)
1654 if (*ptr == '_') ptr++;
1655 stab_strcpy(symname, sizeof(symname), ptr);
1657 callback(module, load_offset, symname, stab_ptr->n_value,
1658 is_public, is_global, stab_ptr->n_other, compiland, user);
1662 ERR("Unknown stab type 0x%02x\n", type);
1666 TRACE("0x%02x %lx %s\n",
1667 stab_ptr->n_type, stab_ptr->n_value, debugstr_a(strs + stab_ptr->n_un.n_strx));
1669 module->module.SymType = SymDia;
1670 module->module.CVSig = 'S' | ('T' << 8) | ('A' << 16) | ('B' << 24);
1671 /* FIXME: we could have a finer grain here */
1672 module->module.LineNumbers = TRUE;
1673 module->module.GlobalSymbols = TRUE;
1674 module->module.TypeInfo = TRUE;
1675 module->module.SourceIndexed = TRUE;
1676 module->module.Publics = TRUE;
1678 HeapFree(GetProcessHeap(), 0, stabbuff);
1679 stabs_free_includes();
1680 HeapFree(GetProcessHeap(), 0, pending_block.objs);
1681 HeapFree(GetProcessHeap(), 0, pending_func.objs);