1 /* -*- tab-width: 8; c-basic-offset: 4 -*- */
4 * File stabs.c - read stabs information from the wine executable itself.
6 * Copyright (C) 1996, Eric Youngdale.
7 * 1999, 2000 Eric Pouech
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 * Maintenance Information
25 * -----------------------
27 * For documentation on the stabs format see for example
28 * The "stabs" debug format
29 * by Julia Menapace, Jim Kingdon, David Mackenzie
31 * available (hopefully) from http:\\sources.redhat.com\gdb\onlinedocs
36 #include <sys/types.h>
39 #ifdef HAVE_SYS_MMAN_H
47 #define PATH_MAX MAX_PATH
52 #if defined(__svr4__) || defined(__sun)
63 #ifdef HAVE_SYS_LINK_H
64 # include <sys/link.h>
95 typedef struct tagELF_DBG_INFO
97 unsigned long elf_addr;
103 struct stab_nlist *n_next;
106 unsigned char n_type;
109 unsigned long n_value;
112 static void stab_strcpy(char * dest, int sz, const char * source)
115 * A strcpy routine that stops when we hit the ':' character.
116 * Faster than copying the whole thing, and then nuking the
119 while(*source != '\0' && *source != ':' && sz-- > 0)
129 struct datatype** vector;
133 #define MAX_INCLUDES 5120
135 static include_def* include_defs = NULL;
136 static int num_include_def = 0;
137 static int num_alloc_include_def = 0;
138 static int cu_include_stack[MAX_INCLUDES];
139 static int cu_include_stk_idx = 0;
140 static struct datatype** cu_vector = NULL;
141 static int cu_nrofentries = 0;
145 DEBUG_CreateInclude(const char* file, unsigned long val)
147 if (num_include_def == num_alloc_include_def)
149 num_alloc_include_def += 256;
150 include_defs = DBG_realloc(include_defs, sizeof(include_defs[0])*num_alloc_include_def);
151 memset(include_defs+num_include_def, 0, sizeof(include_defs[0])*256);
153 include_defs[num_include_def].name = DBG_strdup(file);
154 include_defs[num_include_def].value = val;
155 include_defs[num_include_def].vector = NULL;
156 include_defs[num_include_def].nrofentries = 0;
158 return num_include_def++;
163 DEBUG_FindInclude(const char* file, unsigned long val)
167 for (i = 0; i < num_include_def; i++)
169 if (val == include_defs[i].value &&
170 strcmp(file, include_defs[i].name) == 0)
178 DEBUG_AddInclude(int idx)
180 ++cu_include_stk_idx;
182 /* is this happen, just bump MAX_INCLUDES */
183 /* we could also handle this as another dynarray */
184 assert(cu_include_stk_idx < MAX_INCLUDES);
186 cu_include_stack[cu_include_stk_idx] = idx;
187 return cu_include_stk_idx;
192 DEBUG_ResetIncludes(void)
195 * The datatypes that we would need to use are reset when
196 * we start a new file. (at least the ones in filenr == 0
198 cu_include_stk_idx = 0;/* keep 0 as index for the .c file itself */
199 memset(cu_vector, 0, sizeof(cu_vector[0]) * cu_nrofentries);
204 DEBUG_FreeIncludes(void)
208 DEBUG_ResetIncludes();
210 for (i = 0; i < num_include_def; i++)
212 DBG_free(include_defs[i].name);
213 DBG_free(include_defs[i].vector);
215 DBG_free(include_defs);
218 num_alloc_include_def = 0;
226 DEBUG_FileSubNr2StabEnum(int filenr, int subnr)
228 struct datatype** ret;
230 /* DEBUG_Printf(DBG_CHN_MESG, "creating type id for (%d,%d)\n", filenr, subnr); */
232 /* FIXME: I could perhaps create a dummy include_def for each compilation
233 * unit which would allow not to handle those two cases separately
237 if (cu_nrofentries <= subnr)
239 cu_vector = DBG_realloc(cu_vector, sizeof(cu_vector[0])*(subnr+1));
240 memset(cu_vector+cu_nrofentries, 0, sizeof(cu_vector[0])*(subnr+1-cu_nrofentries));
241 cu_nrofentries = subnr + 1;
243 ret = &cu_vector[subnr];
249 assert(filenr <= cu_include_stk_idx);
251 idef = &include_defs[cu_include_stack[filenr]];
253 if (idef->nrofentries <= subnr)
255 idef->vector = DBG_realloc(idef->vector, sizeof(idef->vector[0])*(subnr+1));
256 memset(idef->vector + idef->nrofentries, 0, sizeof(idef->vector[0])*(subnr+1-idef->nrofentries));
257 idef->nrofentries = subnr + 1;
259 ret = &idef->vector[subnr];
261 /* DEBUG_Printf(DBG_CHN_MESG,"(%d,%d) is %d\n",filenr,subnr,ret); */
267 DEBUG_ReadTypeEnum(char **x) {
272 filenr=strtol(*x,x,10); /* <int> */
274 subnr=strtol(*x,x,10); /* <int> */
278 subnr = strtol(*x,x,10); /* <int> */
280 return DEBUG_FileSubNr2StabEnum(filenr,subnr);
283 struct ParseTypedefData {
289 static int DEBUG_PTS_ReadTypedef(struct ParseTypedefData* ptd, const char* typename,
290 struct datatype** dt);
292 static int DEBUG_PTS_ReadID(struct ParseTypedefData* ptd)
294 char* first = ptd->ptr;
297 if ((ptd->ptr = strchr(ptd->ptr, ':')) == NULL) return -1;
298 len = ptd->ptr - first;
299 if (len >= sizeof(ptd->buf) - ptd->idx) return -1;
300 memcpy(ptd->buf + ptd->idx, first, len);
301 ptd->buf[ptd->idx + len] = '\0';
303 ptd->ptr++; /* ':' */
307 static int DEBUG_PTS_ReadNum(struct ParseTypedefData* ptd, int* v)
311 *v = strtol(ptd->ptr, &last, 10);
312 if (last == ptd->ptr) return -1;
317 static int DEBUG_PTS_ReadTypeReference(struct ParseTypedefData* ptd,
318 int* filenr, int* subnr)
320 if (*ptd->ptr == '(') {
321 /* '(' <int> ',' <int> ')' */
323 if (DEBUG_PTS_ReadNum(ptd, filenr) == -1) return -1;
324 if (*ptd->ptr++ != ',') return -1;
325 if (DEBUG_PTS_ReadNum(ptd, subnr) == -1) return -1;
326 if (*ptd->ptr++ != ')') return -1;
329 if (DEBUG_PTS_ReadNum(ptd, subnr) == -1) return -1;
334 static int DEBUG_PTS_ReadRange(struct ParseTypedefData* ptd, struct datatype** dt,
337 /* type ';' <int> ';' <int> ';' */
338 if (DEBUG_PTS_ReadTypedef(ptd, NULL, dt) == -1) return -1;
339 if (*ptd->ptr++ != ';') return -1; /* ';' */
340 if (DEBUG_PTS_ReadNum(ptd, lo) == -1) return -1;
341 if (*ptd->ptr++ != ';') return -1; /* ';' */
342 if (DEBUG_PTS_ReadNum(ptd, hi) == -1) return -1;
343 if (*ptd->ptr++ != ';') return -1; /* ';' */
347 static inline int DEBUG_PTS_ReadAggregate(struct ParseTypedefData* ptd, struct datatype* sdt)
351 struct datatype* adt;
355 sz = strtol(ptd->ptr, &last, 10);
356 if (last == ptd->ptr) return -1;
359 doadd = DEBUG_SetStructSize(sdt, sz);
360 /* if the structure has already been filled, just redo the parsing
361 * but don't store results into the struct
362 * FIXME: there's a quite ugly memory leak in there...
365 /* Now parse the individual elements of the structure/union. */
366 while (*ptd->ptr != ';') {
367 /* agg_name : type ',' <int:offset> ',' <int:size> */
369 if (DEBUG_PTS_ReadID(ptd) == -1) return -1;
370 /* Ref. TSDF R2.130 Section 7.4. When the field name is a method name
371 * it is followed by two colons rather than one.
373 if (*ptd->ptr == ':') ptd->ptr++;
375 if (DEBUG_PTS_ReadTypedef(ptd, NULL, &adt) == -1) return -1;
378 if (*ptd->ptr++ != ',') return -1;
379 if (DEBUG_PTS_ReadNum(ptd, &ofs) == -1) return -1;
380 if (*ptd->ptr++ != ',') return -1;
381 if (DEBUG_PTS_ReadNum(ptd, &sz) == -1) return -1;
382 if (*ptd->ptr++ != ';') return -1;
384 if (doadd) DEBUG_AddStructElement(sdt, ptd->buf + idx, adt, ofs, sz);
387 ptd->ptr++; /* ';' */
391 static inline int DEBUG_PTS_ReadEnum(struct ParseTypedefData* ptd, struct datatype* edt)
396 while (*ptd->ptr != ';') {
398 if (DEBUG_PTS_ReadID(ptd) == -1) return -1;
399 if (DEBUG_PTS_ReadNum(ptd, &ofs) == -1) return -1;
400 if (*ptd->ptr++ != ',') return -1;
401 DEBUG_AddStructElement(edt, ptd->buf + idx, NULL, ofs, 0);
408 static inline int DEBUG_PTS_ReadArray(struct ParseTypedefData* ptd, struct datatype* adt)
411 struct datatype* rdt;
413 /* ar<typeinfo_nodef>;<int>;<int>;<typeinfo> */
415 if (*ptd->ptr++ != 'r') return -1;
416 /* FIXME: range type is lost, always assume int */
417 if (DEBUG_PTS_ReadRange(ptd, &rdt, &lo, &hi) == -1) return -1;
418 if (DEBUG_PTS_ReadTypedef(ptd, NULL, &rdt) == -1) return -1;
420 DEBUG_SetArrayParams(adt, lo, hi, rdt);
424 static int DEBUG_PTS_ReadTypedef(struct ParseTypedefData* ptd, const char* typename,
425 struct datatype** ret_dt)
427 int idx, lo, hi, sz = -1;
428 struct datatype* new_dt = NULL; /* newly created data type */
429 struct datatype* ref_dt; /* referenced data type (pointer...) */
430 struct datatype* dt1; /* intermediate data type (scope is limited) */
431 struct datatype* dt2; /* intermediate data type: t1=t2=new_dt */
433 int filenr2 = 0, subnr2 = 0;
435 /* things are a bit complicated because of the way the typedefs are stored inside
436 * the file (we cannot keep the struct datatype** around, because address can
437 * change when realloc is done, so we must call over and over
438 * DEBUG_FileSubNr2StabEnum to keep the correct values around
439 * (however, keeping struct datatype* is valid
441 if (DEBUG_PTS_ReadTypeReference(ptd, &filenr1, &subnr1) == -1) return -1;
443 while (*ptd->ptr == '=') {
446 DEBUG_Printf(DBG_CHN_MESG, "Bad recursion (1) in typedef\n");
449 /* first handle attribute if any */
452 if (*++ptd->ptr == 's') {
454 if (DEBUG_PTS_ReadNum(ptd, &sz) == -1) {
455 DEBUG_Printf(DBG_CHN_MESG, "Not an attribute... NIY\n");
459 if (*ptd->ptr++ != ';') return -1;
463 /* then the real definitions */
464 switch (*ptd->ptr++) {
466 new_dt = DEBUG_NewDataType(DT_POINTER, NULL);
467 if (DEBUG_PTS_ReadTypedef(ptd, NULL, &ref_dt) == -1) return -1;
468 DEBUG_SetPointerType(new_dt, ref_dt);
472 /* doit a two level by hand, otherwise we'd need a stack */
473 if (filenr2 || subnr2) {
474 DEBUG_Printf(DBG_CHN_MESG, "Bad recursion (2) in typedef\n");
477 if (DEBUG_PTS_ReadTypeReference(ptd, &filenr2, &subnr2) == -1) return -1;
479 dt1 = *DEBUG_FileSubNr2StabEnum(filenr1, subnr1);
480 dt2 = *DEBUG_FileSubNr2StabEnum(filenr2, subnr2);
484 filenr2 = subnr2 = 0;
485 } else if (!dt1 && !dt2) {
488 DEBUG_Printf(DBG_CHN_MESG, "Unknown condition %08lx %08lx (%s)\n",
489 (unsigned long)dt1, (unsigned long)dt2, ptd->ptr);
494 new_dt = DEBUG_NewDataType(DT_ARRAY, NULL);
495 if (DEBUG_PTS_ReadArray(ptd, new_dt) == -1) return -1;
498 new_dt = DEBUG_NewDataType(DT_BASIC, typename);
499 assert(!*DEBUG_FileSubNr2StabEnum(filenr1, subnr1));
500 *DEBUG_FileSubNr2StabEnum(filenr1, subnr1) = new_dt;
501 if (DEBUG_PTS_ReadRange(ptd, &ref_dt, &lo, &hi) == -1) return -1;
502 /* should perhaps do more here... */
505 new_dt = DEBUG_NewDataType(DT_FUNC, NULL);
506 if (DEBUG_PTS_ReadTypedef(ptd, NULL, &ref_dt) == -1) return -1;
507 DEBUG_SetPointerType(new_dt, ref_dt);
510 new_dt = DEBUG_NewDataType(DT_ENUM, NULL);
511 if (DEBUG_PTS_ReadEnum(ptd, new_dt) == -1) return -1;
515 /* dt1 can have been already defined in a forward definition */
516 dt1 = *DEBUG_FileSubNr2StabEnum(filenr1, subnr1);
517 dt2 = DEBUG_TypeCast(DT_STRUCT, typename);
519 new_dt = DEBUG_NewDataType(DT_STRUCT, typename);
520 /* we need to set it here, because a struct can hold a pointer
523 *DEBUG_FileSubNr2StabEnum(filenr1, subnr1) = new_dt;
525 if (DEBUG_GetType(dt1) != DT_STRUCT) {
526 DEBUG_Printf(DBG_CHN_MESG,
527 "Forward declaration is not an aggregate\n");
531 /* should check typename is the same too */
534 if (DEBUG_PTS_ReadAggregate(ptd, new_dt) == -1) return -1;
537 switch (*ptd->ptr++) {
538 case 'e': lo = DT_ENUM; break;
539 case 's': case 'u': lo = DT_STRUCT; break;
544 if (DEBUG_PTS_ReadID(ptd) == -1) return -1;
545 new_dt = DEBUG_NewDataType(lo, ptd->buf + idx);
549 if (DEBUG_PTS_ReadNum(ptd, &lo) == -1) {
550 DEBUG_Printf(DBG_CHN_MESG, "Should be a number (%s)...\n", ptd->ptr);
553 enum debug_type_basic basic = DT_BASIC_LAST;
556 case 1: basic = DT_BASIC_INT; break;
557 case 2: basic = DT_BASIC_CHAR; break;
558 case 3: basic = DT_BASIC_SHORTINT; break;
559 case 4: basic = DT_BASIC_LONGINT; break;
560 case 5: basic = DT_BASIC_UCHAR; break;
561 case 6: basic = DT_BASIC_SCHAR; break;
562 case 7: basic = DT_BASIC_USHORTINT; break;
563 case 8: basic = DT_BASIC_UINT; break;
564 /* case 9: basic = DT_BASIC_UINT"; */
565 case 10: basic = DT_BASIC_ULONGINT; break;
566 case 11: basic = DT_BASIC_VOID; break;
567 case 12: basic = DT_BASIC_FLOAT; break;
568 case 13: basic = DT_BASIC_DOUBLE; break;
569 case 14: basic = DT_BASIC_LONGDOUBLE; break;
570 /* case 15: basic = DT_BASIC_INT; break; */
573 case 32: basic = DT_BASIC_BOOL1; break;
574 case 16: basic = DT_BASIC_BOOL2; break;
575 case 8: basic = DT_BASIC_BOOL4; break;
578 /* case 17: basic = DT_BASIC_SHORT real; break; */
579 /* case 18: basic = DT_BASIC_REAL; break; */
580 case 25: basic = DT_BASIC_CMPLX_FLOAT; break;
581 case 26: basic = DT_BASIC_CMPLX_DOUBLE; break;
582 /* case 30: basic = DT_BASIC_wchar"; break; */
583 case 31: basic = DT_BASIC_LONGLONGINT; break;
584 case 32: basic = DT_BASIC_ULONGLONGINT; break;
586 DEBUG_Printf(DBG_CHN_MESG, "Unsupported integral type (%d/%d)\n", lo, sz);
589 if (!(new_dt = DEBUG_GetBasicType(basic))) {
590 DEBUG_Printf(DBG_CHN_MESG, "Basic type %d not found\n", basic);
593 if (*ptd->ptr++ != ';') return -1;
597 DEBUG_Printf(DBG_CHN_MESG, "Unknown type '%c'\n", ptd->ptr[-1]);
602 if ((filenr2 || subnr2) && !*DEBUG_FileSubNr2StabEnum(filenr2, subnr2)) {
604 /* this should be a basic type, define it, or even void */
605 new_dt = DEBUG_NewDataType(DT_BASIC, typename);
607 *DEBUG_FileSubNr2StabEnum(filenr2, subnr2) = new_dt;
611 dt1 = *DEBUG_FileSubNr2StabEnum(filenr1, subnr1);
613 DEBUG_Printf(DBG_CHN_MESG, "Nothing has been defined <%s>\n", ptd->ptr);
620 *DEBUG_FileSubNr2StabEnum(filenr1, subnr1) = *ret_dt = new_dt;
624 DEBUG_Printf(DBG_CHN_MESG, "Adding (%d,%d) %s => ", filenr1, subnr1, typename);
625 DEBUG_PrintTypeCast(new_dt);
626 DEBUG_Printf(DBG_CHN_MESG, "\n");
633 static int DEBUG_ParseTypedefStab(char* ptr, const char* typename)
635 struct ParseTypedefData ptd;
639 /* check for already existing definition */
642 if ((ptd.ptr = strchr(ptr, ':'))) {
644 if (*ptd.ptr != '(') ptd.ptr++;
645 ret = DEBUG_PTS_ReadTypedef(&ptd, typename, &dt);
648 if (ret == -1 || *ptd.ptr) {
649 DEBUG_Printf(DBG_CHN_MESG, "failure on %s at %s\n", ptr, ptd.ptr);
656 static struct datatype *
657 DEBUG_ParseStabType(const char * stab)
662 * Look through the stab definition, and figure out what datatype
663 * this represents. If we have something we know about, assign the
665 * According to "The \"stabs\" debug format" (Rev 2.130) the name may be
666 * a C++ name and contain double colons e.g. foo::bar::baz:t5=*6. Not
669 c = strchr(stab, ':');
675 * The next characters say more about the type (i.e. data, function, etc)
676 * of symbol. Skip them. (C++ for example may have Tt).
677 * Actually this is a very weak description; I think Tt is the only
678 * multiple combination we should see.
680 while (*c && *c != '(' && !isdigit(*c))
683 * The next is either an integer or a (integer,integer).
684 * The DEBUG_ReadTypeEnum takes care that stab_types is large enough.
686 return *DEBUG_ReadTypeEnum(&c);
689 enum DbgInfoLoad DEBUG_ParseStabs(char * addr, unsigned int load_offset,
690 unsigned int staboff, int stablen,
691 unsigned int strtaboff, int strtablen)
693 struct name_hash * curr_func = NULL;
694 struct wine_locals * curr_loc = NULL;
695 struct name_hash * curr_sym = NULL;
696 char currpath[PATH_MAX];
698 int in_external_file = FALSE;
705 unsigned int stabbufflen;
706 struct stab_nlist * stab_ptr;
709 char * subpath = NULL;
712 nstab = stablen / sizeof(struct stab_nlist);
713 stab_ptr = (struct stab_nlist *) (addr + staboff);
714 strs = (char *) (addr + strtaboff);
716 memset(currpath, 0, sizeof(currpath));
719 * Allocate a buffer into which we can build stab strings for cases
720 * where the stab is continued over multiple lines.
723 stabbuff = (char *) DBG_alloc(stabbufflen);
727 for(i=0; i < nstab; i++, stab_ptr++ )
729 ptr = strs + (unsigned int) stab_ptr->n_un.n_name;
730 if( ptr[strlen(ptr) - 1] == '\\' )
733 * Indicates continuation. Append this to the buffer, and go onto the
734 * next record. Repeat the process until we find a stab without the
735 * '/' character, as this indicates we have the whole thing.
738 if( strlen(stabbuff) + len > stabbufflen )
740 stabbufflen += 65536;
741 stabbuff = (char *) DBG_realloc(stabbuff, stabbufflen);
743 strncat(stabbuff, ptr, len - 1);
746 else if( stabbuff[0] != '\0' )
748 strcat( stabbuff, ptr);
752 if( strchr(ptr, '=') != NULL )
755 * The stabs aren't in writable memory, so copy it over so we are
756 * sure we can scribble on it.
758 if( ptr != stabbuff )
760 strcpy(stabbuff, ptr);
763 stab_strcpy(symname, sizeof(symname), ptr);
764 if (!DEBUG_ParseTypedefStab(ptr, symname)) {
765 /* skip this definition */
771 switch(stab_ptr->n_type)
775 * These are useless with ELF. They have no value, and you have to
776 * read the normal symbol table to get the address. Thus we
777 * ignore them, and when we process the normal symbol table
778 * we should do the right thing.
780 * With a.out or mingw, they actually do make some amount of sense.
782 new_value.addr.seg = 0;
783 new_value.type = DEBUG_ParseStabType(ptr);
784 new_value.addr.off = load_offset + stab_ptr->n_value;
785 new_value.cookie = DV_TARGET;
787 stab_strcpy(symname, sizeof(symname), ptr);
789 curr_sym = DEBUG_AddSymbol( symname, &new_value, currpath,
790 SYM_WINE | SYM_DATA | SYM_INVALID );
792 curr_sym = DEBUG_AddSymbol( symname, &new_value, currpath,
793 SYM_WINE | SYM_DATA );
799 * We need to keep track of these so we get symbol scoping
800 * right for local variables. For now, we just ignore them.
801 * The hooks are already there for dealing with this however,
802 * so all we need to do is to keep count of the nesting level,
803 * and find the RBRAC for each matching LBRAC.
809 * These are static symbols and BSS symbols.
811 new_value.addr.seg = 0;
812 new_value.type = DEBUG_ParseStabType(ptr);
813 new_value.addr.off = load_offset + stab_ptr->n_value;
814 new_value.cookie = DV_TARGET;
816 stab_strcpy(symname, sizeof(symname), ptr);
817 curr_sym = DEBUG_AddSymbol( symname, &new_value, currpath,
818 SYM_WINE | SYM_DATA );
822 * These are function parameters.
824 if( curr_func != NULL && !in_external_file )
826 stab_strcpy(symname, sizeof(symname), ptr);
827 curr_loc = DEBUG_AddLocal( curr_func, 0,
828 stab_ptr->n_value, 0, 0, symname );
829 DEBUG_SetLocalSymbolType( curr_loc, DEBUG_ParseStabType(ptr) );
833 if( curr_func != NULL && !in_external_file )
835 stab_strcpy(symname, sizeof(symname), ptr);
836 curr_loc = DEBUG_AddLocal( curr_func, stab_ptr->n_value + 1,
838 DEBUG_SetLocalSymbolType( curr_loc, DEBUG_ParseStabType(ptr) );
842 if( curr_func != NULL && !in_external_file )
844 stab_strcpy(symname, sizeof(symname), ptr);
845 curr_loc = DEBUG_AddLocal( curr_func, 0,
846 stab_ptr->n_value, 0, 0, symname );
847 DEBUG_SetLocalSymbolType( curr_loc, DEBUG_ParseStabType(ptr) );
852 * This is a line number. These are always relative to the start
853 * of the function (N_FUN), and this makes the lookup easier.
855 if( curr_func != NULL && !in_external_file )
858 DEBUG_AddLineNumber(curr_func, stab_ptr->n_desc,
863 * This isn't right. The order of the stabs is different under
864 * a.out, and as a result we would end up attaching the line
865 * number to the wrong function.
867 DEBUG_AddLineNumber(curr_func, stab_ptr->n_desc,
868 stab_ptr->n_value - curr_func->addr.off);
875 * First, clean up the previous function we were working on.
877 DEBUG_Normalize(curr_func);
880 * For now, just declare the various functions. Later
881 * on, we will add the line number information and the
884 if( !in_external_file)
886 stab_strcpy(symname, sizeof(symname), ptr);
889 new_value.addr.seg = 0;
890 new_value.type = DEBUG_ParseStabType(ptr);
891 new_value.addr.off = load_offset + stab_ptr->n_value;
892 new_value.cookie = DV_TARGET;
894 * Copy the string to a temp buffer so we
895 * can kill everything after the ':'. We do
896 * it this way because otherwise we end up dirtying
897 * all of the pages related to the stabs, and that
898 * sucks up swap space like crazy.
901 curr_func = DEBUG_AddSymbol( symname, &new_value, currpath,
902 SYM_WINE | SYM_FUNC | SYM_INVALID );
904 curr_func = DEBUG_AddSymbol( symname, &new_value, currpath,
905 SYM_WINE | SYM_FUNC );
910 /* some GCC seem to use a N_FUN "" to mark the end of a function */
917 * Don't add line number information for this function
925 * This indicates a new source file. Append the records
926 * together, to build the correct path name.
930 * With a.out, there is no NULL string N_SO entry at the end of
931 * the file. Thus when we find non-consecutive entries,
932 * we consider that a new file is started.
937 DEBUG_Normalize(curr_func);
948 DEBUG_Normalize(curr_func);
954 strcat(currpath, ptr);
956 strcpy(currpath, ptr);
958 DEBUG_ResetIncludes();
964 * This indicates we are including stuff from an include file.
965 * If this is the main source, enable the debug stuff, otherwise
968 in_external_file = !(subpath == NULL || strcmp(ptr, subpath) == 0);
972 strtabinc = stab_ptr->n_value;
973 DEBUG_Normalize(curr_func);
978 * Ignore this. We don't care what it points to.
982 DEBUG_AddInclude(DEBUG_CreateInclude(ptr, stab_ptr->n_value));
987 DEBUG_AddInclude(DEBUG_FindInclude(ptr, stab_ptr->n_value));
991 * Always ignore these. GCC doesn't even generate them.
995 DEBUG_Printf(DBG_CHN_MESG, "Unknown stab type 0x%02x\n", stab_ptr->n_type);
1002 DEBUG_Printf(DBG_CHN_MESG, "%d %x %s\n", stab_ptr->n_type,
1003 (unsigned int) stab_ptr->n_value,
1004 strs + (unsigned int) stab_ptr->n_un.n_name);
1008 DEBUG_FreeIncludes();
1016 * Walk through the entire symbol table and add any symbols we find there.
1017 * This can be used in cases where we have stripped ELF shared libraries,
1018 * or it can be used in cases where we have data symbols for which the address
1019 * isn't encoded in the stabs.
1021 * This is all really quite easy, since we don't have to worry about line
1022 * numbers or local data variables.
1024 static int DEBUG_ProcessElfSymtab(DBG_MODULE* module, char* addr,
1025 u_long load_addr, Elf32_Shdr* symtab,
1028 char * curfile = NULL;
1029 struct name_hash * curr_sym = NULL;
1032 DBG_VALUE new_value;
1038 symp = (Elf32_Sym *) (addr + symtab->sh_offset);
1039 nsym = symtab->sh_size / sizeof(*symp);
1040 strp = (char *) (addr + strtab->sh_offset);
1042 for(i=0; i < nsym; i++, symp++)
1045 * Ignore certain types of entries which really aren't of that much
1048 if( ELF32_ST_TYPE(symp->st_info) == STT_SECTION ||
1049 symp->st_shndx == STN_UNDEF )
1054 symname = strp + symp->st_name;
1057 * Save the name of the current file, so we have a way of tracking
1058 * static functions/data.
1060 if( ELF32_ST_TYPE(symp->st_info) == STT_FILE )
1067 * See if we already have something for this symbol.
1068 * If so, ignore this entry, because it would have come from the
1069 * stabs or from a previous symbol. If the value is different,
1070 * we will have to keep the darned thing, because there can be
1071 * multiple local symbols by the same name.
1073 if( (DEBUG_GetSymbolValue(symname, -1, &new_value, FALSE ) == TRUE)
1074 && (new_value.addr.off == (load_addr + symp->st_value)) )
1077 new_value.addr.seg = 0;
1078 new_value.type = NULL;
1079 new_value.addr.off = load_addr + symp->st_value;
1080 new_value.cookie = DV_TARGET;
1081 flags = SYM_WINE | ((ELF32_ST_TYPE(symp->st_info) == STT_FUNC)
1082 ? SYM_FUNC : SYM_DATA);
1083 if( ELF32_ST_BIND(symp->st_info) == STB_GLOBAL )
1084 curr_sym = DEBUG_AddSymbol( symname, &new_value, NULL, flags );
1086 curr_sym = DEBUG_AddSymbol( symname, &new_value, curfile, flags );
1089 * Record the size of the symbol. This can come in handy in
1090 * some cases. Not really used yet, however.
1092 if( symp->st_size != 0 )
1093 DEBUG_SetSymbolSize(curr_sym, symp->st_size);
1100 * Loads the symbolic information from ELF module stored in 'filename'
1101 * the module has been loaded at 'load_offset' address, so symbols' address
1102 * relocation is performed
1104 * -1 if the file cannot be found/opened
1105 * 0 if the file doesn't contain symbolic info (or this info cannot be
1109 enum DbgInfoLoad DEBUG_LoadElfStabs(DBG_MODULE* module)
1111 enum DbgInfoLoad dil = DIL_ERROR;
1112 char* addr = (char*)0xffffffff;
1114 struct stat statbuf;
1122 if (module->type != DMT_ELF || !module->elf_info) {
1123 DEBUG_Printf(DBG_CHN_ERR, "Bad elf module '%s'\n", module->module_name);
1127 /* check that the file exists, and that the module hasn't been loaded yet */
1128 if (stat(module->module_name, &statbuf) == -1) goto leave;
1129 if (S_ISDIR(statbuf.st_mode)) goto leave;
1132 * Now open the file, so that we can mmap() it.
1134 if ((fd = open(module->module_name, O_RDONLY)) == -1) goto leave;
1138 * Now mmap() the file.
1140 addr = mmap(0, statbuf.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
1141 if (addr == (char*)0xffffffff) goto leave;
1144 * Next, we need to find a few of the internal ELF headers within
1145 * this thing. We need the main executable header, and the section
1148 ehptr = (Elf32_Ehdr*) addr;
1149 spnt = (Elf32_Shdr*) (addr + ehptr->e_shoff);
1150 shstrtab = (addr + spnt[ehptr->e_shstrndx].sh_offset);
1152 stabsect = stabstrsect = -1;
1154 for (i = 0; i < ehptr->e_shnum; i++) {
1155 if (strcmp(shstrtab + spnt[i].sh_name, ".stab") == 0)
1158 if (strcmp(shstrtab + spnt[i].sh_name, ".stabstr") == 0)
1162 if (stabsect == -1 || stabstrsect == -1) {
1163 DEBUG_Printf(DBG_CHN_WARN, "no .stab section\n");
1168 * OK, now just parse all of the stabs.
1170 if (DEBUG_ParseStabs(addr,
1171 module->elf_info->elf_addr,
1172 spnt[stabsect].sh_offset,
1173 spnt[stabsect].sh_size,
1174 spnt[stabstrsect].sh_offset,
1175 spnt[stabstrsect].sh_size)) {
1179 DEBUG_Printf(DBG_CHN_WARN, "bad stabs\n");
1183 for (i = 0; i < ehptr->e_shnum; i++) {
1184 if ( (strcmp(shstrtab + spnt[i].sh_name, ".symtab") == 0)
1185 && (spnt[i].sh_type == SHT_SYMTAB))
1186 DEBUG_ProcessElfSymtab(module, addr, module->elf_info->elf_addr,
1187 spnt + i, spnt + spnt[i].sh_link);
1189 if ( (strcmp(shstrtab + spnt[i].sh_name, ".dynsym") == 0)
1190 && (spnt[i].sh_type == SHT_DYNSYM))
1191 DEBUG_ProcessElfSymtab(module, addr, module->elf_info->elf_addr,
1192 spnt + i, spnt + spnt[i].sh_link);
1196 if (addr != (char*)0xffffffff) munmap(addr, statbuf.st_size);
1197 if (fd != -1) close(fd);
1203 * Loads the information for ELF module stored in 'filename'
1204 * the module has been loaded at 'load_offset' address
1206 * -1 if the file cannot be found/opened
1207 * 0 if the file doesn't contain symbolic info (or this info cannot be
1211 static enum DbgInfoLoad DEBUG_ProcessElfFile(const char* filename,
1212 unsigned int load_offset,
1213 unsigned int* dyn_addr)
1215 static const unsigned char elf_signature[4] = { ELFMAG0, ELFMAG1, ELFMAG2, ELFMAG3 };
1216 enum DbgInfoLoad dil = DIL_ERROR;
1217 char* addr = (char*)0xffffffff;
1219 struct stat statbuf;
1225 DBG_MODULE* module = NULL;
1229 DEBUG_Printf(DBG_CHN_TRACE, "Processing elf file '%s'\n", filename);
1231 /* check that the file exists, and that the module hasn't been loaded yet */
1232 if (stat(filename, &statbuf) == -1) goto leave;
1235 * Now open the file, so that we can mmap() it.
1237 if ((fd = open(filename, O_RDONLY)) == -1) goto leave;
1240 * Now mmap() the file.
1242 addr = mmap(0, statbuf.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
1243 if (addr == (char*)0xffffffff) goto leave;
1248 * Next, we need to find a few of the internal ELF headers within
1249 * this thing. We need the main executable header, and the section
1252 ehptr = (Elf32_Ehdr*) addr;
1253 if (memcmp( ehptr->e_ident, elf_signature, sizeof(elf_signature) )) goto leave;
1255 spnt = (Elf32_Shdr*) (addr + ehptr->e_shoff);
1256 shstrtab = (addr + spnt[ehptr->e_shstrndx].sh_offset);
1258 /* if non relocatable ELF, then remove fixed address from computation
1259 * otherwise, all addresses are zero based
1261 delta = (load_offset == 0) ? ehptr->e_entry : 0;
1263 /* grab size of module once loaded in memory */
1264 ppnt = (Elf32_Phdr*) (addr + ehptr->e_phoff);
1266 for (i = 0; i < ehptr->e_phnum; i++) {
1267 if (ppnt[i].p_type != PT_LOAD) continue;
1268 if (size < ppnt[i].p_vaddr - delta + ppnt[i].p_memsz)
1269 size = ppnt[i].p_vaddr - delta + ppnt[i].p_memsz;
1272 for (i = 0; i < ehptr->e_shnum; i++)
1274 if (strcmp(shstrtab + spnt[i].sh_name, ".bss") == 0 &&
1275 spnt[i].sh_type == SHT_NOBITS)
1277 if (size < spnt[i].sh_addr - delta + spnt[i].sh_size)
1278 size = spnt[i].sh_addr - delta + spnt[i].sh_size;
1280 if (strcmp(shstrtab + spnt[i].sh_name, ".dynamic") == 0 &&
1281 spnt[i].sh_type == SHT_DYNAMIC)
1283 if (dyn_addr) *dyn_addr = spnt[i].sh_addr;
1287 module = DEBUG_RegisterELFModule((load_offset == 0) ? ehptr->e_entry : load_offset,
1294 if ((module->elf_info = DBG_alloc(sizeof(ELF_DBG_INFO))) == NULL) {
1295 DEBUG_Printf(DBG_CHN_ERR, "OOM\n");
1299 module->elf_info->elf_addr = load_offset;
1300 dil = DEBUG_LoadElfStabs(module);
1303 if (addr != (char*)0xffffffff) munmap(addr, statbuf.st_size);
1304 if (fd != -1) close(fd);
1305 if (module) module->dil = dil;
1310 static enum DbgInfoLoad DEBUG_ProcessElfFileFromPath(const char * filename,
1311 unsigned int load_offset,
1312 unsigned int* dyn_addr,
1315 enum DbgInfoLoad dil = DIL_ERROR;
1319 if (!path) return -1;
1321 for (s = paths = DBG_strdup(path); s && *s; s = (t) ? (t+1) : NULL) {
1324 fn = (char*)DBG_alloc(strlen(filename) + 1 + strlen(s) + 1);
1328 strcat(fn, filename);
1329 dil = DEBUG_ProcessElfFile(fn, load_offset, dyn_addr);
1331 if (dil != DIL_ERROR) break;
1332 s = (t) ? (t+1) : NULL;
1339 static enum DbgInfoLoad DEBUG_ProcessElfObject(const char* filename,
1340 unsigned int load_offset,
1341 unsigned int* dyn_addr)
1343 enum DbgInfoLoad dil = DIL_ERROR;
1345 if (filename == NULL) return DIL_ERROR;
1346 if (DEBUG_FindModuleByName(filename, DMT_ELF)) return DIL_LOADED;
1348 if (strstr (filename, "libstdc++")) return DIL_ERROR; /* We know we can't do it */
1349 dil = DEBUG_ProcessElfFile(filename, load_offset, dyn_addr);
1351 /* if relative pathname, try some absolute base dirs */
1352 if (dil == DIL_ERROR && !strchr(filename, '/')) {
1353 dil = DEBUG_ProcessElfFileFromPath(filename, load_offset, dyn_addr, getenv("PATH"));
1354 if (dil == DIL_ERROR)
1355 dil = DEBUG_ProcessElfFileFromPath(filename, load_offset, dyn_addr, getenv("LD_LIBRARY_PATH"));
1356 if (dil == DIL_ERROR)
1357 dil = DEBUG_ProcessElfFileFromPath(filename, load_offset, dyn_addr, getenv("WINEDLLPATH"));
1360 DEBUG_ReportDIL(dil, "ELF", filename, load_offset);
1365 static BOOL DEBUG_WalkList(struct r_debug* dbg_hdr)
1373 * Now walk the linked list. In all known ELF implementations,
1374 * the dynamic loader maintains this linked list for us. In some
1375 * cases the first entry doesn't appear with a name, in other cases it
1378 for (lm_addr = (u_long)dbg_hdr->r_map; lm_addr; lm_addr = (u_long)lm.l_next) {
1379 if (!DEBUG_READ_MEM_VERBOSE((void*)lm_addr, &lm, sizeof(lm)))
1381 if (lm.l_addr != 0 &&
1382 DEBUG_READ_MEM_VERBOSE((void*)lm.l_addr, &ehdr, sizeof(ehdr)) &&
1383 ehdr.e_type == ET_DYN && /* only look at dynamic modules */
1384 lm.l_name != NULL &&
1385 DEBUG_READ_MEM_VERBOSE((void*)lm.l_name, bufstr, sizeof(bufstr))) {
1386 bufstr[sizeof(bufstr) - 1] = '\0';
1387 DEBUG_ProcessElfObject(bufstr, (unsigned)lm.l_addr, NULL);
1394 static BOOL DEBUG_RescanElf(void)
1396 struct r_debug dbg_hdr;
1398 if (!DEBUG_CurrProcess ||
1399 !DEBUG_READ_MEM_VERBOSE((void*)DEBUG_CurrProcess->dbg_hdr_addr, &dbg_hdr, sizeof(dbg_hdr)))
1402 switch (dbg_hdr.r_state) {
1404 DEBUG_WalkList(&dbg_hdr);
1405 DEBUG_CheckDelayedBP();
1410 /* FIXME: this is not currently handled, would need some kind of mark&sweep algo */
1416 enum DbgInfoLoad DEBUG_ReadExecutableDbgInfo(const char* exe_name)
1419 struct r_debug dbg_hdr;
1420 enum DbgInfoLoad dil = DIL_NOINFO;
1421 unsigned int dyn_addr;
1424 * Make sure we can stat and open this file.
1426 if (exe_name == NULL) goto leave;
1427 DEBUG_ProcessElfObject(exe_name, 0, &dyn_addr);
1430 if (!DEBUG_READ_MEM_VERBOSE((void*)dyn_addr, &dyn, sizeof(dyn)))
1432 dyn_addr += sizeof(dyn);
1433 } while (dyn.d_tag != DT_DEBUG && dyn.d_tag != DT_NULL);
1434 if (dyn.d_tag == DT_NULL) goto leave;
1437 * OK, now dig into the actual tables themselves.
1439 if (!DEBUG_READ_MEM_VERBOSE((void*)dyn.d_un.d_ptr, &dbg_hdr, sizeof(dbg_hdr)))
1442 assert(!DEBUG_CurrProcess->dbg_hdr_addr);
1443 DEBUG_CurrProcess->dbg_hdr_addr = (u_long)dyn.d_un.d_ptr;
1445 if (dbg_hdr.r_brk) {
1448 DEBUG_Printf(DBG_CHN_TRACE, "Setting up a breakpoint on r_brk(%lx)\n",
1449 (unsigned long)dbg_hdr.r_brk);
1451 DEBUG_SetBreakpoints(FALSE);
1453 value.cookie = DV_TARGET;
1455 value.addr.off = (DWORD)dbg_hdr.r_brk;
1456 DEBUG_AddBreakpoint(&value, DEBUG_RescanElf, TRUE);
1457 DEBUG_SetBreakpoints(TRUE);
1460 dil = DEBUG_WalkList(&dbg_hdr);
1466 /* FIXME: merge with some of the routines above */
1467 int read_elf_info(const char* filename, unsigned long tab[])
1469 static const unsigned char elf_signature[4] = { ELFMAG0, ELFMAG1, ELFMAG2, ELFMAG3 };
1480 hFile = CreateFile(filename, GENERIC_READ, FILE_SHARE_READ, NULL,
1481 OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
1482 if (hFile == INVALID_HANDLE_VALUE) goto leave;
1483 hMap = CreateFileMapping(hFile, NULL, PAGE_READONLY, 0, 0, NULL);
1484 if (hMap == 0) goto leave;
1485 addr = MapViewOfFile(hMap, FILE_MAP_READ, 0, 0, 0);
1486 if (addr == NULL) goto leave;
1488 ehptr = (Elf32_Ehdr*) addr;
1489 if (memcmp(ehptr->e_ident, elf_signature, sizeof(elf_signature))) goto leave;
1491 spnt = (Elf32_Shdr*) (addr + ehptr->e_shoff);
1492 shstrtab = (addr + spnt[ehptr->e_shstrndx].sh_offset);
1494 tab[0] = tab[1] = tab[2] = 0;
1495 for (i = 0; i < ehptr->e_shnum; i++)
1500 if (addr != NULL) UnmapViewOfFile(addr);
1501 if (hMap != 0) CloseHandle(hMap);
1502 if (hFile != INVALID_HANDLE_VALUE) CloseHandle(hFile);
1506 #else /* !__ELF__ */
1508 enum DbgInfoLoad DEBUG_ReadExecutableDbgInfo(const char* exe_name)
1513 #endif /* __ELF__ */