1 /* Handle SunOS and SVR4 shared libraries for GDB, the GNU Debugger.
2 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996
3 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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. */
24 /* This file is only compilable if link.h is available. */
28 #include <sys/types.h>
30 #include "gdb_string.h"
31 #include <sys/param.h>
35 #ifndef SVR4_SHARED_LIBS
36 /* SunOS shared libs need the nlist structure. */
39 #include "elf/external.h"
52 #include "gnu-regex.h"
58 #define MAX_PATH_SIZE 512 /* FIXME: Should be dynamic */
60 /* On SVR4 systems, a list of symbols in the dynamic linker where
61 GDB can try to place a breakpoint to monitor shared library
64 If none of these symbols are found, or other errors occur, then
65 SVR4 systems will fall back to using a symbol as the "startup
66 mapping complete" breakpoint address. */
68 #ifdef SVR4_SHARED_LIBS
69 static char *solib_break_names[] = {
77 #define BKPT_AT_SYMBOL 1
79 #if defined (BKPT_AT_SYMBOL) && defined (SVR4_SHARED_LIBS)
80 static char *bkpt_names[] = {
81 #ifdef SOLIB_BKPT_NAME
82 SOLIB_BKPT_NAME, /* Prefer configured name if it exists. */
90 /* Symbols which are used to locate the base of the link map structures. */
92 #ifndef SVR4_SHARED_LIBS
93 static char *debug_base_symbols[] = {
100 static char *main_name_list[] = {
105 /* local data declarations */
107 #ifndef SVR4_SHARED_LIBS
109 #define LM_ADDR(so) ((so) -> lm.lm_addr)
110 #define LM_NEXT(so) ((so) -> lm.lm_next)
111 #define LM_NAME(so) ((so) -> lm.lm_name)
112 /* Test for first link map entry; first entry is a shared library. */
113 #define IGNORE_FIRST_LINK_MAP_ENTRY(x) (0)
114 static struct link_dynamic dynamic_copy;
115 static struct link_dynamic_2 ld_2_copy;
116 static struct ld_debug debug_copy;
117 static CORE_ADDR debug_addr;
118 static CORE_ADDR flag_addr;
120 #else /* SVR4_SHARED_LIBS */
122 #define LM_ADDR(so) ((so) -> lm.l_addr)
123 #define LM_NEXT(so) ((so) -> lm.l_next)
124 #define LM_NAME(so) ((so) -> lm.l_name)
125 /* Test for first link map entry; first entry is the exec-file. */
126 #define IGNORE_FIRST_LINK_MAP_ENTRY(x) ((x).l_prev == NULL)
127 static struct r_debug debug_copy;
128 char shadow_contents[BREAKPOINT_MAX]; /* Stash old bkpt addr contents */
130 #endif /* !SVR4_SHARED_LIBS */
133 struct so_list *next; /* next structure in linked list */
134 struct link_map lm; /* copy of link map from inferior */
135 struct link_map *lmaddr; /* addr in inferior lm was read from */
136 CORE_ADDR lmend; /* upper addr bound of mapped object */
137 char so_name[MAX_PATH_SIZE]; /* shared object lib name (FIXME) */
138 char symbols_loaded; /* flag: symbols read in yet? */
139 char from_tty; /* flag: print msgs? */
140 struct objfile *objfile; /* objfile for loaded lib */
141 struct section_table *sections;
142 struct section_table *sections_end;
143 struct section_table *textsection;
147 static struct so_list *so_list_head; /* List of known shared objects */
148 static CORE_ADDR debug_base; /* Base of dynamic linker structures */
149 static CORE_ADDR breakpoint_addr; /* Address where end bkpt is set */
152 fdmatch PARAMS ((int, int)); /* In libiberty */
154 /* Local function prototypes */
157 special_symbol_handling PARAMS ((struct so_list *));
160 sharedlibrary_command PARAMS ((char *, int));
163 enable_break PARAMS ((void));
166 info_sharedlibrary_command PARAMS ((char *, int));
169 symbol_add_stub PARAMS ((char *));
171 static struct so_list *
172 find_solib PARAMS ((struct so_list *));
174 static struct link_map *
175 first_link_map_member PARAMS ((void));
178 locate_base PARAMS ((void));
181 solib_map_sections PARAMS ((struct so_list *));
183 #ifdef SVR4_SHARED_LIBS
186 elf_locate_base PARAMS ((void));
191 disable_break PARAMS ((void));
194 allocate_rt_common_objfile PARAMS ((void));
197 solib_add_common_symbols PARAMS ((struct rtc_symb *));
201 /* If non-zero, this is a prefix that will be added to the front of the name
202 shared libraries with an absolute filename for loading. */
203 static char *solib_absolute_prefix = NULL;
205 /* If non-empty, this is a search path for loading non-absolute shared library
206 symbol files. This takes precedence over the environment variables PATH
207 and LD_LIBRARY_PATH. */
208 static char *solib_search_path = NULL;
214 solib_map_sections -- open bfd and build sections for shared lib
218 static void solib_map_sections (struct so_list *so)
222 Given a pointer to one of the shared objects in our list
223 of mapped objects, use the recorded name to open a bfd
224 descriptor for the object, build a section table, and then
225 relocate all the section addresses by the base address at
226 which the shared object was mapped.
230 In most (all?) cases the shared object file name recorded in the
231 dynamic linkage tables will be a fully qualified pathname. For
232 cases where it isn't, do we really mimic the systems search
233 mechanism correctly in the below code (particularly the tilde
238 solib_map_sections (so)
242 char *scratch_pathname;
244 struct section_table *p;
245 struct cleanup *old_chain;
248 filename = tilde_expand (so -> so_name);
250 if (solib_absolute_prefix && ROOTED_P (filename))
251 /* Prefix shared libraries with absolute filenames with
252 SOLIB_ABSOLUTE_PREFIX. */
257 pfx_len = strlen (solib_absolute_prefix);
259 /* Remove trailing slashes. */
260 while (pfx_len > 0 && SLASH_P (solib_absolute_prefix[pfx_len - 1]))
263 pfxed_fn = xmalloc (pfx_len + strlen (filename) + 1);
264 strcpy (pfxed_fn, solib_absolute_prefix);
265 strcat (pfxed_fn, filename);
271 old_chain = make_cleanup (free, filename);
275 if (solib_search_path)
276 scratch_chan = openp (solib_search_path,
277 1, filename, O_RDONLY, 0, &scratch_pathname);
278 if (scratch_chan < 0)
279 scratch_chan = openp (get_in_environ (inferior_environ, "PATH"),
280 1, filename, O_RDONLY, 0, &scratch_pathname);
281 if (scratch_chan < 0)
283 scratch_chan = openp (get_in_environ
284 (inferior_environ, "LD_LIBRARY_PATH"),
285 1, filename, O_RDONLY, 0, &scratch_pathname);
287 if (scratch_chan < 0)
289 perror_with_name (filename);
291 /* Leave scratch_pathname allocated. abfd->name will point to it. */
293 abfd = bfd_fdopenr (scratch_pathname, gnutarget, scratch_chan);
296 close (scratch_chan);
297 error ("Could not open `%s' as an executable file: %s",
298 scratch_pathname, bfd_errmsg (bfd_get_error ()));
300 /* Leave bfd open, core_xfer_memory and "info files" need it. */
302 abfd -> cacheable = true;
304 /* copy full path name into so_name, so that later symbol_file_add can find
306 if (strlen (scratch_pathname) >= MAX_PATH_SIZE)
307 error ("Full path name length of shared library exceeds MAX_PATH_SIZE in so_list structure.");
308 strcpy (so->so_name, scratch_pathname);
310 if (!bfd_check_format (abfd, bfd_object))
312 error ("\"%s\": not in executable format: %s.",
313 scratch_pathname, bfd_errmsg (bfd_get_error ()));
315 if (build_section_table (abfd, &so -> sections, &so -> sections_end))
317 error ("Can't find the file sections in `%s': %s",
318 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
321 for (p = so -> sections; p < so -> sections_end; p++)
323 /* Relocate the section binding addresses as recorded in the shared
324 object's file by the base address to which the object was actually
326 p -> addr += (CORE_ADDR) LM_ADDR (so);
327 p -> endaddr += (CORE_ADDR) LM_ADDR (so);
328 so -> lmend = (CORE_ADDR) max (p -> endaddr, so -> lmend);
329 if (STREQ (p -> the_bfd_section -> name, ".text"))
331 so -> textsection = p;
335 /* Free the file names, close the file now. */
336 do_cleanups (old_chain);
339 #ifndef SVR4_SHARED_LIBS
341 /* Allocate the runtime common object file. */
344 allocate_rt_common_objfile ()
346 struct objfile *objfile;
347 struct objfile *last_one;
349 objfile = (struct objfile *) xmalloc (sizeof (struct objfile));
350 memset (objfile, 0, sizeof (struct objfile));
351 objfile -> md = NULL;
352 obstack_specify_allocation (&objfile -> psymbol_cache.cache, 0, 0,
354 obstack_specify_allocation (&objfile -> psymbol_obstack, 0, 0, xmalloc,
356 obstack_specify_allocation (&objfile -> symbol_obstack, 0, 0, xmalloc,
358 obstack_specify_allocation (&objfile -> type_obstack, 0, 0, xmalloc,
360 objfile -> name = mstrsave (objfile -> md, "rt_common");
362 /* Add this file onto the tail of the linked list of other such files. */
364 objfile -> next = NULL;
365 if (object_files == NULL)
366 object_files = objfile;
369 for (last_one = object_files;
371 last_one = last_one -> next);
372 last_one -> next = objfile;
375 rt_common_objfile = objfile;
378 /* Read all dynamically loaded common symbol definitions from the inferior
379 and put them into the minimal symbol table for the runtime common
383 solib_add_common_symbols (rtc_symp)
384 struct rtc_symb *rtc_symp;
386 struct rtc_symb inferior_rtc_symb;
387 struct nlist inferior_rtc_nlist;
391 /* Remove any runtime common symbols from previous runs. */
393 if (rt_common_objfile != NULL && rt_common_objfile -> minimal_symbol_count)
395 obstack_free (&rt_common_objfile -> symbol_obstack, 0);
396 obstack_specify_allocation (&rt_common_objfile -> symbol_obstack, 0, 0,
398 rt_common_objfile -> minimal_symbol_count = 0;
399 rt_common_objfile -> msymbols = NULL;
402 init_minimal_symbol_collection ();
403 make_cleanup (discard_minimal_symbols, 0);
407 read_memory ((CORE_ADDR) rtc_symp,
408 (char *) &inferior_rtc_symb,
409 sizeof (inferior_rtc_symb));
410 read_memory ((CORE_ADDR) inferior_rtc_symb.rtc_sp,
411 (char *) &inferior_rtc_nlist,
412 sizeof(inferior_rtc_nlist));
413 if (inferior_rtc_nlist.n_type == N_COMM)
415 /* FIXME: The length of the symbol name is not available, but in the
416 current implementation the common symbol is allocated immediately
417 behind the name of the symbol. */
418 len = inferior_rtc_nlist.n_value - inferior_rtc_nlist.n_un.n_strx;
420 name = xmalloc (len);
421 read_memory ((CORE_ADDR) inferior_rtc_nlist.n_un.n_name, name, len);
423 /* Allocate the runtime common objfile if necessary. */
424 if (rt_common_objfile == NULL)
425 allocate_rt_common_objfile ();
427 prim_record_minimal_symbol (name, inferior_rtc_nlist.n_value,
428 mst_bss, rt_common_objfile);
431 rtc_symp = inferior_rtc_symb.rtc_next;
434 /* Install any minimal symbols that have been collected as the current
435 minimal symbols for the runtime common objfile. */
437 install_minimal_symbols (rt_common_objfile);
440 #endif /* SVR4_SHARED_LIBS */
443 #ifdef SVR4_SHARED_LIBS
446 bfd_lookup_symbol PARAMS ((bfd *, char *));
452 bfd_lookup_symbol -- lookup the value for a specific symbol
456 CORE_ADDR bfd_lookup_symbol (bfd *abfd, char *symname)
460 An expensive way to lookup the value of a single symbol for
461 bfd's that are only temporary anyway. This is used by the
462 shared library support to find the address of the debugger
463 interface structures in the shared library.
465 Note that 0 is specifically allowed as an error return (no
470 bfd_lookup_symbol (abfd, symname)
474 unsigned int storage_needed;
476 asymbol **symbol_table;
477 unsigned int number_of_symbols;
479 struct cleanup *back_to;
480 CORE_ADDR symaddr = 0;
482 storage_needed = bfd_get_symtab_upper_bound (abfd);
484 if (storage_needed > 0)
486 symbol_table = (asymbol **) xmalloc (storage_needed);
487 back_to = make_cleanup (free, (PTR)symbol_table);
488 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
490 for (i = 0; i < number_of_symbols; i++)
492 sym = *symbol_table++;
493 if (STREQ (sym -> name, symname))
495 /* Bfd symbols are section relative. */
496 symaddr = sym -> value + sym -> section -> vma;
500 do_cleanups (back_to);
505 #ifdef HANDLE_SVR4_EXEC_EMULATORS
508 Solaris BCP (the part of Solaris which allows it to run SunOS4
509 a.out files) throws in another wrinkle. Solaris does not fill
510 in the usual a.out link map structures when running BCP programs,
511 the only way to get at them is via groping around in the dynamic
513 The dynamic linker and it's structures are located in the shared
514 C library, which gets run as the executable's "interpreter" by
517 Note that we can assume nothing about the process state at the time
518 we need to find these structures. We may be stopped on the first
519 instruction of the interpreter (C shared library), the first
520 instruction of the executable itself, or somewhere else entirely
521 (if we attached to the process for example).
524 static char *debug_base_symbols[] = {
525 "r_debug", /* Solaris 2.3 */
526 "_r_debug", /* Solaris 2.1, 2.2 */
531 look_for_base PARAMS ((int, CORE_ADDR));
537 look_for_base -- examine file for each mapped address segment
541 static int look_for_base (int fd, CORE_ADDR baseaddr)
545 This function is passed to proc_iterate_over_mappings, which
546 causes it to get called once for each mapped address space, with
547 an open file descriptor for the file mapped to that space, and the
548 base address of that mapped space.
550 Our job is to find the debug base symbol in the file that this
551 fd is open on, if it exists, and if so, initialize the dynamic
552 linker structure base address debug_base.
554 Note that this is a computationally expensive proposition, since
555 we basically have to open a bfd on every call, so we specifically
556 avoid opening the exec file.
560 look_for_base (fd, baseaddr)
565 CORE_ADDR address = 0;
568 /* If the fd is -1, then there is no file that corresponds to this
569 mapped memory segment, so skip it. Also, if the fd corresponds
570 to the exec file, skip it as well. */
574 && fdmatch (fileno ((GDB_FILE *)(exec_bfd -> iostream)), fd)))
579 /* Try to open whatever random file this fd corresponds to. Note that
580 we have no way currently to find the filename. Don't gripe about
581 any problems we might have, just fail. */
583 if ((interp_bfd = bfd_fdopenr ("unnamed", gnutarget, fd)) == NULL)
587 if (!bfd_check_format (interp_bfd, bfd_object))
589 /* FIXME-leak: on failure, might not free all memory associated with
591 bfd_close (interp_bfd);
595 /* Now try to find our debug base symbol in this file, which we at
596 least know to be a valid ELF executable or shared library. */
598 for (symbolp = debug_base_symbols; *symbolp != NULL; symbolp++)
600 address = bfd_lookup_symbol (interp_bfd, *symbolp);
608 /* FIXME-leak: on failure, might not free all memory associated with
610 bfd_close (interp_bfd);
614 /* Eureka! We found the symbol. But now we may need to relocate it
615 by the base address. If the symbol's value is less than the base
616 address of the shared library, then it hasn't yet been relocated
617 by the dynamic linker, and we have to do it ourself. FIXME: Note
618 that we make the assumption that the first segment that corresponds
619 to the shared library has the base address to which the library
622 if (address < baseaddr)
626 debug_base = address;
627 /* FIXME-leak: on failure, might not free all memory associated with
629 bfd_close (interp_bfd);
632 #endif /* HANDLE_SVR4_EXEC_EMULATORS */
638 elf_locate_base -- locate the base address of dynamic linker structs
639 for SVR4 elf targets.
643 CORE_ADDR elf_locate_base (void)
647 For SVR4 elf targets the address of the dynamic linker's runtime
648 structure is contained within the dynamic info section in the
649 executable file. The dynamic section is also mapped into the
650 inferior address space. Because the runtime loader fills in the
651 real address before starting the inferior, we have to read in the
652 dynamic info section from the inferior address space.
653 If there are any errors while trying to find the address, we
654 silently return 0, otherwise the found address is returned.
661 sec_ptr dyninfo_sect;
662 int dyninfo_sect_size;
663 CORE_ADDR dyninfo_addr;
667 /* Find the start address of the .dynamic section. */
668 dyninfo_sect = bfd_get_section_by_name (exec_bfd, ".dynamic");
669 if (dyninfo_sect == NULL)
671 dyninfo_addr = bfd_section_vma (exec_bfd, dyninfo_sect);
673 /* Read in .dynamic section, silently ignore errors. */
674 dyninfo_sect_size = bfd_section_size (exec_bfd, dyninfo_sect);
675 buf = alloca (dyninfo_sect_size);
676 if (target_read_memory (dyninfo_addr, buf, dyninfo_sect_size))
679 /* Find the DT_DEBUG entry in the the .dynamic section.
680 For mips elf we look for DT_MIPS_RLD_MAP, mips elf apparently has
681 no DT_DEBUG entries. */
682 /* FIXME: In lack of a 64 bit ELF ABI the following code assumes
683 a 32 bit ELF ABI target. */
684 for (bufend = buf + dyninfo_sect_size;
686 buf += sizeof (Elf32_External_Dyn))
688 Elf32_External_Dyn *x_dynp = (Elf32_External_Dyn *)buf;
692 dyn_tag = bfd_h_get_32 (exec_bfd, (bfd_byte *) x_dynp->d_tag);
693 if (dyn_tag == DT_NULL)
695 else if (dyn_tag == DT_DEBUG)
697 dyn_ptr = bfd_h_get_32 (exec_bfd, (bfd_byte *) x_dynp->d_un.d_ptr);
700 #ifdef DT_MIPS_RLD_MAP
701 else if (dyn_tag == DT_MIPS_RLD_MAP)
703 char pbuf[TARGET_PTR_BIT / HOST_CHAR_BIT];
705 /* DT_MIPS_RLD_MAP contains a pointer to the address
706 of the dynamic link structure. */
707 dyn_ptr = bfd_h_get_32 (exec_bfd, (bfd_byte *) x_dynp->d_un.d_ptr);
708 if (target_read_memory (dyn_ptr, pbuf, sizeof (pbuf)))
710 return extract_unsigned_integer (pbuf, sizeof (pbuf));
715 /* DT_DEBUG entry not found. */
719 #endif /* SVR4_SHARED_LIBS */
725 locate_base -- locate the base address of dynamic linker structs
729 CORE_ADDR locate_base (void)
733 For both the SunOS and SVR4 shared library implementations, if the
734 inferior executable has been linked dynamically, there is a single
735 address somewhere in the inferior's data space which is the key to
736 locating all of the dynamic linker's runtime structures. This
737 address is the value of the debug base symbol. The job of this
738 function is to find and return that address, or to return 0 if there
739 is no such address (the executable is statically linked for example).
741 For SunOS, the job is almost trivial, since the dynamic linker and
742 all of it's structures are statically linked to the executable at
743 link time. Thus the symbol for the address we are looking for has
744 already been added to the minimal symbol table for the executable's
745 objfile at the time the symbol file's symbols were read, and all we
746 have to do is look it up there. Note that we explicitly do NOT want
747 to find the copies in the shared library.
749 The SVR4 version is a bit more complicated because the address
750 is contained somewhere in the dynamic info section. We have to go
751 to a lot more work to discover the address of the debug base symbol.
752 Because of this complexity, we cache the value we find and return that
753 value on subsequent invocations. Note there is no copy in the
754 executable symbol tables.
762 #ifndef SVR4_SHARED_LIBS
764 struct minimal_symbol *msymbol;
765 CORE_ADDR address = 0;
768 /* For SunOS, we want to limit the search for the debug base symbol to the
769 executable being debugged, since there is a duplicate named symbol in the
770 shared library. We don't want the shared library versions. */
772 for (symbolp = debug_base_symbols; *symbolp != NULL; symbolp++)
774 msymbol = lookup_minimal_symbol (*symbolp, NULL, symfile_objfile);
775 if ((msymbol != NULL) && (SYMBOL_VALUE_ADDRESS (msymbol) != 0))
777 address = SYMBOL_VALUE_ADDRESS (msymbol);
783 #else /* SVR4_SHARED_LIBS */
785 /* Check to see if we have a currently valid address, and if so, avoid
786 doing all this work again and just return the cached address. If
787 we have no cached address, try to locate it in the dynamic info
788 section for ELF executables. */
793 && bfd_get_flavour (exec_bfd) == bfd_target_elf_flavour)
794 debug_base = elf_locate_base ();
795 #ifdef HANDLE_SVR4_EXEC_EMULATORS
796 /* Try it the hard way for emulated executables. */
797 else if (inferior_pid != 0 && target_has_execution)
798 proc_iterate_over_mappings (look_for_base);
803 #endif /* !SVR4_SHARED_LIBS */
811 first_link_map_member -- locate first member in dynamic linker's map
815 static struct link_map *first_link_map_member (void)
819 Read in a copy of the first member in the inferior's dynamic
820 link map from the inferior's dynamic linker structures, and return
821 a pointer to the copy in our address space.
824 static struct link_map *
825 first_link_map_member ()
827 struct link_map *lm = NULL;
829 #ifndef SVR4_SHARED_LIBS
831 read_memory (debug_base, (char *) &dynamic_copy, sizeof (dynamic_copy));
832 if (dynamic_copy.ld_version >= 2)
834 /* It is a version that we can deal with, so read in the secondary
835 structure and find the address of the link map list from it. */
836 read_memory ((CORE_ADDR) dynamic_copy.ld_un.ld_2, (char *) &ld_2_copy,
837 sizeof (struct link_dynamic_2));
838 lm = ld_2_copy.ld_loaded;
841 #else /* SVR4_SHARED_LIBS */
843 read_memory (debug_base, (char *) &debug_copy, sizeof (struct r_debug));
844 /* FIXME: Perhaps we should validate the info somehow, perhaps by
845 checking r_version for a known version number, or r_state for
847 lm = debug_copy.r_map;
849 #endif /* !SVR4_SHARED_LIBS */
858 find_solib -- step through list of shared objects
862 struct so_list *find_solib (struct so_list *so_list_ptr)
866 This module contains the routine which finds the names of any
867 loaded "images" in the current process. The argument in must be
868 NULL on the first call, and then the returned value must be passed
869 in on subsequent calls. This provides the capability to "step" down
870 the list of loaded objects. On the last object, a NULL value is
873 The arg and return value are "struct link_map" pointers, as defined
877 static struct so_list *
878 find_solib (so_list_ptr)
879 struct so_list *so_list_ptr; /* Last lm or NULL for first one */
881 struct so_list *so_list_next = NULL;
882 struct link_map *lm = NULL;
885 if (so_list_ptr == NULL)
887 /* We are setting up for a new scan through the loaded images. */
888 if ((so_list_next = so_list_head) == NULL)
890 /* We have not already read in the dynamic linking structures
891 from the inferior, lookup the address of the base structure. */
892 debug_base = locate_base ();
895 /* Read the base structure in and find the address of the first
896 link map list member. */
897 lm = first_link_map_member ();
903 /* We have been called before, and are in the process of walking
904 the shared library list. Advance to the next shared object. */
905 if ((lm = LM_NEXT (so_list_ptr)) == NULL)
907 /* We have hit the end of the list, so check to see if any were
908 added, but be quiet if we can't read from the target any more. */
909 int status = target_read_memory ((CORE_ADDR) so_list_ptr -> lmaddr,
910 (char *) &(so_list_ptr -> lm),
911 sizeof (struct link_map));
914 lm = LM_NEXT (so_list_ptr);
921 so_list_next = so_list_ptr -> next;
923 if ((so_list_next == NULL) && (lm != NULL))
925 /* Get next link map structure from inferior image and build a local
926 abbreviated load_map structure */
927 new = (struct so_list *) xmalloc (sizeof (struct so_list));
928 memset ((char *) new, 0, sizeof (struct so_list));
930 /* Add the new node as the next node in the list, or as the root
931 node if this is the first one. */
932 if (so_list_ptr != NULL)
934 so_list_ptr -> next = new;
941 read_memory ((CORE_ADDR) lm, (char *) &(new -> lm),
942 sizeof (struct link_map));
943 /* For SVR4 versions, the first entry in the link map is for the
944 inferior executable, so we must ignore it. For some versions of
945 SVR4, it has no name. For others (Solaris 2.3 for example), it
946 does have a name, so we can no longer use a missing name to
947 decide when to ignore it. */
948 if (!IGNORE_FIRST_LINK_MAP_ENTRY (new -> lm))
952 target_read_string ((CORE_ADDR) LM_NAME (new), &buffer,
953 MAX_PATH_SIZE - 1, &errcode);
955 error ("find_solib: Can't read pathname for load map: %s\n",
956 safe_strerror (errcode));
957 strncpy (new -> so_name, buffer, MAX_PATH_SIZE - 1);
958 new -> so_name[MAX_PATH_SIZE - 1] = '\0';
960 solib_map_sections (new);
963 return (so_list_next);
966 /* A small stub to get us past the arg-passing pinhole of catch_errors. */
969 symbol_add_stub (arg)
972 register struct so_list *so = (struct so_list *) arg; /* catch_errs bogon */
975 symbol_file_add (so -> so_name, so -> from_tty,
976 (so->textsection == NULL
978 : (unsigned int) so -> textsection -> addr),
983 /* This function will check the so name to see if matches the main list.
984 In some system the main object is in the list, which we want to exclude */
986 static int match_main (soname)
991 for (mainp = main_name_list; *mainp != NULL; mainp++)
993 if (strcmp (soname, *mainp) == 0)
1004 solib_add -- add a shared library file to the symtab and section list
1008 void solib_add (char *arg_string, int from_tty,
1009 struct target_ops *target)
1016 solib_add (arg_string, from_tty, target)
1019 struct target_ops *target;
1021 register struct so_list *so = NULL; /* link map state variable */
1023 /* Last shared library that we read. */
1024 struct so_list *so_last = NULL;
1030 if ((re_err = re_comp (arg_string ? arg_string : ".")) != NULL)
1032 error ("Invalid regexp: %s", re_err);
1035 /* Add the shared library sections to the section table of the
1036 specified target, if any. */
1039 /* Count how many new section_table entries there are. */
1042 while ((so = find_solib (so)) != NULL)
1044 if (so -> so_name[0] && !match_main (so -> so_name))
1046 count += so -> sections_end - so -> sections;
1054 /* We must update the to_sections field in the core_ops structure
1055 here, otherwise we dereference a potential dangling pointer
1056 for each call to target_read/write_memory within this routine. */
1057 update_coreops = core_ops.to_sections == target->to_sections;
1059 /* Reallocate the target's section table including the new size. */
1060 if (target -> to_sections)
1062 old = target -> to_sections_end - target -> to_sections;
1063 target -> to_sections = (struct section_table *)
1064 xrealloc ((char *)target -> to_sections,
1065 (sizeof (struct section_table)) * (count + old));
1070 target -> to_sections = (struct section_table *)
1071 xmalloc ((sizeof (struct section_table)) * count);
1073 target -> to_sections_end = target -> to_sections + (count + old);
1075 /* Update the to_sections field in the core_ops structure
1079 core_ops.to_sections = target->to_sections;
1080 core_ops.to_sections_end = target->to_sections_end;
1083 /* Add these section table entries to the target's table. */
1084 while ((so = find_solib (so)) != NULL)
1086 if (so -> so_name[0])
1088 count = so -> sections_end - so -> sections;
1089 memcpy ((char *) (target -> to_sections + old),
1091 (sizeof (struct section_table)) * count);
1098 /* Now add the symbol files. */
1099 while ((so = find_solib (so)) != NULL)
1101 if (so -> so_name[0] && re_exec (so -> so_name) &&
1102 !match_main (so -> so_name))
1104 so -> from_tty = from_tty;
1105 if (so -> symbols_loaded)
1109 printf_unfiltered ("Symbols already loaded for %s\n", so -> so_name);
1112 else if (catch_errors
1113 (symbol_add_stub, (char *) so,
1114 "Error while reading shared library symbols:\n",
1118 so -> symbols_loaded = 1;
1123 /* Getting new symbols may change our opinion about what is
1126 reinit_frame_cache ();
1129 special_symbol_handling (so_last);
1136 info_sharedlibrary_command -- code for "info sharedlibrary"
1140 static void info_sharedlibrary_command ()
1144 Walk through the shared library list and print information
1145 about each attached library.
1149 info_sharedlibrary_command (ignore, from_tty)
1153 register struct so_list *so = NULL; /* link map state variable */
1154 int header_done = 0;
1156 if (exec_bfd == NULL)
1158 printf_unfiltered ("No exec file.\n");
1161 while ((so = find_solib (so)) != NULL)
1163 if (so -> so_name[0])
1167 printf_unfiltered("%-12s%-12s%-12s%s\n", "From", "To", "Syms Read",
1168 "Shared Object Library");
1171 /* FIXME-32x64: need print_address_numeric with field width or
1173 printf_unfiltered ("%-12s",
1174 local_hex_string_custom ((unsigned long) LM_ADDR (so),
1176 printf_unfiltered ("%-12s",
1177 local_hex_string_custom ((unsigned long) so -> lmend,
1179 printf_unfiltered ("%-12s", so -> symbols_loaded ? "Yes" : "No");
1180 printf_unfiltered ("%s\n", so -> so_name);
1183 if (so_list_head == NULL)
1185 printf_unfiltered ("No shared libraries loaded at this time.\n");
1193 solib_address -- check to see if an address is in a shared lib
1197 char * solib_address (CORE_ADDR address)
1201 Provides a hook for other gdb routines to discover whether or
1202 not a particular address is within the mapped address space of
1203 a shared library. Any address between the base mapping address
1204 and the first address beyond the end of the last mapping, is
1205 considered to be within the shared library address space, for
1208 For example, this routine is called at one point to disable
1209 breakpoints which are in shared libraries that are not currently
1214 solib_address (address)
1217 register struct so_list *so = 0; /* link map state variable */
1219 while ((so = find_solib (so)) != NULL)
1221 if (so -> so_name[0])
1223 if ((address >= (CORE_ADDR) LM_ADDR (so)) &&
1224 (address < (CORE_ADDR) so -> lmend))
1225 return (so->so_name);
1231 /* Called by free_all_symtabs */
1236 struct so_list *next;
1239 while (so_list_head)
1241 if (so_list_head -> sections)
1243 free ((PTR)so_list_head -> sections);
1245 if (so_list_head -> abfd)
1247 bfd_filename = bfd_get_filename (so_list_head -> abfd);
1248 if (!bfd_close (so_list_head -> abfd))
1249 warning ("cannot close \"%s\": %s",
1250 bfd_filename, bfd_errmsg (bfd_get_error ()));
1253 /* This happens for the executable on SVR4. */
1254 bfd_filename = NULL;
1256 next = so_list_head -> next;
1258 free ((PTR)bfd_filename);
1259 free ((PTR)so_list_head);
1260 so_list_head = next;
1269 disable_break -- remove the "mapping changed" breakpoint
1273 static int disable_break ()
1277 Removes the breakpoint that gets hit when the dynamic linker
1278 completes a mapping change.
1282 #ifndef SVR4_SHARED_LIBS
1289 #ifndef SVR4_SHARED_LIBS
1291 int in_debugger = 0;
1293 /* Read the debugger structure from the inferior to retrieve the
1294 address of the breakpoint and the original contents of the
1295 breakpoint address. Remove the breakpoint by writing the original
1298 read_memory (debug_addr, (char *) &debug_copy, sizeof (debug_copy));
1300 /* Set `in_debugger' to zero now. */
1302 write_memory (flag_addr, (char *) &in_debugger, sizeof (in_debugger));
1304 breakpoint_addr = (CORE_ADDR) debug_copy.ldd_bp_addr;
1305 write_memory (breakpoint_addr, (char *) &debug_copy.ldd_bp_inst,
1306 sizeof (debug_copy.ldd_bp_inst));
1308 #else /* SVR4_SHARED_LIBS */
1310 /* Note that breakpoint address and original contents are in our address
1311 space, so we just need to write the original contents back. */
1313 if (memory_remove_breakpoint (breakpoint_addr, shadow_contents) != 0)
1318 #endif /* !SVR4_SHARED_LIBS */
1320 /* For the SVR4 version, we always know the breakpoint address. For the
1321 SunOS version we don't know it until the above code is executed.
1322 Grumble if we are stopped anywhere besides the breakpoint address. */
1324 if (stop_pc != breakpoint_addr)
1326 warning ("stopped at unknown breakpoint while handling shared libraries");
1332 #endif /* #ifdef SVR4_SHARED_LIBS */
1338 enable_break -- arrange for dynamic linker to hit breakpoint
1342 int enable_break (void)
1346 Both the SunOS and the SVR4 dynamic linkers have, as part of their
1347 debugger interface, support for arranging for the inferior to hit
1348 a breakpoint after mapping in the shared libraries. This function
1349 enables that breakpoint.
1351 For SunOS, there is a special flag location (in_debugger) which we
1352 set to 1. When the dynamic linker sees this flag set, it will set
1353 a breakpoint at a location known only to itself, after saving the
1354 original contents of that place and the breakpoint address itself,
1355 in it's own internal structures. When we resume the inferior, it
1356 will eventually take a SIGTRAP when it runs into the breakpoint.
1357 We handle this (in a different place) by restoring the contents of
1358 the breakpointed location (which is only known after it stops),
1359 chasing around to locate the shared libraries that have been
1360 loaded, then resuming.
1362 For SVR4, the debugger interface structure contains a member (r_brk)
1363 which is statically initialized at the time the shared library is
1364 built, to the offset of a function (_r_debug_state) which is guaran-
1365 teed to be called once before mapping in a library, and again when
1366 the mapping is complete. At the time we are examining this member,
1367 it contains only the unrelocated offset of the function, so we have
1368 to do our own relocation. Later, when the dynamic linker actually
1369 runs, it relocates r_brk to be the actual address of _r_debug_state().
1371 The debugger interface structure also contains an enumeration which
1372 is set to either RT_ADD or RT_DELETE prior to changing the mapping,
1373 depending upon whether or not the library is being mapped or unmapped,
1374 and then set to RT_CONSISTENT after the library is mapped/unmapped.
1382 #ifndef SVR4_SHARED_LIBS
1387 /* Get link_dynamic structure */
1389 j = target_read_memory (debug_base, (char *) &dynamic_copy,
1390 sizeof (dynamic_copy));
1397 /* Calc address of debugger interface structure */
1399 debug_addr = (CORE_ADDR) dynamic_copy.ldd;
1401 /* Calc address of `in_debugger' member of debugger interface structure */
1403 flag_addr = debug_addr + (CORE_ADDR) ((char *) &debug_copy.ldd_in_debugger -
1404 (char *) &debug_copy);
1406 /* Write a value of 1 to this member. */
1409 write_memory (flag_addr, (char *) &in_debugger, sizeof (in_debugger));
1412 #else /* SVR4_SHARED_LIBS */
1414 #ifdef BKPT_AT_SYMBOL
1416 struct minimal_symbol *msymbol;
1418 asection *interp_sect;
1420 /* First, remove all the solib event breakpoints. Their addresses
1421 may have changed since the last time we ran the program. */
1422 remove_solib_event_breakpoints ();
1424 #ifdef SVR4_SHARED_LIBS
1425 /* Find the .interp section; if not found, warn the user and drop
1426 into the old breakpoint at symbol code. */
1427 interp_sect = bfd_get_section_by_name (exec_bfd, ".interp");
1430 unsigned int interp_sect_size;
1432 CORE_ADDR load_addr;
1434 CORE_ADDR sym_addr = 0;
1436 /* Read the contents of the .interp section into a local buffer;
1437 the contents specify the dynamic linker this program uses. */
1438 interp_sect_size = bfd_section_size (exec_bfd, interp_sect);
1439 buf = alloca (interp_sect_size);
1440 bfd_get_section_contents (exec_bfd, interp_sect,
1441 buf, 0, interp_sect_size);
1443 /* Now we need to figure out where the dynamic linker was
1444 loaded so that we can load its symbols and place a breakpoint
1445 in the dynamic linker itself.
1447 This address is stored on the stack. However, I've been unable
1448 to find any magic formula to find it for Solaris (appears to
1449 be trivial on Linux). Therefore, we have to try an alternate
1450 mechanism to find the dynamic linker's base address. */
1451 tmp_bfd = bfd_openr (buf, gnutarget);
1452 if (tmp_bfd == NULL)
1453 goto bkpt_at_symbol;
1455 /* Make sure the dynamic linker's really a useful object. */
1456 if (!bfd_check_format (tmp_bfd, bfd_object))
1458 warning ("Unable to grok dynamic linker %s as an object file", buf);
1459 bfd_close (tmp_bfd);
1460 goto bkpt_at_symbol;
1463 /* We find the dynamic linker's base address by examining the
1464 current pc (which point at the entry point for the dynamic
1465 linker) and subtracting the offset of the entry point. */
1466 load_addr = read_pc () - tmp_bfd->start_address;
1468 /* Now try to set a breakpoint in the dynamic linker. */
1469 for (bkpt_namep = solib_break_names; *bkpt_namep != NULL; bkpt_namep++)
1471 sym_addr = bfd_lookup_symbol (tmp_bfd, *bkpt_namep);
1476 /* We're done with the temporary bfd. */
1477 bfd_close (tmp_bfd);
1481 create_solib_event_breakpoint (load_addr + sym_addr);
1485 /* For whatever reason we couldn't set a breakpoint in the dynamic
1486 linker. Warn and drop into the old code. */
1488 warning ("Unable to find dynamic linker breakpoint function.");
1489 warning ("GDB will be unable to debug shared library initializers");
1490 warning ("and track explicitly loaded dynamic code.");
1494 /* Scan through the list of symbols, trying to look up the symbol and
1495 set a breakpoint there. Terminate loop when we/if we succeed. */
1497 breakpoint_addr = 0;
1498 for (bkpt_namep = bkpt_names; *bkpt_namep != NULL; bkpt_namep++)
1500 msymbol = lookup_minimal_symbol (*bkpt_namep, NULL, symfile_objfile);
1501 if ((msymbol != NULL) && (SYMBOL_VALUE_ADDRESS (msymbol) != 0))
1503 create_solib_event_breakpoint (SYMBOL_VALUE_ADDRESS (msymbol));
1508 /* Nothing good happened. */
1511 #endif /* BKPT_AT_SYMBOL */
1513 #endif /* !SVR4_SHARED_LIBS */
1522 solib_create_inferior_hook -- shared library startup support
1526 void solib_create_inferior_hook()
1530 When gdb starts up the inferior, it nurses it along (through the
1531 shell) until it is ready to execute it's first instruction. At this
1532 point, this function gets called via expansion of the macro
1533 SOLIB_CREATE_INFERIOR_HOOK.
1535 For SunOS executables, this first instruction is typically the
1536 one at "_start", or a similar text label, regardless of whether
1537 the executable is statically or dynamically linked. The runtime
1538 startup code takes care of dynamically linking in any shared
1539 libraries, once gdb allows the inferior to continue.
1541 For SVR4 executables, this first instruction is either the first
1542 instruction in the dynamic linker (for dynamically linked
1543 executables) or the instruction at "start" for statically linked
1544 executables. For dynamically linked executables, the system
1545 first exec's /lib/libc.so.N, which contains the dynamic linker,
1546 and starts it running. The dynamic linker maps in any needed
1547 shared libraries, maps in the actual user executable, and then
1548 jumps to "start" in the user executable.
1550 For both SunOS shared libraries, and SVR4 shared libraries, we
1551 can arrange to cooperate with the dynamic linker to discover the
1552 names of shared libraries that are dynamically linked, and the
1553 base addresses to which they are linked.
1555 This function is responsible for discovering those names and
1556 addresses, and saving sufficient information about them to allow
1557 their symbols to be read at a later time.
1561 Between enable_break() and disable_break(), this code does not
1562 properly handle hitting breakpoints which the user might have
1563 set in the startup code or in the dynamic linker itself. Proper
1564 handling will probably have to wait until the implementation is
1565 changed to use the "breakpoint handler function" method.
1567 Also, what if child has exit()ed? Must exit loop somehow.
1571 solib_create_inferior_hook()
1573 /* If we are using the BKPT_AT_SYMBOL code, then we don't need the base
1574 yet. In fact, in the case of a SunOS4 executable being run on
1575 Solaris, we can't get it yet. find_solib will get it when it needs
1577 #if !(defined (SVR4_SHARED_LIBS) && defined (BKPT_AT_SYMBOL))
1578 if ((debug_base = locate_base ()) == 0)
1580 /* Can't find the symbol or the executable is statically linked. */
1585 if (!enable_break ())
1587 warning ("shared library handler failed to enable breakpoint");
1591 #ifndef SVR4_SHARED_LIBS
1592 /* Only SunOS needs the loop below, other systems should be using the
1593 special shared library breakpoints and the shared library breakpoint
1596 Now run the target. It will eventually hit the breakpoint, at
1597 which point all of the libraries will have been mapped in and we
1598 can go groveling around in the dynamic linker structures to find
1599 out what we need to know about them. */
1601 clear_proceed_status ();
1602 stop_soon_quietly = 1;
1603 stop_signal = TARGET_SIGNAL_0;
1606 target_resume (-1, 0, stop_signal);
1607 wait_for_inferior ();
1609 while (stop_signal != TARGET_SIGNAL_TRAP);
1610 stop_soon_quietly = 0;
1612 /* We are now either at the "mapping complete" breakpoint (or somewhere
1613 else, a condition we aren't prepared to deal with anyway), so adjust
1614 the PC as necessary after a breakpoint, disable the breakpoint, and
1615 add any shared libraries that were mapped in. */
1617 if (DECR_PC_AFTER_BREAK)
1619 stop_pc -= DECR_PC_AFTER_BREAK;
1620 write_register (PC_REGNUM, stop_pc);
1623 if (!disable_break ())
1625 warning ("shared library handler failed to disable breakpoint");
1629 solib_add ((char *) 0, 0, (struct target_ops *) 0);
1637 special_symbol_handling -- additional shared library symbol handling
1641 void special_symbol_handling (struct so_list *so)
1645 Once the symbols from a shared object have been loaded in the usual
1646 way, we are called to do any system specific symbol handling that
1649 For SunOS4, this consists of grunging around in the dynamic
1650 linkers structures to find symbol definitions for "common" symbols
1651 and adding them to the minimal symbol table for the runtime common
1657 special_symbol_handling (so)
1660 #ifndef SVR4_SHARED_LIBS
1663 if (debug_addr == 0)
1665 /* Get link_dynamic structure */
1667 j = target_read_memory (debug_base, (char *) &dynamic_copy,
1668 sizeof (dynamic_copy));
1675 /* Calc address of debugger interface structure */
1676 /* FIXME, this needs work for cross-debugging of core files
1677 (byteorder, size, alignment, etc). */
1679 debug_addr = (CORE_ADDR) dynamic_copy.ldd;
1682 /* Read the debugger structure from the inferior, just to make sure
1683 we have a current copy. */
1685 j = target_read_memory (debug_addr, (char *) &debug_copy,
1686 sizeof (debug_copy));
1688 return; /* unreadable */
1690 /* Get common symbol definitions for the loaded object. */
1692 if (debug_copy.ldd_cp)
1694 solib_add_common_symbols (debug_copy.ldd_cp);
1697 #endif /* !SVR4_SHARED_LIBS */
1705 sharedlibrary_command -- handle command to explicitly add library
1709 static void sharedlibrary_command (char *args, int from_tty)
1716 sharedlibrary_command (args, from_tty)
1721 solib_add (args, from_tty, (struct target_ops *) 0);
1724 #endif /* HAVE_LINK_H */
1731 add_com ("sharedlibrary", class_files, sharedlibrary_command,
1732 "Load shared object library symbols for files matching REGEXP.");
1733 add_info ("sharedlibrary", info_sharedlibrary_command,
1734 "Status of loaded shared object libraries.");
1737 (add_set_cmd ("auto-solib-add", class_support, var_zinteger,
1738 (char *) &auto_solib_add,
1739 "Set autoloading of shared library symbols.\n\
1740 If nonzero, symbols from all shared object libraries will be loaded\n\
1741 automatically when the inferior begins execution or when the dynamic linker\n\
1742 informs gdb that a new library has been loaded. Otherwise, symbols\n\
1743 must be loaded manually, using `sharedlibrary'.",
1748 (add_set_cmd ("solib-absolute-prefix", class_support, var_filename,
1749 (char *) &solib_absolute_prefix,
1750 "Set prefix for loading absolute shared library symbol files.\n
1751 For other (relative) files, you can add values using `set solib-search-path'.",
1755 (add_set_cmd ("solib-search-path", class_support, var_string,
1756 (char *) &solib_search_path,
1757 "Set the search path for loading non-absolute shared library symbol files.\n
1758 This takes precedence over the environment variables PATH and LD_LIBRARY_PATH.",
1762 #endif /* HAVE_LINK_H */