xref: /openbsd-src/gnu/usr.bin/binutils/gdb/minsyms.c (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1 /* GDB routines for manipulating the minimal symbol tables.
2    Copyright 1992, 1993, 1994, 1996, 1996 Free Software Foundation, Inc.
3    Contributed by Cygnus Support, using pieces from other GDB modules.
4 
5 This file is part of GDB.
6 
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
11 
12 This program 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
15 GNU General Public License for more details.
16 
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
20 
21 
22 /* This file contains support routines for creating, manipulating, and
23    destroying minimal symbol tables.
24 
25    Minimal symbol tables are used to hold some very basic information about
26    all defined global symbols (text, data, bss, abs, etc).  The only two
27    required pieces of information are the symbol's name and the address
28    associated with that symbol.
29 
30    In many cases, even if a file was compiled with no special options for
31    debugging at all, as long as was not stripped it will contain sufficient
32    information to build useful minimal symbol tables using this structure.
33 
34    Even when a file contains enough debugging information to build a full
35    symbol table, these minimal symbols are still useful for quickly mapping
36    between names and addresses, and vice versa.  They are also sometimes used
37    to figure out what full symbol table entries need to be read in. */
38 
39 
40 #include "defs.h"
41 #include "gdb_string.h"
42 #include "symtab.h"
43 #include "bfd.h"
44 #include "symfile.h"
45 #include "objfiles.h"
46 #include "demangle.h"
47 #include "gdb-stabs.h"
48 
49 /* Accumulate the minimal symbols for each objfile in bunches of BUNCH_SIZE.
50    At the end, copy them all into one newly allocated location on an objfile's
51    symbol obstack.  */
52 
53 #define BUNCH_SIZE 127
54 
55 struct msym_bunch
56 {
57   struct msym_bunch *next;
58   struct minimal_symbol contents[BUNCH_SIZE];
59 };
60 
61 /* Bunch currently being filled up.
62    The next field points to chain of filled bunches.  */
63 
64 static struct msym_bunch *msym_bunch;
65 
66 /* Number of slots filled in current bunch.  */
67 
68 static int msym_bunch_index;
69 
70 /* Total number of minimal symbols recorded so far for the objfile.  */
71 
72 static int msym_count;
73 
74 /* Prototypes for local functions. */
75 
76 static int
77 compare_minimal_symbols PARAMS ((const void *, const void *));
78 
79 static int
80 compact_minimal_symbols PARAMS ((struct minimal_symbol *, int));
81 
82 /* Look through all the current minimal symbol tables and find the
83    first minimal symbol that matches NAME.  If OBJF is non-NULL, limit
84    the search to that objfile.  If SFILE is non-NULL, limit the search
85    to that source file.  Returns a pointer to the minimal symbol that
86    matches, or NULL if no match is found.
87 
88    Note:  One instance where there may be duplicate minimal symbols with
89    the same name is when the symbol tables for a shared library and the
90    symbol tables for an executable contain global symbols with the same
91    names (the dynamic linker deals with the duplication). */
92 
93 struct minimal_symbol *
94 lookup_minimal_symbol (name, sfile, objf)
95      register const char *name;
96      const char *sfile;
97      struct objfile *objf;
98 {
99   struct objfile *objfile;
100   struct minimal_symbol *msymbol;
101   struct minimal_symbol *found_symbol = NULL;
102   struct minimal_symbol *found_file_symbol = NULL;
103   struct minimal_symbol *trampoline_symbol = NULL;
104 
105 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
106   if (sfile != NULL)
107     {
108       char *p = strrchr (sfile, '/');
109       if (p != NULL)
110 	sfile = p + 1;
111     }
112 #endif
113 
114   for (objfile = object_files;
115        objfile != NULL && found_symbol == NULL;
116        objfile = objfile -> next)
117     {
118       if (objf == NULL || objf == objfile)
119 	{
120 	  for (msymbol = objfile -> msymbols;
121 	       msymbol != NULL && SYMBOL_NAME (msymbol) != NULL &&
122 	       found_symbol == NULL;
123 	       msymbol++)
124 	    {
125 	      if (SYMBOL_MATCHES_NAME (msymbol, name))
126 		{
127 		  switch (MSYMBOL_TYPE (msymbol))
128 		    {
129 		    case mst_file_text:
130 		    case mst_file_data:
131 		    case mst_file_bss:
132 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
133 		      if (sfile == NULL || STREQ (msymbol->filename, sfile))
134 			found_file_symbol = msymbol;
135 #else
136 		      /* We have neither the ability nor the need to
137 			 deal with the SFILE parameter.  If we find
138 			 more than one symbol, just return the latest
139 			 one (the user can't expect useful behavior in
140 			 that case).  */
141 		      found_file_symbol = msymbol;
142 #endif
143 		      break;
144 
145 		    case mst_solib_trampoline:
146 
147 		      /* If a trampoline symbol is found, we prefer to
148 			 keep looking for the *real* symbol. If the
149 			 actual symbol is not found, then we'll use the
150 			 trampoline entry. */
151 		      if (trampoline_symbol == NULL)
152 			trampoline_symbol = msymbol;
153 		      break;
154 
155 		    case mst_unknown:
156 		    default:
157 		      found_symbol = msymbol;
158 		      break;
159 		    }
160 		}
161 	    }
162 	}
163     }
164   /* External symbols are best.  */
165   if (found_symbol)
166     return found_symbol;
167 
168   /* File-local symbols are next best.  */
169   if (found_file_symbol)
170     return found_file_symbol;
171 
172   /* Symbols for shared library trampolines are next best.  */
173   if (trampoline_symbol)
174     return trampoline_symbol;
175 
176   return NULL;
177 }
178 
179 /* Look through all the current minimal symbol tables and find the
180    first minimal symbol that matches NAME and of text type.
181    If OBJF is non-NULL, limit
182    the search to that objfile.  If SFILE is non-NULL, limit the search
183    to that source file.  Returns a pointer to the minimal symbol that
184    matches, or NULL if no match is found.
185 */
186 
187 struct minimal_symbol *
188 lookup_minimal_symbol_text (name, sfile, objf)
189      register const char *name;
190      const char *sfile;
191      struct objfile *objf;
192 {
193   struct objfile *objfile;
194   struct minimal_symbol *msymbol;
195   struct minimal_symbol *found_symbol = NULL;
196   struct minimal_symbol *found_file_symbol = NULL;
197 
198 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
199   if (sfile != NULL)
200     {
201       char *p = strrchr (sfile, '/');
202       if (p != NULL)
203 	sfile = p + 1;
204     }
205 #endif
206 
207   for (objfile = object_files;
208        objfile != NULL && found_symbol == NULL;
209        objfile = objfile -> next)
210     {
211       if (objf == NULL || objf == objfile)
212 	{
213 	  for (msymbol = objfile -> msymbols;
214 	       msymbol != NULL && SYMBOL_NAME (msymbol) != NULL &&
215 	       found_symbol == NULL;
216 	       msymbol++)
217 	    {
218 	      if (SYMBOL_MATCHES_NAME (msymbol, name) &&
219 		  (MSYMBOL_TYPE (msymbol) == mst_text ||
220 		   MSYMBOL_TYPE (msymbol) == mst_file_text))
221 		{
222 		  switch (MSYMBOL_TYPE (msymbol))
223 		    {
224 		    case mst_file_text:
225 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
226 		      if (sfile == NULL || STREQ (msymbol->filename, sfile))
227 			found_file_symbol = msymbol;
228 #else
229 		      /* We have neither the ability nor the need to
230 			 deal with the SFILE parameter.  If we find
231 			 more than one symbol, just return the latest
232 			 one (the user can't expect useful behavior in
233 			 that case).  */
234 		      found_file_symbol = msymbol;
235 #endif
236 		      break;
237 		    default:
238 		      found_symbol = msymbol;
239 		      break;
240 		    }
241 		}
242 	    }
243 	}
244     }
245   /* External symbols are best.  */
246   if (found_symbol)
247     return found_symbol;
248 
249   /* File-local symbols are next best.  */
250   if (found_file_symbol)
251     return found_file_symbol;
252 
253   return NULL;
254 }
255 
256 /* Look through all the current minimal symbol tables and find the
257    first minimal symbol that matches NAME and of solib trampoline type.
258    If OBJF is non-NULL, limit
259    the search to that objfile.  If SFILE is non-NULL, limit the search
260    to that source file.  Returns a pointer to the minimal symbol that
261    matches, or NULL if no match is found.
262 */
263 
264 struct minimal_symbol *
265 lookup_minimal_symbol_solib_trampoline (name, sfile, objf)
266      register const char *name;
267      const char *sfile;
268      struct objfile *objf;
269 {
270   struct objfile *objfile;
271   struct minimal_symbol *msymbol;
272   struct minimal_symbol *found_symbol = NULL;
273 
274 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
275   if (sfile != NULL)
276     {
277       char *p = strrchr (sfile, '/');
278       if (p != NULL)
279 	sfile = p + 1;
280     }
281 #endif
282 
283   for (objfile = object_files;
284        objfile != NULL && found_symbol == NULL;
285        objfile = objfile -> next)
286     {
287       if (objf == NULL || objf == objfile)
288 	{
289 	  for (msymbol = objfile -> msymbols;
290 	       msymbol != NULL && SYMBOL_NAME (msymbol) != NULL &&
291 	       found_symbol == NULL;
292 	       msymbol++)
293 	    {
294 	      if (SYMBOL_MATCHES_NAME (msymbol, name) &&
295 		  MSYMBOL_TYPE (msymbol) == mst_solib_trampoline)
296 		return msymbol;
297 	    }
298 	}
299     }
300 
301   return NULL;
302 }
303 
304 
305 /* Search through the minimal symbol table for each objfile and find the
306    symbol whose address is the largest address that is still less than or
307    equal to PC.  Returns a pointer to the minimal symbol if such a symbol
308    is found, or NULL if PC is not in a suitable range.  Note that we need
309    to look through ALL the minimal symbol tables before deciding on the
310    symbol that comes closest to the specified PC.  This is because objfiles
311    can overlap, for example objfile A has .text at 0x100 and .data at 0x40000
312    and objfile B has .text at 0x234 and .data at 0x40048.  */
313 
314 struct minimal_symbol *
315 lookup_minimal_symbol_by_pc (pc)
316      register CORE_ADDR pc;
317 {
318   register int lo;
319   register int hi;
320   register int new;
321   register struct objfile *objfile;
322   register struct minimal_symbol *msymbol;
323   register struct minimal_symbol *best_symbol = NULL;
324 
325   /* pc has to be in a known section. This ensures that anything beyond
326      the end of the last segment doesn't appear to be part of the last
327      function in the last segment.  */
328   if (find_pc_section (pc) == NULL)
329     return NULL;
330 
331   for (objfile = object_files;
332        objfile != NULL;
333        objfile = objfile -> next)
334     {
335       /* If this objfile has a minimal symbol table, go search it using
336 	 a binary search.  Note that a minimal symbol table always consists
337 	 of at least two symbols, a "real" symbol and the terminating
338 	 "null symbol".  If there are no real symbols, then there is no
339 	 minimal symbol table at all. */
340 
341       if ((msymbol = objfile -> msymbols) != NULL)
342 	{
343 	  lo = 0;
344 	  hi = objfile -> minimal_symbol_count - 1;
345 
346 	  /* This code assumes that the minimal symbols are sorted by
347 	     ascending address values.  If the pc value is greater than or
348 	     equal to the first symbol's address, then some symbol in this
349 	     minimal symbol table is a suitable candidate for being the
350 	     "best" symbol.  This includes the last real symbol, for cases
351 	     where the pc value is larger than any address in this vector.
352 
353 	     By iterating until the address associated with the current
354 	     hi index (the endpoint of the test interval) is less than
355 	     or equal to the desired pc value, we accomplish two things:
356 	     (1) the case where the pc value is larger than any minimal
357 	     symbol address is trivially solved, (2) the address associated
358 	     with the hi index is always the one we want when the interation
359 	     terminates.  In essence, we are iterating the test interval
360 	     down until the pc value is pushed out of it from the high end.
361 
362 	     Warning: this code is trickier than it would appear at first. */
363 
364 	  /* Should also requires that pc is <= end of objfile.  FIXME! */
365 	  if (pc >= SYMBOL_VALUE_ADDRESS (&msymbol[lo]))
366 	    {
367 	      while (SYMBOL_VALUE_ADDRESS (&msymbol[hi]) > pc)
368 		{
369 		  /* pc is still strictly less than highest address */
370 		  /* Note "new" will always be >= lo */
371 		  new = (lo + hi) / 2;
372 		  if ((SYMBOL_VALUE_ADDRESS (&msymbol[new]) >= pc) ||
373 		      (lo == new))
374 		    {
375 		      hi = new;
376 		    }
377 		  else
378 		    {
379 		      lo = new;
380 		    }
381 		}
382 
383 	      /* If we have multiple symbols at the same address, we want
384 		 hi to point to the last one.  That way we can find the
385 		 right symbol if it has an index greater than hi.  */
386 	      while (hi < objfile -> minimal_symbol_count - 1
387 		     && (SYMBOL_VALUE_ADDRESS (&msymbol[hi])
388 			 == SYMBOL_VALUE_ADDRESS (&msymbol[hi+1])))
389 		hi++;
390 
391 	      /* The minimal symbol indexed by hi now is the best one in this
392 		 objfile's minimal symbol table.  See if it is the best one
393 		 overall. */
394 
395 	      /* Skip any absolute symbols.  This is apparently what adb
396 		 and dbx do, and is needed for the CM-5.  There are two
397 		 known possible problems: (1) on ELF, apparently end, edata,
398 		 etc. are absolute.  Not sure ignoring them here is a big
399 		 deal, but if we want to use them, the fix would go in
400 		 elfread.c.  (2) I think shared library entry points on the
401 		 NeXT are absolute.  If we want special handling for this
402 		 it probably should be triggered by a special
403 		 mst_abs_or_lib or some such.  */
404 	      while (hi >= 0
405 		     && msymbol[hi].type == mst_abs)
406 		--hi;
407 
408 	      if (hi >= 0
409 		  && ((best_symbol == NULL) ||
410 		      (SYMBOL_VALUE_ADDRESS (best_symbol) <
411 		       SYMBOL_VALUE_ADDRESS (&msymbol[hi]))))
412 		{
413 		  best_symbol = &msymbol[hi];
414 		}
415 	    }
416 	}
417     }
418   return (best_symbol);
419 }
420 
421 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
422 CORE_ADDR
423 find_stab_function_addr (namestring, pst, objfile)
424      char *namestring;
425      struct partial_symtab *pst;
426      struct objfile *objfile;
427 {
428   struct minimal_symbol *msym;
429   char *p;
430   int n;
431 
432   p = strchr (namestring, ':');
433   if (p == NULL)
434     p = namestring;
435   n = p - namestring;
436   p = alloca (n + 1);
437   strncpy (p, namestring, n);
438   p[n] = 0;
439 
440   msym = lookup_minimal_symbol (p, pst->filename, objfile);
441   return msym == NULL ? 0 : SYMBOL_VALUE_ADDRESS (msym);
442 }
443 #endif /* SOFUN_ADDRESS_MAYBE_MISSING */
444 
445 
446 /* Return leading symbol character for a BFD. If BFD is NULL,
447    return the leading symbol character from the main objfile.  */
448 
449 static int get_symbol_leading_char PARAMS ((bfd *));
450 
451 static int
452 get_symbol_leading_char (abfd)
453      bfd * abfd;
454 {
455   if (abfd != NULL)
456     return bfd_get_symbol_leading_char (abfd);
457   if (symfile_objfile != NULL && symfile_objfile->obfd != NULL)
458     return bfd_get_symbol_leading_char (symfile_objfile->obfd);
459   return 0;
460 }
461 
462 /* Prepare to start collecting minimal symbols.  Note that presetting
463    msym_bunch_index to BUNCH_SIZE causes the first call to save a minimal
464    symbol to allocate the memory for the first bunch. */
465 
466 void
467 init_minimal_symbol_collection ()
468 {
469   msym_count = 0;
470   msym_bunch = NULL;
471   msym_bunch_index = BUNCH_SIZE;
472 }
473 
474 void
475 prim_record_minimal_symbol (name, address, ms_type, objfile)
476      const char *name;
477      CORE_ADDR address;
478      enum minimal_symbol_type ms_type;
479      struct objfile *objfile;
480 {
481   int section;
482 
483   switch (ms_type)
484     {
485     case mst_text:
486     case mst_file_text:
487     case mst_solib_trampoline:
488       section = SECT_OFF_TEXT;
489       break;
490     case mst_data:
491     case mst_file_data:
492       section = SECT_OFF_DATA;
493       break;
494     case mst_bss:
495     case mst_file_bss:
496       section = SECT_OFF_BSS;
497       break;
498     default:
499       section = -1;
500     }
501 
502   prim_record_minimal_symbol_and_info (name, address, ms_type,
503 				       NULL, section, objfile);
504 }
505 
506 /* Record a minimal symbol in the msym bunches.  Returns the symbol
507    newly created.  */
508 
509 struct minimal_symbol *
510 prim_record_minimal_symbol_and_info (name, address, ms_type, info, section,
511 				     objfile)
512      const char *name;
513      CORE_ADDR address;
514      enum minimal_symbol_type ms_type;
515      char *info;
516      int section;
517      struct objfile *objfile;
518 {
519   register struct msym_bunch *new;
520   register struct minimal_symbol *msymbol;
521 
522   if (ms_type == mst_file_text)
523     {
524       /* Don't put gcc_compiled, __gnu_compiled_cplus, and friends into
525 	 the minimal symbols, because if there is also another symbol
526 	 at the same address (e.g. the first function of the file),
527 	 lookup_minimal_symbol_by_pc would have no way of getting the
528 	 right one.  */
529       if (name[0] == 'g'
530 	  && (strcmp (name, GCC_COMPILED_FLAG_SYMBOL) == 0
531 	      || strcmp (name, GCC2_COMPILED_FLAG_SYMBOL) == 0))
532 	return (NULL);
533 
534       {
535 	const char *tempstring = name;
536 	if (tempstring[0] == get_symbol_leading_char (objfile->obfd))
537 	  ++tempstring;
538 	if (STREQN (tempstring, "__gnu_compiled", 14))
539 	  return (NULL);
540       }
541     }
542 
543   if (msym_bunch_index == BUNCH_SIZE)
544     {
545       new = (struct msym_bunch *) xmalloc (sizeof (struct msym_bunch));
546       msym_bunch_index = 0;
547       new -> next = msym_bunch;
548       msym_bunch = new;
549     }
550   msymbol = &msym_bunch -> contents[msym_bunch_index];
551   SYMBOL_NAME (msymbol) = obsavestring ((char *) name, strlen (name),
552 					&objfile->symbol_obstack);
553   SYMBOL_INIT_LANGUAGE_SPECIFIC (msymbol, language_unknown);
554   SYMBOL_VALUE_ADDRESS (msymbol) = address;
555   SYMBOL_SECTION (msymbol) = section;
556 
557   MSYMBOL_TYPE (msymbol) = ms_type;
558   /* FIXME:  This info, if it remains, needs its own field.  */
559   MSYMBOL_INFO (msymbol) = info; /* FIXME! */
560   msym_bunch_index++;
561   msym_count++;
562   OBJSTAT (objfile, n_minsyms++);
563   return msymbol;
564 }
565 
566 /* Compare two minimal symbols by address and return a signed result based
567    on unsigned comparisons, so that we sort into unsigned numeric order.  */
568 
569 static int
570 compare_minimal_symbols (fn1p, fn2p)
571      const PTR fn1p;
572      const PTR fn2p;
573 {
574   register const struct minimal_symbol *fn1;
575   register const struct minimal_symbol *fn2;
576 
577   fn1 = (const struct minimal_symbol *) fn1p;
578   fn2 = (const struct minimal_symbol *) fn2p;
579 
580   if (SYMBOL_VALUE_ADDRESS (fn1) < SYMBOL_VALUE_ADDRESS (fn2))
581     {
582       return (-1);
583     }
584   else if (SYMBOL_VALUE_ADDRESS (fn1) > SYMBOL_VALUE_ADDRESS (fn2))
585     {
586       return (1);
587     }
588   else
589     {
590       return (0);
591     }
592 }
593 
594 /* Discard the currently collected minimal symbols, if any.  If we wish
595    to save them for later use, we must have already copied them somewhere
596    else before calling this function.
597 
598    FIXME:  We could allocate the minimal symbol bunches on their own
599    obstack and then simply blow the obstack away when we are done with
600    it.  Is it worth the extra trouble though? */
601 
602 /* ARGSUSED */
603 void
604 discard_minimal_symbols (foo)
605      int foo;
606 {
607   register struct msym_bunch *next;
608 
609   while (msym_bunch != NULL)
610     {
611       next = msym_bunch -> next;
612       free ((PTR)msym_bunch);
613       msym_bunch = next;
614     }
615 }
616 
617 /* Compact duplicate entries out of a minimal symbol table by walking
618    through the table and compacting out entries with duplicate addresses
619    and matching names.  Return the number of entries remaining.
620 
621    On entry, the table resides between msymbol[0] and msymbol[mcount].
622    On exit, it resides between msymbol[0] and msymbol[result_count].
623 
624    When files contain multiple sources of symbol information, it is
625    possible for the minimal symbol table to contain many duplicate entries.
626    As an example, SVR4 systems use ELF formatted object files, which
627    usually contain at least two different types of symbol tables (a
628    standard ELF one and a smaller dynamic linking table), as well as
629    DWARF debugging information for files compiled with -g.
630 
631    Without compacting, the minimal symbol table for gdb itself contains
632    over a 1000 duplicates, about a third of the total table size.  Aside
633    from the potential trap of not noticing that two successive entries
634    identify the same location, this duplication impacts the time required
635    to linearly scan the table, which is done in a number of places.  So we
636    just do one linear scan here and toss out the duplicates.
637 
638    Note that we are not concerned here about recovering the space that
639    is potentially freed up, because the strings themselves are allocated
640    on the symbol_obstack, and will get automatically freed when the symbol
641    table is freed.  The caller can free up the unused minimal symbols at
642    the end of the compacted region if their allocation strategy allows it.
643 
644    Also note we only go up to the next to last entry within the loop
645    and then copy the last entry explicitly after the loop terminates.
646 
647    Since the different sources of information for each symbol may
648    have different levels of "completeness", we may have duplicates
649    that have one entry with type "mst_unknown" and the other with a
650    known type.  So if the one we are leaving alone has type mst_unknown,
651    overwrite its type with the type from the one we are compacting out.  */
652 
653 static int
654 compact_minimal_symbols (msymbol, mcount)
655      struct minimal_symbol *msymbol;
656      int mcount;
657 {
658   struct minimal_symbol *copyfrom;
659   struct minimal_symbol *copyto;
660 
661   if (mcount > 0)
662     {
663       copyfrom = copyto = msymbol;
664       while (copyfrom < msymbol + mcount - 1)
665 	{
666 	  if (SYMBOL_VALUE_ADDRESS (copyfrom) ==
667 	      SYMBOL_VALUE_ADDRESS ((copyfrom + 1)) &&
668 	      (STREQ (SYMBOL_NAME (copyfrom), SYMBOL_NAME ((copyfrom + 1)))))
669 	    {
670 	      if (MSYMBOL_TYPE((copyfrom + 1)) == mst_unknown)
671 		{
672 		  MSYMBOL_TYPE ((copyfrom + 1)) = MSYMBOL_TYPE (copyfrom);
673 		}
674 	      copyfrom++;
675 	    }
676 	  else
677 	    {
678 	      *copyto++ = *copyfrom++;
679 	    }
680 	}
681       *copyto++ = *copyfrom++;
682       mcount = copyto - msymbol;
683     }
684   return (mcount);
685 }
686 
687 /* Add the minimal symbols in the existing bunches to the objfile's official
688    minimal symbol table.  In most cases there is no minimal symbol table yet
689    for this objfile, and the existing bunches are used to create one.  Once
690    in a while (for shared libraries for example), we add symbols (e.g. common
691    symbols) to an existing objfile.
692 
693    Because of the way minimal symbols are collected, we generally have no way
694    of knowing what source language applies to any particular minimal symbol.
695    Specifically, we have no way of knowing if the minimal symbol comes from a
696    C++ compilation unit or not.  So for the sake of supporting cached
697    demangled C++ names, we have no choice but to try and demangle each new one
698    that comes in.  If the demangling succeeds, then we assume it is a C++
699    symbol and set the symbol's language and demangled name fields
700    appropriately.  Note that in order to avoid unnecessary demanglings, and
701    allocating obstack space that subsequently can't be freed for the demangled
702    names, we mark all newly added symbols with language_auto.  After
703    compaction of the minimal symbols, we go back and scan the entire minimal
704    symbol table looking for these new symbols.  For each new symbol we attempt
705    to demangle it, and if successful, record it as a language_cplus symbol
706    and cache the demangled form on the symbol obstack.  Symbols which don't
707    demangle are marked as language_unknown symbols, which inhibits future
708    attempts to demangle them if we later add more minimal symbols. */
709 
710 void
711 install_minimal_symbols (objfile)
712      struct objfile *objfile;
713 {
714   register int bindex;
715   register int mcount;
716   register struct msym_bunch *bunch;
717   register struct minimal_symbol *msymbols;
718   int alloc_count;
719   register char leading_char;
720 
721   if (msym_count > 0)
722     {
723       /* Allocate enough space in the obstack, into which we will gather the
724 	 bunches of new and existing minimal symbols, sort them, and then
725 	 compact out the duplicate entries.  Once we have a final table,
726 	 we will give back the excess space.  */
727 
728       alloc_count = msym_count + objfile->minimal_symbol_count + 1;
729       obstack_blank (&objfile->symbol_obstack,
730 		     alloc_count * sizeof (struct minimal_symbol));
731       msymbols = (struct minimal_symbol *)
732 		 obstack_base (&objfile->symbol_obstack);
733 
734       /* Copy in the existing minimal symbols, if there are any.  */
735 
736       if (objfile->minimal_symbol_count)
737         memcpy ((char *)msymbols, (char *)objfile->msymbols,
738 		objfile->minimal_symbol_count * sizeof (struct minimal_symbol));
739 
740       /* Walk through the list of minimal symbol bunches, adding each symbol
741 	 to the new contiguous array of symbols.  Note that we start with the
742 	 current, possibly partially filled bunch (thus we use the current
743 	 msym_bunch_index for the first bunch we copy over), and thereafter
744 	 each bunch is full. */
745 
746       mcount = objfile->minimal_symbol_count;
747       leading_char = get_symbol_leading_char (objfile->obfd);
748 
749       for (bunch = msym_bunch; bunch != NULL; bunch = bunch -> next)
750 	{
751 	  for (bindex = 0; bindex < msym_bunch_index; bindex++, mcount++)
752 	    {
753 	      msymbols[mcount] = bunch -> contents[bindex];
754 	      SYMBOL_LANGUAGE (&msymbols[mcount]) = language_auto;
755 	      if (SYMBOL_NAME (&msymbols[mcount])[0] == leading_char)
756 		{
757 		  SYMBOL_NAME(&msymbols[mcount])++;
758 		}
759 	    }
760 	  msym_bunch_index = BUNCH_SIZE;
761 	}
762 
763       /* Sort the minimal symbols by address.  */
764 
765       qsort (msymbols, mcount, sizeof (struct minimal_symbol),
766 	     compare_minimal_symbols);
767 
768       /* Compact out any duplicates, and free up whatever space we are
769 	 no longer using.  */
770 
771       mcount = compact_minimal_symbols (msymbols, mcount);
772 
773       obstack_blank (&objfile->symbol_obstack,
774 	(mcount + 1 - alloc_count) * sizeof (struct minimal_symbol));
775       msymbols = (struct minimal_symbol *)
776 	obstack_finish (&objfile->symbol_obstack);
777 
778       /* We also terminate the minimal symbol table with a "null symbol",
779 	 which is *not* included in the size of the table.  This makes it
780 	 easier to find the end of the table when we are handed a pointer
781 	 to some symbol in the middle of it.  Zero out the fields in the
782 	 "null symbol" allocated at the end of the array.  Note that the
783 	 symbol count does *not* include this null symbol, which is why it
784 	 is indexed by mcount and not mcount-1. */
785 
786       SYMBOL_NAME (&msymbols[mcount]) = NULL;
787       SYMBOL_VALUE_ADDRESS (&msymbols[mcount]) = 0;
788       MSYMBOL_INFO (&msymbols[mcount]) = NULL;
789       MSYMBOL_TYPE (&msymbols[mcount]) = mst_unknown;
790       SYMBOL_INIT_LANGUAGE_SPECIFIC (&msymbols[mcount], language_unknown);
791 
792       /* Attach the minimal symbol table to the specified objfile.
793 	 The strings themselves are also located in the symbol_obstack
794 	 of this objfile.  */
795 
796       objfile -> minimal_symbol_count = mcount;
797       objfile -> msymbols = msymbols;
798 
799       /* Now walk through all the minimal symbols, selecting the newly added
800 	 ones and attempting to cache their C++ demangled names. */
801 
802       for ( ; mcount-- > 0 ; msymbols++)
803 	{
804 	  SYMBOL_INIT_DEMANGLED_NAME (msymbols, &objfile->symbol_obstack);
805 	}
806     }
807 }
808 
809 /* Sort all the minimal symbols in OBJFILE.  */
810 
811 void
812 msymbols_sort (objfile)
813      struct objfile *objfile;
814 {
815   qsort (objfile->msymbols, objfile->minimal_symbol_count,
816 	 sizeof (struct minimal_symbol), compare_minimal_symbols);
817 }
818 
819 /* Check if PC is in a shared library trampoline code stub.
820    Return minimal symbol for the trampoline entry or NULL if PC is not
821    in a trampoline code stub.  */
822 
823 struct minimal_symbol *
824 lookup_solib_trampoline_symbol_by_pc (pc)
825      CORE_ADDR pc;
826 {
827   struct minimal_symbol *msymbol = lookup_minimal_symbol_by_pc (pc);
828 
829   if (msymbol != NULL && MSYMBOL_TYPE (msymbol) == mst_solib_trampoline)
830     return msymbol;
831   return NULL;
832 }
833 
834 /* If PC is in a shared library trampoline code stub, return the
835    address of the `real' function belonging to the stub.
836    Return 0 if PC is not in a trampoline code stub or if the real
837    function is not found in the minimal symbol table.
838 
839    We may fail to find the right function if a function with the
840    same name is defined in more than one shared library, but this
841    is considered bad programming style. We could return 0 if we find
842    a duplicate function in case this matters someday.  */
843 
844 CORE_ADDR
845 find_solib_trampoline_target (pc)
846      CORE_ADDR pc;
847 {
848   struct objfile *objfile;
849   struct minimal_symbol *msymbol;
850   struct minimal_symbol *tsymbol = lookup_solib_trampoline_symbol_by_pc (pc);
851 
852   if (tsymbol != NULL)
853     {
854       ALL_MSYMBOLS (objfile, msymbol)
855 	{
856 	  if (MSYMBOL_TYPE (msymbol) == mst_text
857 	      && STREQ (SYMBOL_NAME (msymbol), SYMBOL_NAME (tsymbol)))
858 	    return SYMBOL_VALUE_ADDRESS (msymbol);
859 	}
860     }
861   return 0;
862 }
863 
864