1 /* Handle shared libraries for GDB, the GNU Debugger.
2 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
25 #include <sys/types.h>
27 #include "gdb_string.h"
36 #include "gdb_regex.h"
41 #include "completer.h"
45 /* external data declarations */
47 /* FIXME: gdbarch needs to control this variable */
48 struct target_so_ops
*current_target_so_ops
;
50 /* local data declarations */
52 static struct so_list
*so_list_head
; /* List of known shared objects */
54 static int solib_cleanup_queued
= 0; /* make_run_cleanup called */
56 /* Local function prototypes */
58 static void do_clear_solib (PTR
);
60 /* If non-zero, this is a prefix that will be added to the front of the name
61 shared libraries with an absolute filename for loading. */
62 static char *solib_absolute_prefix
= NULL
;
64 /* If non-empty, this is a search path for loading non-absolute shared library
65 symbol files. This takes precedence over the environment variables PATH
66 and LD_LIBRARY_PATH. */
67 static char *solib_search_path
= NULL
;
73 solib_open -- Find a shared library file and open it.
77 int solib_open (char *in_patname, char **found_pathname);
81 Global variable SOLIB_ABSOLUTE_PREFIX is used as a prefix directory
82 to search for shared libraries if they have an absolute path.
84 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
85 (or set of directories, as in LD_LIBRARY_PATH) to search for all
86 shared libraries if not found in SOLIB_ABSOLUTE_PREFIX.
89 * If path is absolute, look in SOLIB_ABSOLUTE_PREFIX.
90 * If path is absolute or relative, look for it literally (unmodified).
91 * Look in SOLIB_SEARCH_PATH.
92 * Look in inferior's $PATH.
93 * Look in inferior's $LD_LIBRARY_PATH.
97 file handle for opened solib, or -1 for failure. */
100 solib_open (char *in_pathname
, char **found_pathname
)
103 char *temp_pathname
= NULL
;
105 if (strchr (in_pathname
, SLASH_CHAR
))
107 if (! ROOTED_P (in_pathname
) || solib_absolute_prefix
== NULL
)
108 temp_pathname
= in_pathname
;
111 int prefix_len
= strlen (solib_absolute_prefix
);
113 /* Remove trailing slashes from absolute prefix. */
114 while (prefix_len
> 0
115 && SLASH_P (solib_absolute_prefix
[prefix_len
- 1]))
118 /* Cat the prefixed pathname together. */
119 temp_pathname
= alloca (prefix_len
+ strlen (in_pathname
) + 1);
120 strncpy (temp_pathname
, solib_absolute_prefix
, prefix_len
);
121 temp_pathname
[prefix_len
] = '\0';
122 strcat (temp_pathname
, in_pathname
);
125 /* Now see if we can open it. */
126 found_file
= open (temp_pathname
, O_RDONLY
, 0);
129 /* If not found, next search the solib_search_path (if any). */
130 if (found_file
< 0 && solib_search_path
!= NULL
)
131 found_file
= openp (solib_search_path
,
132 1, in_pathname
, O_RDONLY
, 0, &temp_pathname
);
134 /* If not found, next search the inferior's $PATH environment variable. */
135 if (found_file
< 0 && solib_search_path
!= NULL
)
136 found_file
= openp (get_in_environ (inferior_environ
, "PATH"),
137 1, in_pathname
, O_RDONLY
, 0, &temp_pathname
);
139 /* If not found, next search the inferior's $LD_LIBRARY_PATH
140 environment variable. */
141 if (found_file
< 0 && solib_search_path
!= NULL
)
142 found_file
= openp (get_in_environ (inferior_environ
, "LD_LIBRARY_PATH"),
143 1, in_pathname
, O_RDONLY
, 0, &temp_pathname
);
145 /* Done. If not found, tough luck. Return found_file and
146 (optionally) found_pathname. */
147 if (found_pathname
!= NULL
&& temp_pathname
!= NULL
)
148 *found_pathname
= xstrdup (temp_pathname
);
157 solib_map_sections -- open bfd and build sections for shared lib
161 static int solib_map_sections (struct so_list *so)
165 Given a pointer to one of the shared objects in our list
166 of mapped objects, use the recorded name to open a bfd
167 descriptor for the object, build a section table, and then
168 relocate all the section addresses by the base address at
169 which the shared object was mapped.
173 In most (all?) cases the shared object file name recorded in the
174 dynamic linkage tables will be a fully qualified pathname. For
175 cases where it isn't, do we really mimic the systems search
176 mechanism correctly in the below code (particularly the tilde
181 solib_map_sections (PTR arg
)
183 struct so_list
*so
= (struct so_list
*) arg
; /* catch_errors bogon */
185 char *scratch_pathname
;
187 struct section_table
*p
;
188 struct cleanup
*old_chain
;
191 filename
= tilde_expand (so
->so_name
);
193 old_chain
= make_cleanup (xfree
, filename
);
194 scratch_chan
= solib_open (filename
, &scratch_pathname
);
196 if (scratch_chan
< 0)
198 perror_with_name (filename
);
201 /* Leave scratch_pathname allocated. abfd->name will point to it. */
202 abfd
= bfd_fdopenr (scratch_pathname
, gnutarget
, scratch_chan
);
205 close (scratch_chan
);
206 error ("Could not open `%s' as an executable file: %s",
207 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
210 /* Leave bfd open, core_xfer_memory and "info files" need it. */
212 abfd
->cacheable
= true;
214 /* copy full path name into so_name, so that later symbol_file_add
216 if (strlen (scratch_pathname
) >= SO_NAME_MAX_PATH_SIZE
)
217 error ("Full path name length of shared library exceeds SO_NAME_MAX_PATH_SIZE in so_list structure.");
218 strcpy (so
->so_name
, scratch_pathname
);
220 if (!bfd_check_format (abfd
, bfd_object
))
222 error ("\"%s\": not in executable format: %s.",
223 scratch_pathname
, bfd_errmsg (bfd_get_error ()));
225 if (build_section_table (abfd
, &so
->sections
, &so
->sections_end
))
227 error ("Can't find the file sections in `%s': %s",
228 bfd_get_filename (abfd
), bfd_errmsg (bfd_get_error ()));
231 for (p
= so
->sections
; p
< so
->sections_end
; p
++)
233 /* Relocate the section binding addresses as recorded in the shared
234 object's file by the base address to which the object was actually
236 TARGET_SO_RELOCATE_SECTION_ADDRESSES (so
, p
);
237 if (STREQ (p
->the_bfd_section
->name
, ".text"))
243 /* Free the file names, close the file now. */
244 do_cleanups (old_chain
);
251 free_so --- free a `struct so_list' object
255 void free_so (struct so_list *so)
259 Free the storage associated with the `struct so_list' object SO.
260 If we have opened a BFD for SO, close it.
262 The caller is responsible for removing SO from whatever list it is
263 a member of. If we have placed SO's sections in some target's
264 section table, the caller is responsible for removing them.
266 This function doesn't mess with objfiles at all. If there is an
267 objfile associated with SO that needs to be removed, the caller is
268 responsible for taking care of that. */
271 free_so (struct so_list
*so
)
273 char *bfd_filename
= 0;
276 xfree (so
->sections
);
280 bfd_filename
= bfd_get_filename (so
->abfd
);
281 if (! bfd_close (so
->abfd
))
282 warning ("cannot close \"%s\": %s",
283 bfd_filename
, bfd_errmsg (bfd_get_error ()));
287 xfree (bfd_filename
);
289 TARGET_SO_FREE_SO (so
);
295 /* A small stub to get us past the arg-passing pinhole of catch_errors. */
298 symbol_add_stub (PTR arg
)
300 register struct so_list
*so
= (struct so_list
*) arg
; /* catch_errs bogon */
301 struct section_addr_info
*sap
;
303 /* Have we already loaded this shared object? */
304 ALL_OBJFILES (so
->objfile
)
306 if (strcmp (so
->objfile
->name
, so
->so_name
) == 0)
310 sap
= build_section_addr_info_from_section_table (so
->sections
,
313 so
->objfile
= symbol_file_add (so
->so_name
, so
->from_tty
,
314 sap
, 0, OBJF_SHARED
);
315 free_section_addr_info (sap
);
323 update_solib_list --- synchronize GDB's shared object list with inferior's
327 void update_solib_list (int from_tty, struct target_ops *TARGET)
329 Extract the list of currently loaded shared objects from the
330 inferior, and compare it with the list of shared objects currently
331 in GDB's so_list_head list. Edit so_list_head to bring it in sync
332 with the inferior's new list.
334 If we notice that the inferior has unloaded some shared objects,
335 free any symbolic info GDB had read about those shared objects.
337 Don't load symbolic info for any new shared objects; just add them
338 to the list, and leave their symbols_loaded flag clear.
340 If FROM_TTY is non-null, feel free to print messages about what
343 If TARGET is non-null, add the sections of all new shared objects
344 to TARGET's section table. Note that this doesn't remove any
345 sections for shared objects that have been unloaded, and it
346 doesn't check to see if the new shared objects are already present in
347 the section table. But we only use this for core files and
348 processes we've just attached to, so that's okay. */
351 update_solib_list (int from_tty
, struct target_ops
*target
)
353 struct so_list
*inferior
= TARGET_SO_CURRENT_SOS ();
354 struct so_list
*gdb
, **gdb_link
;
356 /* If we are attaching to a running process for which we
357 have not opened a symbol file, we may be able to get its
360 symfile_objfile
== NULL
)
361 catch_errors (TARGET_SO_OPEN_SYMBOL_FILE_OBJECT
, (PTR
) &from_tty
,
362 "Error reading attached process's symbol file.\n",
365 /* Since this function might actually add some elements to the
366 so_list_head list, arrange for it to be cleaned up when
368 if (!solib_cleanup_queued
)
370 make_run_cleanup (do_clear_solib
, NULL
);
371 solib_cleanup_queued
= 1;
374 /* GDB and the inferior's dynamic linker each maintain their own
375 list of currently loaded shared objects; we want to bring the
376 former in sync with the latter. Scan both lists, seeing which
377 shared objects appear where. There are three cases:
379 - A shared object appears on both lists. This means that GDB
380 knows about it already, and it's still loaded in the inferior.
381 Nothing needs to happen.
383 - A shared object appears only on GDB's list. This means that
384 the inferior has unloaded it. We should remove the shared
385 object from GDB's tables.
387 - A shared object appears only on the inferior's list. This
388 means that it's just been loaded. We should add it to GDB's
391 So we walk GDB's list, checking each entry to see if it appears
392 in the inferior's list too. If it does, no action is needed, and
393 we remove it from the inferior's list. If it doesn't, the
394 inferior has unloaded it, and we remove it from GDB's list. By
395 the time we're done walking GDB's list, the inferior's list
396 contains only the new shared objects, which we then add. */
399 gdb_link
= &so_list_head
;
402 struct so_list
*i
= inferior
;
403 struct so_list
**i_link
= &inferior
;
405 /* Check to see whether the shared object *gdb also appears in
406 the inferior's current list. */
409 if (! strcmp (gdb
->so_original_name
, i
->so_original_name
))
416 /* If the shared object appears on the inferior's list too, then
417 it's still loaded, so we don't need to do anything. Delete
418 it from the inferior's list, and leave it on GDB's list. */
423 gdb_link
= &gdb
->next
;
427 /* If it's not on the inferior's list, remove it from GDB's tables. */
430 *gdb_link
= gdb
->next
;
432 /* Unless the user loaded it explicitly, free SO's objfile. */
433 if (gdb
->objfile
&& ! (gdb
->objfile
->flags
& OBJF_USERLOADED
))
434 free_objfile (gdb
->objfile
);
436 /* Some targets' section tables might be referring to
437 sections from so->abfd; remove them. */
438 remove_target_sections (gdb
->abfd
);
445 /* Now the inferior's list contains only shared objects that don't
446 appear in GDB's list --- those that are newly loaded. Add them
447 to GDB's shared object list. */
452 /* Add the new shared objects to GDB's list. */
453 *gdb_link
= inferior
;
455 /* Fill in the rest of each of the `struct so_list' nodes. */
456 for (i
= inferior
; i
; i
= i
->next
)
458 i
->from_tty
= from_tty
;
460 /* Fill in the rest of the `struct so_list' node. */
461 catch_errors (solib_map_sections
, i
,
462 "Error while mapping shared library sections:\n",
465 /* If requested, add the shared object's sections to the TARGET's
466 section table. Do this immediately after mapping the object so
467 that later nodes in the list can query this object, as is needed
471 int count
= (i
->sections_end
- i
->sections
);
474 int space
= target_resize_to_sections (target
, count
);
475 memcpy (target
->to_sections
+ space
,
477 count
* sizeof (i
->sections
[0]));
487 solib_add -- read in symbol info for newly added shared libraries
491 void solib_add (char *pattern, int from_tty, struct target_ops *TARGET)
495 Read in symbolic information for any shared objects whose names
496 match PATTERN. (If we've already read a shared object's symbol
497 info, leave it alone.) If PATTERN is zero, read them all.
499 FROM_TTY and TARGET are as described for update_solib_list, above. */
502 solib_add (char *pattern
, int from_tty
, struct target_ops
*target
)
508 char *re_err
= re_comp (pattern
);
511 error ("Invalid regexp: %s", re_err
);
514 update_solib_list (from_tty
, target
);
516 /* Walk the list of currently loaded shared libraries, and read
517 symbols for any that match the pattern --- or any whose symbols
518 aren't already loaded, if no pattern was given. */
521 int loaded_any_symbols
= 0;
523 for (gdb
= so_list_head
; gdb
; gdb
= gdb
->next
)
524 if (! pattern
|| re_exec (gdb
->so_name
))
528 if (gdb
->symbols_loaded
)
531 printf_unfiltered ("Symbols already loaded for %s\n",
537 (symbol_add_stub
, gdb
,
538 "Error while reading shared library symbols:\n",
542 printf_unfiltered ("Loaded symbols for %s\n",
544 gdb
->symbols_loaded
= 1;
545 loaded_any_symbols
= 1;
550 if (from_tty
&& pattern
&& ! any_matches
)
552 ("No loaded shared libraries match the pattern `%s'.\n", pattern
);
554 if (loaded_any_symbols
)
556 /* Getting new symbols may change our opinion about what is
558 reinit_frame_cache ();
560 TARGET_SO_SPECIAL_SYMBOL_HANDLING ();
570 info_sharedlibrary_command -- code for "info sharedlibrary"
574 static void info_sharedlibrary_command ()
578 Walk through the shared library list and print information
579 about each attached library.
583 info_sharedlibrary_command (char *ignore
, int from_tty
)
585 register struct so_list
*so
= NULL
; /* link map state variable */
591 if (exec_bfd
== NULL
)
593 printf_unfiltered ("No executable file.\n");
597 arch_size
= bfd_get_arch_size (exec_bfd
);
599 arch_size
= bfd_arch_bits_per_address(exec_bfd
);
601 /* Default to 32-bit in case of failure. */
602 if (arch_size
== 32 || arch_size
== -1)
607 else if (arch_size
== 64)
614 internal_error (__FILE__
, __LINE__
,
615 "bfd_get_arch_size() returned unknown size %d",
619 update_solib_list (from_tty
, 0);
621 for (so
= so_list_head
; so
; so
= so
->next
)
627 printf_unfiltered ("%-*s%-*s%-12s%s\n", addr_width
, "From",
628 addr_width
, "To", "Syms Read",
629 "Shared Object Library");
633 printf_unfiltered ("%-*s", addr_width
,
634 so
->textsection
!= NULL
635 ? longest_local_hex_string_custom (
636 (LONGEST
) so
->textsection
->addr
,
639 printf_unfiltered ("%-*s", addr_width
,
640 so
->textsection
!= NULL
641 ? longest_local_hex_string_custom (
642 (LONGEST
) so
->textsection
->endaddr
,
645 printf_unfiltered ("%-12s", so
->symbols_loaded
? "Yes" : "No");
646 printf_unfiltered ("%s\n", so
->so_name
);
649 if (so_list_head
== NULL
)
651 printf_unfiltered ("No shared libraries loaded at this time.\n");
659 solib_address -- check to see if an address is in a shared lib
663 char * solib_address (CORE_ADDR address)
667 Provides a hook for other gdb routines to discover whether or
668 not a particular address is within the mapped address space of
671 For example, this routine is called at one point to disable
672 breakpoints which are in shared libraries that are not currently
677 solib_address (CORE_ADDR address
)
679 register struct so_list
*so
= 0; /* link map state variable */
681 for (so
= so_list_head
; so
; so
= so
->next
)
683 struct section_table
*p
;
685 for (p
= so
->sections
; p
< so
->sections_end
; p
++)
687 if (p
->addr
<= address
&& address
< p
->endaddr
)
688 return (so
->so_name
);
695 /* Called by free_all_symtabs */
700 /* This function is expected to handle ELF shared libraries. It is
701 also used on Solaris, which can run either ELF or a.out binaries
702 (for compatibility with SunOS 4), both of which can use shared
703 libraries. So we don't know whether we have an ELF executable or
704 an a.out executable until the user chooses an executable file.
706 ELF shared libraries don't get mapped into the address space
707 until after the program starts, so we'd better not try to insert
708 breakpoints in them immediately. We have to wait until the
709 dynamic linker has loaded them; we'll hit a bp_shlib_event
710 breakpoint (look for calls to create_solib_event_breakpoint) when
713 SunOS shared libraries seem to be different --- they're present
714 as soon as the process begins execution, so there's no need to
715 put off inserting breakpoints. There's also nowhere to put a
716 bp_shlib_event breakpoint, so if we put it off, we'll never get
719 So: disable breakpoints only if we're using ELF shared libs. */
721 && bfd_get_flavour (exec_bfd
) != bfd_target_aout_flavour
)
722 disable_breakpoints_in_shlibs (1);
726 struct so_list
*so
= so_list_head
;
727 so_list_head
= so
->next
;
731 TARGET_SO_CLEAR_SOLIB ();
735 do_clear_solib (PTR dummy
)
737 solib_cleanup_queued
= 0;
743 solib_create_inferior_hook -- shared library startup support
747 void solib_create_inferior_hook()
751 When gdb starts up the inferior, it nurses it along (through the
752 shell) until it is ready to execute it's first instruction. At this
753 point, this function gets called via expansion of the macro
754 SOLIB_CREATE_INFERIOR_HOOK. */
757 solib_create_inferior_hook (void)
759 TARGET_SO_SOLIB_CREATE_INFERIOR_HOOK ();
764 in_solib_dynsym_resolve_code -- check to see if an address is in
765 dynamic loader's dynamic symbol
770 int in_solib_dynsym_resolve_code (CORE_ADDR pc)
774 Determine if PC is in the dynamic linker's symbol resolution
775 code. Return 1 if so, 0 otherwise.
779 in_solib_dynsym_resolve_code (CORE_ADDR pc
)
781 return TARGET_SO_IN_DYNSYM_RESOLVE_CODE (pc
);
788 sharedlibrary_command -- handle command to explicitly add library
792 static void sharedlibrary_command (char *args, int from_tty)
799 sharedlibrary_command (char *args
, int from_tty
)
802 solib_add (args
, from_tty
, (struct target_ops
*) 0);
807 no_shared_libraries -- handle command to explicitly discard symbols
808 from shared libraries.
812 Implements the command "nosharedlibrary", which discards symbols
813 that have been auto-loaded from shared libraries. Symbols from
814 shared libraries that were added by explicit request of the user
815 are not discarded. Also called from remote.c. */
818 no_shared_libraries (char *ignored
, int from_tty
)
820 objfile_purge_solibs ();
821 do_clear_solib (NULL
);
825 _initialize_solib (void)
827 struct cmd_list_element
*c
;
829 add_com ("sharedlibrary", class_files
, sharedlibrary_command
,
830 "Load shared object library symbols for files matching REGEXP.");
831 add_info ("sharedlibrary", info_sharedlibrary_command
,
832 "Status of loaded shared object libraries.");
833 add_com ("nosharedlibrary", class_files
, no_shared_libraries
,
834 "Unload all shared object library symbols.");
837 (add_set_cmd ("auto-solib-add", class_support
, var_zinteger
,
838 (char *) &auto_solib_add
,
839 "Set autoloading of shared library symbols.\n\
840 If nonzero, symbols from all shared object libraries will be loaded\n\
841 automatically when the inferior begins execution or when the dynamic linker\n\
842 informs gdb that a new library has been loaded. Otherwise, symbols\n\
843 must be loaded manually, using `sharedlibrary'.",
847 c
= add_set_cmd ("solib-absolute-prefix", class_support
, var_filename
,
848 (char *) &solib_absolute_prefix
,
849 "Set prefix for loading absolute shared library symbol files.\n\
850 For other (relative) files, you can add values using `set solib-search-path'.",
852 add_show_from_set (c
, &showlist
);
853 c
->completer
= filename_completer
;
855 c
= add_set_cmd ("solib-search-path", class_support
, var_string
,
856 (char *) &solib_search_path
,
857 "Set the search path for loading non-absolute shared library symbol files.\n\
858 This takes precedence over the environment variables PATH and LD_LIBRARY_PATH.",
860 add_show_from_set (c
, &showlist
);
861 c
->completer
= filename_completer
;