LCMapString32A: Implemented flags NORM_IGNORENONSPACE and
[wine.git] / debugger / stabs.c
blob67565ca2a261303a58aee0b76eeeded97ac26060
1 /*
2 * File stabs.c - read stabs information from the wine executable itself.
4 * Copyright (C) 1996, Eric Youngdale.
5 */
7 #include "config.h"
9 #include <sys/types.h>
10 #include <fcntl.h>
11 #include <sys/stat.h>
12 #include <sys/mman.h>
13 #include <limits.h>
14 #include <stdio.h>
15 #include <stdlib.h>
16 #include <string.h>
17 #include <unistd.h>
18 #ifndef PATH_MAX
19 #define PATH_MAX _MAX_PATH
20 #endif
22 #include "win.h"
23 #include "debugger.h"
24 #include "xmalloc.h"
26 #ifdef __svr4__
27 #define __ELF__
28 #endif
30 #ifdef __ELF__
31 #ifdef HAVE_ELF_H
32 # include <elf.h>
33 #endif
34 #include <link.h>
35 #include <sys/mman.h>
36 #elif defined(__EMX__)
37 #include <a_out.h>
38 #else
39 #include <a.out.h>
40 #endif
42 #ifndef N_UNDF
43 #define N_UNDF 0x00
44 #endif
46 #define N_GSYM 0x20
47 #define N_FUN 0x24
48 #define N_STSYM 0x26
49 #define N_LCSYM 0x28
50 #define N_MAIN 0x2a
51 #define N_ROSYM 0x2c
52 #define N_OPT 0x3c
53 #define N_RSYM 0x40
54 #define N_SLINE 0x44
55 #define N_SO 0x64
56 #define N_LSYM 0x80
57 #define N_BINCL 0x82
58 #define N_SOL 0x84
59 #define N_PSYM 0xa0
60 #define N_EINCL 0xa2
61 #define N_LBRAC 0xc0
62 #define N_RBRAC 0xe0
66 * This is how we translate stab types into our internal representations
67 * of datatypes.
69 static struct datatype ** stab_types = NULL;
70 static int num_stab_types = 0;
73 * Set so that we know the main executable name and path.
75 char * DEBUG_argv0;
77 struct stab_nlist {
78 union {
79 char *n_name;
80 struct stab_nlist *n_next;
81 long n_strx;
82 } n_un;
83 unsigned char n_type;
84 char n_other;
85 short n_desc;
86 unsigned long n_value;
90 * This is used to keep track of known datatypes so that we don't redefine
91 * them over and over again. It sucks up lots of memory otherwise.
93 struct known_typedef
95 struct known_typedef * next;
96 char * name;
97 int ndefs;
98 struct datatype * types[0];
101 #define NR_STAB_HASH 521
103 struct known_typedef * ktd_head[NR_STAB_HASH] = {NULL,};
105 static unsigned int stab_hash( const char * name )
107 unsigned int hash = 0;
108 unsigned int tmp;
109 const char * p;
111 p = name;
113 while (*p)
115 hash = (hash << 4) + *p++;
117 if( (tmp = (hash & 0xf0000000)) )
119 hash ^= tmp >> 24;
121 hash &= ~tmp;
123 return hash % NR_STAB_HASH;
127 static void stab_strcpy(char * dest, const char * source)
130 * A strcpy routine that stops when we hit the ':' character.
131 * Faster than copying the whole thing, and then nuking the
132 * ':'.
134 while(*source != '\0' && *source != ':')
135 *dest++ = *source++;
136 *dest++ = '\0';
139 #define MAX_TD_NESTING 128
141 static int **typenums;
142 static int *nroftypenums=NULL;
143 static int nrofnroftypenums=0;
144 static int curtypenum = 0;
146 static
148 DEBUG_FileSubNr2StabEnum(int filenr,int subnr) {
149 if (nrofnroftypenums<=filenr) {
150 nroftypenums = xrealloc(nroftypenums,sizeof(nroftypenums[0])*(filenr+1));
151 memset(nroftypenums+nrofnroftypenums,0,(filenr+1-nrofnroftypenums)*sizeof(nroftypenums[0]));
152 typenums = xrealloc(typenums,sizeof(typenums[0])*(filenr+1));
153 memset(typenums+nrofnroftypenums,0,sizeof(typenums[0])*(filenr+1-nrofnroftypenums));
154 nrofnroftypenums=filenr+1;
156 if (nroftypenums[filenr]<=subnr) {
157 typenums[filenr] = xrealloc(typenums[filenr],sizeof(typenums[0][0])*(subnr+1));
158 memset(typenums[filenr]+nroftypenums[filenr],0,sizeof(typenums[0][0])*(subnr+1-nroftypenums[filenr]));
159 nroftypenums[filenr] = subnr+1;
161 if (!typenums[filenr][subnr])
162 typenums[filenr][subnr]=++curtypenum;
164 if( num_stab_types <= curtypenum ) {
165 num_stab_types = curtypenum + 256;
166 stab_types = (struct datatype **) xrealloc(stab_types,
167 num_stab_types * sizeof(struct datatype *)
169 memset( stab_types + curtypenum, 0, sizeof(struct datatype *) * (num_stab_types - curtypenum) );
171 /*fprintf(stderr,"(%d,%d) is %d\n",filenr,subnr,typenums[filenr][subnr]); */
172 return typenums[filenr][subnr];
175 static
177 DEBUG_ReadTypeEnumBackwards(char*x) {
178 int filenr,subnr;
180 if (*x==')') {
181 while (*x!='(')
182 x--;
183 x++; /* '(' */
184 filenr=strtol(x,&x,10); /* <int> */
185 x++; /* ',' */
186 subnr=strtol(x,&x,10); /* <int> */
187 x++; /* ')' */
188 } else {
189 while ((*x>='0') && (*x<='9'))
190 x--;
191 filenr = 0;
192 subnr = atol(x+1);
194 return DEBUG_FileSubNr2StabEnum(filenr,subnr);
197 static
199 DEBUG_ReadTypeEnum(char **x) {
200 int filenr,subnr;
202 if (**x=='(') {
203 (*x)++; /* '(' */
204 filenr=strtol(*x,x,10); /* <int> */
205 (*x)++; /* ',' */
206 subnr=strtol(*x,x,10); /* <int> */
207 (*x)++; /* ')' */
208 } else {
209 filenr = 0;
210 subnr = strtol(*x,x,10); /* <int> */
212 return DEBUG_FileSubNr2StabEnum(filenr,subnr);
215 static
217 DEBUG_RegisterTypedef(const char * name, struct datatype ** types, int ndef)
219 int hash;
220 struct known_typedef * ktd;
222 if( ndef == 1 )
223 return TRUE;
225 ktd = (struct known_typedef *) xmalloc(sizeof(struct known_typedef)
226 + ndef * sizeof(struct datatype *));
228 hash = stab_hash(name);
230 ktd->name = xstrdup(name);
231 ktd->ndefs = ndef;
232 memcpy(&ktd->types[0], types, ndef * sizeof(struct datatype *));
233 ktd->next = ktd_head[hash];
234 ktd_head[hash] = ktd;
236 return TRUE;
239 static
241 DEBUG_HandlePreviousTypedef(const char * name, const char * stab)
243 int count;
244 enum debug_type expect;
245 int hash;
246 struct known_typedef * ktd;
247 char * ptr;
249 hash = stab_hash(name);
251 for(ktd = ktd_head[hash]; ktd; ktd = ktd->next)
252 if ((ktd->name[0] == name[0]) && (strcmp(name, ktd->name) == 0) )
253 break;
256 * Didn't find it. This must be a new one.
258 if( ktd == NULL )
259 return FALSE;
262 * Examine the stab to make sure it has the same number of definitions.
264 count = 0;
265 for(ptr = strchr(stab, '='); ptr; ptr = strchr(ptr+1, '='))
267 if( count >= ktd->ndefs )
268 return FALSE;
271 * Make sure the types of all of the objects is consistent with
272 * what we have already parsed.
274 switch(ptr[1])
276 case '*':
277 expect = DT_POINTER;
278 break;
279 case 's':
280 case 'u':
281 expect = DT_STRUCT;
282 break;
283 case 'a':
284 expect = DT_ARRAY;
285 break;
286 case '1':
287 case '(':
288 case 'r':
289 expect = DT_BASIC;
290 break;
291 case 'x':
292 expect = DT_STRUCT;
293 break;
294 case 'e':
295 expect = DT_ENUM;
296 break;
297 case 'f':
298 expect = DT_FUNC;
299 break;
300 default:
301 fprintf(stderr, "Unknown type (%c).\n",ptr[1]);
302 return FALSE;
304 if( expect != DEBUG_GetType(ktd->types[count]) )
305 return FALSE;
306 count++;
309 if( ktd->ndefs != count )
310 return FALSE;
313 * Go through, dig out all of the type numbers, and substitute the
314 * appropriate things.
316 count = 0;
317 for(ptr = strchr(stab, '='); ptr; ptr = strchr(ptr+1, '='))
318 stab_types[DEBUG_ReadTypeEnumBackwards(ptr-1)] = ktd->types[count++];
320 return TRUE;
323 static int DEBUG_FreeRegisteredTypedefs()
325 int count;
326 int j;
327 struct known_typedef * ktd;
328 struct known_typedef * next;
330 count = 0;
331 for(j=0; j < NR_STAB_HASH; j++ )
333 for(ktd = ktd_head[j]; ktd; ktd = next)
335 count++;
336 next = ktd->next;
337 free(ktd->name);
338 free(ktd);
340 ktd_head[j] = NULL;
343 return TRUE;
347 static
349 DEBUG_ParseTypedefStab(char * ptr, const char * typename)
351 int arrmax;
352 int arrmin;
353 char * c;
354 struct datatype * curr_type;
355 struct datatype * datatype;
356 struct datatype * curr_types[MAX_TD_NESTING];
357 char element_name[1024];
358 int ntypes = 0;
359 int offset;
360 const char * orig_typename;
361 int size;
362 char * tc;
363 char * tc2;
364 int typenum;
366 orig_typename = typename;
368 if( DEBUG_HandlePreviousTypedef(typename, ptr) )
369 return TRUE;
372 * Go from back to front. First we go through and figure out what
373 * type numbers we need, and register those types. Then we go in
374 * and fill the details.
377 for( c = strchr(ptr, '='); c != NULL; c = strchr(c + 1, '=') )
380 * Back up until we get to a non-numeric character. This is the type
381 * number.
383 typenum = DEBUG_ReadTypeEnumBackwards(c-1);
385 if( ntypes >= MAX_TD_NESTING )
388 * If this ever happens, just bump the counter.
390 fprintf(stderr, "Typedef nesting overflow\n");
391 return FALSE;
394 switch(c[1])
396 case '*':
397 stab_types[typenum] = DEBUG_NewDataType(DT_POINTER, NULL);
398 curr_types[ntypes++] = stab_types[typenum];
399 break;
400 case 's':
401 case 'u':
402 stab_types[typenum] = DEBUG_NewDataType(DT_STRUCT, typename);
403 curr_types[ntypes++] = stab_types[typenum];
404 break;
405 case 'a':
406 stab_types[typenum] = DEBUG_NewDataType(DT_ARRAY, NULL);
407 curr_types[ntypes++] = stab_types[typenum];
408 break;
409 case '(':
410 case '1':
411 case 'r':
412 stab_types[typenum] = DEBUG_NewDataType(DT_BASIC, typename);
413 curr_types[ntypes++] = stab_types[typenum];
414 break;
415 case 'x':
416 stab_strcpy(element_name, c + 3);
417 stab_types[typenum] = DEBUG_NewDataType(DT_STRUCT, element_name);
418 curr_types[ntypes++] = stab_types[typenum];
419 break;
420 case 'e':
421 stab_types[typenum] = DEBUG_NewDataType(DT_ENUM, NULL);
422 curr_types[ntypes++] = stab_types[typenum];
423 break;
424 case 'f':
425 stab_types[typenum] = DEBUG_NewDataType(DT_FUNC, NULL);
426 curr_types[ntypes++] = stab_types[typenum];
427 break;
428 default:
429 fprintf(stderr, "Unknown type (%c).\n",c[1]);
431 typename = NULL;
435 * Now register the type so that if we encounter it again, we will know
436 * what to do.
438 DEBUG_RegisterTypedef(orig_typename, curr_types, ntypes);
441 * OK, now take a second sweep through. Now we will be digging
442 * out the definitions of the various components, and storing
443 * them in the skeletons that we have already allocated. We take
444 * a right-to left search as this is much easier to parse.
446 for( c = strrchr(ptr, '='); c != NULL; c = strrchr(ptr, '=') )
448 int typenum = DEBUG_ReadTypeEnumBackwards(c-1);
449 curr_type = stab_types[typenum];
451 switch(c[1])
453 case 'x':
454 tc = c + 3;
455 while( *tc != ':' )
456 tc++;
457 tc++;
458 if( *tc == '\0' )
459 *c = '\0';
460 else
461 strcpy(c, tc);
462 break;
463 case '*':
464 case 'f':
465 tc = c + 2;
466 datatype = stab_types[DEBUG_ReadTypeEnum(&tc)];
467 DEBUG_SetPointerType(curr_type, datatype);
468 if( *tc == '\0' )
469 *c = '\0';
470 else
471 strcpy(c, tc);
472 break;
473 case '(':
474 case '1':
475 case 'r':
477 * We have already handled these above.
479 *c = '\0';
480 break;
481 case 'a':
482 /* ar<typeinfo_nodef>;<int>;<int>;<typeinfo>,<int>,<int>;; */
484 tc = c + 3;
485 /* 'r' */
486 DEBUG_ReadTypeEnum(&tc);
487 tc++; /* ';' */
488 arrmin = strtol(tc, &tc, 10); /* <int> */
489 tc++; /* ';' */
490 arrmax = strtol(tc, &tc, 10); /* <int> */
491 tc++; /* ';' */
492 datatype = stab_types[DEBUG_ReadTypeEnum(&tc)]; /* <typeinfo> */
493 if( *tc == '\0' )
494 *c = '\0';
495 else
496 strcpy(c, tc);
497 DEBUG_SetArrayParams(curr_type, arrmin, arrmax, datatype);
498 break;
499 case 's':
500 case 'u': {
501 int failure = 0;
503 tc = c + 2;
504 if( DEBUG_SetStructSize(curr_type, strtol(tc, &tc, 10)) == FALSE )
507 * We have already filled out this structure. Nothing to do,
508 * so just skip forward to the end of the definition.
510 while( tc[0] != ';' && tc[1] != ';' )
511 tc++;
513 tc += 2;
515 if( *tc == '\0' )
516 *c = '\0';
517 else
518 strcpy(c, tc + 1);
519 continue;
523 * Now parse the individual elements of the structure/union.
525 while(*tc != ';')
527 char *ti;
528 tc2 = element_name;
529 while(*tc != ':')
530 *tc2++ = *tc++;
531 tc++;
532 *tc2++ = '\0';
533 ti=tc;
534 datatype = stab_types[DEBUG_ReadTypeEnum(&tc)];
535 *tc='\0';
536 tc++;
537 offset = strtol(tc, &tc, 10);
538 tc++;
539 size = strtol(tc, &tc, 10);
540 tc++;
541 if (datatype)
542 DEBUG_AddStructElement(curr_type, element_name, datatype, offset, size);
543 else {
544 failure = 1;
545 /* ... but proceed parsing to the end of the stab */
549 if (failure) {
550 /* if we had a undeclared value this one is undeclared too.
551 * remove it from the stab_types.
552 * I just set it to NULL to detect bugs in my thoughtprocess.
553 * FIXME: leaks the memory for the structure elements.
554 * FIXME: such structures should have been optimized away
555 * by ld.
557 stab_types[typenum] = NULL;
559 if( *tc == '\0' )
560 *c = '\0';
561 else
562 strcpy(c, tc + 1);
563 break;
565 case 'e':
566 tc = c + 2;
568 * Now parse the individual elements of the structure/union.
570 while(*tc != ';')
572 tc2 = element_name;
573 while(*tc != ':')
574 *tc2++ = *tc++;
575 tc++;
576 *tc2++ = '\0';
577 offset = strtol(tc, &tc, 10);
578 tc++;
579 DEBUG_AddStructElement(curr_type, element_name, NULL, offset, 0);
581 if( *tc == '\0' )
582 *c = '\0';
583 else
584 strcpy(c, tc + 1);
585 break;
586 default:
587 fprintf(stderr, "Unknown type (%c).\n",c[1]);
588 break;
592 return TRUE;
596 static struct datatype *
597 DEBUG_ParseStabType(const char * stab)
599 char * c;
602 * Look through the stab definition, and figure out what datatype
603 * this represents. If we have something we know about, assign the
604 * type.
606 c = strchr(stab, ':');
607 if( c == NULL )
608 return NULL;
610 c++;
612 * The next character says more about the type (i.e. data, function, etc)
613 * of symbol. Skip it.
615 c++;
617 * The next is either an integer or a (integer,integer).
618 * The DEBUG_ReadTypeEnum takes care that stab_types is large enough.
620 return stab_types[DEBUG_ReadTypeEnum(&c)];
623 static
625 DEBUG_ParseStabs(char * addr, unsigned int load_offset,
626 unsigned int staboff, int stablen,
627 unsigned int strtaboff, int strtablen)
629 struct name_hash * curr_func = NULL;
630 struct wine_locals * curr_loc = NULL;
631 struct name_hash * curr_sym = NULL;
632 char currpath[PATH_MAX];
633 int i;
634 int ignore = FALSE;
635 int last_nso = -1;
636 int len;
637 DBG_ADDR new_addr;
638 int nstab;
639 char * ptr;
640 char * stabbuff;
641 int stabbufflen;
642 struct stab_nlist * stab_ptr;
643 char * strs;
644 int strtabinc;
645 char * subpath = NULL;
646 char symname[4096];
648 nstab = stablen / sizeof(struct stab_nlist);
649 stab_ptr = (struct stab_nlist *) (addr + staboff);
650 strs = (char *) (addr + strtaboff);
652 memset(currpath, 0, sizeof(currpath));
655 * Allocate a buffer into which we can build stab strings for cases
656 * where the stab is continued over multiple lines.
658 stabbufflen = 65536;
659 stabbuff = (char *) xmalloc(stabbufflen);
661 strtabinc = 0;
662 stabbuff[0] = '\0';
663 for(i=0; i < nstab; i++, stab_ptr++ )
665 ptr = strs + (unsigned int) stab_ptr->n_un.n_name;
666 if( ptr[strlen(ptr) - 1] == '\\' )
669 * Indicates continuation. Append this to the buffer, and go onto the
670 * next record. Repeat the process until we find a stab without the
671 * '/' character, as this indicates we have the whole thing.
673 len = strlen(ptr);
674 if( strlen(stabbuff) + len > stabbufflen )
676 stabbufflen += 65536;
677 stabbuff = (char *) xrealloc(stabbuff, stabbufflen);
679 strncat(stabbuff, ptr, len - 1);
680 continue;
682 else if( stabbuff[0] != '\0' )
684 strcat( stabbuff, ptr);
685 ptr = stabbuff;
688 if( strchr(ptr, '=') != NULL )
691 * The stabs aren't in writable memory, so copy it over so we are
692 * sure we can scribble on it.
694 if( ptr != stabbuff )
696 strcpy(stabbuff, ptr);
697 ptr = stabbuff;
699 stab_strcpy(symname, ptr);
700 DEBUG_ParseTypedefStab(ptr, symname);
703 switch(stab_ptr->n_type)
705 case N_GSYM:
707 * These are useless with ELF. They have no value, and you have to
708 * read the normal symbol table to get the address. Thus we
709 * ignore them, and when we process the normal symbol table
710 * we should do the right thing.
712 * With a.out, they actually do make some amount of sense.
714 new_addr.seg = 0;
715 new_addr.type = DEBUG_ParseStabType(ptr);
716 new_addr.off = load_offset + stab_ptr->n_value;
718 stab_strcpy(symname, ptr);
719 #ifdef __ELF__
720 curr_sym = DEBUG_AddSymbol( symname, &new_addr, currpath,
721 SYM_WINE | SYM_DATA | SYM_INVALID);
722 #else
723 curr_sym = DEBUG_AddSymbol( symname, &new_addr, currpath,
724 SYM_WINE | SYM_DATA );
725 #endif
726 break;
727 case N_RBRAC:
728 case N_LBRAC:
730 * We need to keep track of these so we get symbol scoping
731 * right for local variables. For now, we just ignore them.
732 * The hooks are already there for dealing with this however,
733 * so all we need to do is to keep count of the nesting level,
734 * and find the RBRAC for each matching LBRAC.
736 break;
737 case N_LCSYM:
738 case N_STSYM:
740 * These are static symbols and BSS symbols.
742 new_addr.seg = 0;
743 new_addr.type = DEBUG_ParseStabType(ptr);
744 new_addr.off = load_offset + stab_ptr->n_value;
746 stab_strcpy(symname, ptr);
747 curr_sym = DEBUG_AddSymbol( symname, &new_addr, currpath,
748 SYM_WINE | SYM_DATA );
749 break;
750 case N_PSYM:
752 * These are function parameters.
754 if( (curr_func != NULL)
755 && (stab_ptr->n_value != 0) )
757 stab_strcpy(symname, ptr);
758 curr_loc = DEBUG_AddLocal(curr_func, 0,
759 stab_ptr->n_value, 0, 0, symname);
760 DEBUG_SetLocalSymbolType( curr_loc, DEBUG_ParseStabType(ptr));
762 break;
763 case N_RSYM:
764 if( curr_func != NULL )
766 stab_strcpy(symname, ptr);
767 curr_loc = DEBUG_AddLocal(curr_func, stab_ptr->n_value, 0, 0, 0, symname);
768 DEBUG_SetLocalSymbolType( curr_loc, DEBUG_ParseStabType(ptr));
770 break;
771 case N_LSYM:
772 if( (curr_func != NULL)
773 && (stab_ptr->n_value != 0) )
775 stab_strcpy(symname, ptr);
776 DEBUG_AddLocal(curr_func, 0,
777 stab_ptr->n_value, 0, 0, symname);
779 else if (curr_func == NULL)
781 stab_strcpy(symname, ptr);
783 break;
784 case N_SLINE:
786 * This is a line number. These are always relative to the start
787 * of the function (N_FUN), and this makes the lookup easier.
789 if( curr_func != NULL )
791 #ifdef __ELF__
792 DEBUG_AddLineNumber(curr_func, stab_ptr->n_desc,
793 stab_ptr->n_value);
794 #else
795 #if 0
797 * This isn't right. The order of the stabs is different under
798 * a.out, and as a result we would end up attaching the line
799 * number to the wrong function.
801 DEBUG_AddLineNumber(curr_func, stab_ptr->n_desc,
802 stab_ptr->n_value - curr_func->addr.off);
803 #endif
804 #endif
806 break;
807 case N_FUN:
809 * First, clean up the previous function we were working on.
811 DEBUG_Normalize(curr_func);
814 * For now, just declare the various functions. Later
815 * on, we will add the line number information and the
816 * local symbols.
818 if( !ignore )
820 new_addr.seg = 0;
821 new_addr.type = DEBUG_ParseStabType(ptr);
822 new_addr.off = load_offset + stab_ptr->n_value;
824 * Copy the string to a temp buffer so we
825 * can kill everything after the ':'. We do
826 * it this way because otherwise we end up dirtying
827 * all of the pages related to the stabs, and that
828 * sucks up swap space like crazy.
830 stab_strcpy(symname, ptr);
831 curr_func = DEBUG_AddSymbol( symname, &new_addr, currpath,
832 SYM_WINE | SYM_FUNC);
834 else
837 * Don't add line number information for this function
838 * any more.
840 curr_func = NULL;
842 break;
843 case N_SO:
845 * This indicates a new source file. Append the records
846 * together, to build the correct path name.
848 #ifndef __ELF__
850 * With a.out, there is no NULL string N_SO entry at the end of
851 * the file. Thus when we find non-consecutive entries,
852 * we consider that a new file is started.
854 if( last_nso < i-1 )
856 currpath[0] = '\0';
857 DEBUG_Normalize(curr_func);
858 curr_func = NULL;
860 #endif
862 if( *ptr == '\0' )
865 * Nuke old path.
867 currpath[0] = '\0';
868 DEBUG_Normalize(curr_func);
869 curr_func = NULL;
871 * The datatypes that we would need to use are reset when
872 * we start a new file.
874 memset(stab_types, 0, num_stab_types * sizeof(stab_types[0]));
876 for (i=0;i<nrofnroftypenums;i++)
877 memset(typenums[i],0,sizeof(typenums[i][0])*nroftypenums[i]);
880 else
882 if (*ptr != '/')
883 strcat(currpath, ptr);
884 else
885 strcpy(currpath, ptr);
886 subpath = ptr;
888 last_nso = i;
889 break;
890 case N_SOL:
892 * This indicates we are including stuff from an include file.
893 * If this is the main source, enable the debug stuff, otherwise
894 * ignore it.
896 if( subpath == NULL || strcmp(ptr, subpath) == 0 )
898 ignore = FALSE;
900 else
902 ignore = TRUE;
903 DEBUG_Normalize(curr_func);
904 curr_func = NULL;
906 break;
907 case N_UNDF:
908 strs += strtabinc;
909 strtabinc = stab_ptr->n_value;
910 DEBUG_Normalize(curr_func);
911 curr_func = NULL;
912 break;
913 case N_OPT:
915 * Ignore this. We don't care what it points to.
917 break;
918 case N_BINCL:
919 case N_EINCL:
920 case N_MAIN:
922 * Always ignore these. GCC doesn't even generate them.
924 break;
925 default:
926 break;
929 stabbuff[0] = '\0';
931 #if 0
932 fprintf(stderr, "%d %x %s\n", stab_ptr->n_type,
933 (unsigned int) stab_ptr->n_value,
934 strs + (unsigned int) stab_ptr->n_un.n_name);
935 #endif
938 if( stab_types != NULL )
940 free(stab_types);
941 stab_types = NULL;
942 num_stab_types = 0;
946 DEBUG_FreeRegisteredTypedefs();
948 return TRUE;
951 #ifdef __ELF__
954 * Walk through the entire symbol table and add any symbols we find there.
955 * This can be used in cases where we have stripped ELF shared libraries,
956 * or it can be used in cases where we have data symbols for which the address
957 * isn't encoded in the stabs.
959 * This is all really quite easy, since we don't have to worry about line
960 * numbers or local data variables.
962 static
964 DEBUG_ProcessElfSymtab(char * addr, unsigned int load_offset,
965 Elf32_Shdr * symtab, Elf32_Shdr * strtab)
967 char * curfile = NULL;
968 struct name_hash * curr_sym = NULL;
969 int flags;
970 int i;
971 DBG_ADDR new_addr;
972 int nsym;
973 char * strp;
974 char * symname;
975 Elf32_Sym * symp;
978 symp = (Elf32_Sym *) (addr + symtab->sh_offset);
979 nsym = symtab->sh_size / sizeof(*symp);
980 strp = (char *) (addr + strtab->sh_offset);
982 for(i=0; i < nsym; i++, symp++)
985 * Ignore certain types of entries which really aren't of that much
986 * interest.
988 if( ELF32_ST_TYPE(symp->st_info) == STT_SECTION )
990 continue;
993 symname = strp + symp->st_name;
996 * Save the name of the current file, so we have a way of tracking
997 * static functions/data.
999 if( ELF32_ST_TYPE(symp->st_info) == STT_FILE )
1001 curfile = symname;
1002 continue;
1007 * See if we already have something for this symbol.
1008 * If so, ignore this entry, because it would have come from the
1009 * stabs or from a previous symbol. If the value is different,
1010 * we will have to keep the darned thing, because there can be
1011 * multiple local symbols by the same name.
1013 if( (DEBUG_GetSymbolValue(symname, -1, &new_addr, FALSE ) == TRUE)
1014 && (new_addr.off == (load_offset + symp->st_value)) )
1015 continue;
1017 new_addr.seg = 0;
1018 new_addr.type = NULL;
1019 new_addr.off = load_offset + symp->st_value;
1020 flags = SYM_WINE | (ELF32_ST_BIND(symp->st_info) == STT_FUNC
1021 ? SYM_FUNC : SYM_DATA);
1022 if( ELF32_ST_BIND(symp->st_info) == STB_GLOBAL )
1023 curr_sym = DEBUG_AddSymbol( symname, &new_addr, NULL, flags );
1024 else
1025 curr_sym = DEBUG_AddSymbol( symname, &new_addr, curfile, flags );
1028 * Record the size of the symbol. This can come in handy in
1029 * some cases. Not really used yet, however.
1031 if( symp->st_size != 0 )
1032 DEBUG_SetSymbolSize(curr_sym, symp->st_size);
1035 return TRUE;
1038 static
1040 DEBUG_ProcessElfObject(char * filename, unsigned int load_offset)
1042 int rtn = FALSE;
1043 struct stat statbuf;
1044 int fd = -1;
1045 int status;
1046 char * addr = (char *) 0xffffffff;
1047 Elf32_Ehdr * ehptr;
1048 Elf32_Shdr * spnt;
1049 char * shstrtab;
1050 int nsect;
1051 int i;
1052 int stabsect;
1053 int stabstrsect;
1057 * Make sure we can stat and open this file.
1059 if( filename == NULL )
1060 goto leave;
1062 status = stat(filename, &statbuf);
1063 if( status == -1 )
1065 char *s,*t,*fn,*paths;
1066 if (strchr(filename,'/'))
1067 goto leave;
1068 paths = xstrdup(getenv("PATH"));
1069 s = paths;
1070 while (s && *s) {
1071 t = strchr(s,':');
1072 if (t) *t='\0';
1073 fn = (char*)xmalloc(strlen(filename)+1+strlen(s)+1);
1074 strcpy(fn,s);
1075 strcat(fn,"/");
1076 strcat(fn,filename);
1077 if ((rtn = DEBUG_ProcessElfObject(fn,load_offset))) {
1078 free(fn);
1079 free(paths);
1080 goto leave;
1082 free(fn);
1083 if (t) s = t+1; else break;
1085 if (!s || !*s) fprintf(stderr," not found");
1086 free(paths);
1087 goto leave;
1091 * Now open the file, so that we can mmap() it.
1093 fd = open(filename, O_RDONLY);
1094 if( fd == -1 )
1095 goto leave;
1099 * Now mmap() the file.
1101 addr = mmap(0, statbuf.st_size, PROT_READ,
1102 MAP_PRIVATE, fd, 0);
1103 if( addr == (char *) 0xffffffff )
1104 goto leave;
1107 * Next, we need to find a few of the internal ELF headers within
1108 * this thing. We need the main executable header, and the section
1109 * table.
1111 ehptr = (Elf32_Ehdr *) addr;
1113 if( load_offset == 0 )
1114 DEBUG_RegisterELFDebugInfo(ehptr->e_entry, statbuf.st_size, filename);
1115 else
1116 DEBUG_RegisterELFDebugInfo(load_offset, statbuf.st_size, filename);
1118 spnt = (Elf32_Shdr *) (addr + ehptr->e_shoff);
1119 nsect = ehptr->e_shnum;
1120 shstrtab = (addr + spnt[ehptr->e_shstrndx].sh_offset);
1122 stabsect = stabstrsect = -1;
1124 for(i=0; i < nsect; i++)
1126 if( strcmp(shstrtab + spnt[i].sh_name, ".stab") == 0 )
1127 stabsect = i;
1129 if( strcmp(shstrtab + spnt[i].sh_name, ".stabstr") == 0 )
1130 stabstrsect = i;
1133 if( stabsect == -1 || stabstrsect == -1 )
1134 goto leave;
1137 * OK, now just parse all of the stabs.
1139 rtn = DEBUG_ParseStabs(addr, load_offset,
1140 spnt[stabsect].sh_offset,
1141 spnt[stabsect].sh_size,
1142 spnt[stabstrsect].sh_offset,
1143 spnt[stabstrsect].sh_size);
1145 if( rtn != TRUE )
1146 goto leave;
1148 for(i=0; i < nsect; i++)
1150 if( (strcmp(shstrtab + spnt[i].sh_name, ".symtab") == 0)
1151 && (spnt[i].sh_type == SHT_SYMTAB) )
1152 DEBUG_ProcessElfSymtab(addr, load_offset,
1153 spnt + i, spnt + spnt[i].sh_link);
1155 if( (strcmp(shstrtab + spnt[i].sh_name, ".dynsym") == 0)
1156 && (spnt[i].sh_type == SHT_DYNSYM) )
1157 DEBUG_ProcessElfSymtab(addr, load_offset,
1158 spnt + i, spnt + spnt[i].sh_link);
1161 leave:
1163 if( addr != (char *) 0xffffffff )
1164 munmap(addr, statbuf.st_size);
1166 if( fd != -1 )
1167 close(fd);
1169 return (rtn);
1174 DEBUG_ReadExecutableDbgInfo(void)
1176 Elf32_Ehdr * ehdr;
1177 char * exe_name;
1178 Elf32_Dyn * dynpnt;
1179 struct r_debug * dbg_hdr;
1180 struct link_map * lpnt = NULL;
1181 extern Elf32_Dyn _DYNAMIC[];
1182 int rtn = FALSE;
1183 int rowcount;
1185 exe_name = DEBUG_argv0;
1188 * Make sure we can stat and open this file.
1190 if( exe_name == NULL )
1191 goto leave;
1193 fprintf( stderr, "Loading symbols: %s", exe_name );
1194 rowcount = 17 + strlen(exe_name);
1195 DEBUG_ProcessElfObject(exe_name, 0);
1198 * Finally walk the tables that the dynamic loader maintains to find all
1199 * of the other shared libraries which might be loaded. Perform the
1200 * same step for all of these.
1202 dynpnt = _DYNAMIC;
1203 if( dynpnt == NULL )
1204 goto leave;
1207 * Now walk the dynamic section (of the executable, looking for a DT_DEBUG
1208 * entry.
1210 for(; dynpnt->d_tag != DT_NULL; dynpnt++)
1211 if( dynpnt->d_tag == DT_DEBUG )
1212 break;
1214 if( (dynpnt->d_tag != DT_DEBUG)
1215 || (dynpnt->d_un.d_ptr == 0) )
1216 goto leave;
1219 * OK, now dig into the actual tables themselves.
1221 dbg_hdr = (struct r_debug *) dynpnt->d_un.d_ptr;
1222 lpnt = dbg_hdr->r_map;
1225 * Now walk the linked list. In all known ELF implementations,
1226 * the dynamic loader maintains this linked list for us. In some
1227 * cases the first entry doesn't appear with a name, in other cases it
1228 * does.
1230 for(; lpnt; lpnt = lpnt->l_next )
1233 * We already got the stuff for the executable using the
1234 * argv[0] entry above. Here we only need to concentrate on any
1235 * shared libraries which may be loaded.
1237 ehdr = (Elf32_Ehdr *) lpnt->l_addr;
1238 if( (lpnt->l_addr == 0) || (ehdr->e_type != ET_DYN) )
1239 continue;
1241 if( lpnt->l_name != NULL )
1243 if (rowcount + strlen(lpnt->l_name) > 76)
1245 fprintf( stderr, "\n " );
1246 rowcount = 3;
1248 fprintf( stderr, " %s", lpnt->l_name );
1249 rowcount += strlen(lpnt->l_name) + 1;
1250 DEBUG_ProcessElfObject(lpnt->l_name, lpnt->l_addr);
1254 rtn = TRUE;
1256 leave:
1257 fprintf( stderr, "\n" );
1258 return (rtn);
1262 #else /* !__ELF__ */
1264 #ifdef linux
1266 * a.out linux.
1269 DEBUG_ReadExecutableDbgInfo(void)
1271 char * addr = (char *) 0xffffffff;
1272 char * exe_name;
1273 struct exec * ahdr;
1274 int fd = -1;
1275 int rtn = FALSE;
1276 unsigned int staboff;
1277 struct stat statbuf;
1278 int status;
1279 unsigned int stroff;
1281 exe_name = DEBUG_argv0;
1284 * Make sure we can stat and open this file.
1286 if( exe_name == NULL )
1287 goto leave;
1289 status = stat(exe_name, &statbuf);
1290 if( status == -1 )
1291 goto leave;
1294 * Now open the file, so that we can mmap() it.
1296 fd = open(exe_name, O_RDONLY);
1297 if( fd == -1 )
1298 goto leave;
1302 * Now mmap() the file.
1304 addr = mmap(0, statbuf.st_size, PROT_READ,
1305 MAP_PRIVATE, fd, 0);
1306 if( addr == (char *) 0xffffffff )
1307 goto leave;
1309 ahdr = (struct exec *) addr;
1311 staboff = N_SYMOFF(*ahdr);
1312 stroff = N_STROFF(*ahdr);
1313 rtn = DEBUG_ParseStabs(addr, 0,
1314 staboff,
1315 ahdr->a_syms,
1316 stroff,
1317 statbuf.st_size - stroff);
1320 * Give a nice status message here...
1322 fprintf( stderr, "Loading symbols: %s", exe_name );
1324 rtn = TRUE;
1326 leave:
1328 if( addr != (char *) 0xffffffff )
1329 munmap(addr, statbuf.st_size);
1331 if( fd != -1 )
1332 close(fd);
1334 return (rtn);
1337 #else
1339 * Non-linux, non-ELF platforms.
1342 DEBUG_ReadExecutableDbgInfo(void)
1344 return FALSE;
1346 #endif
1348 #endif /* __ELF__ */