1 /* Handle shared libraries for GDB, the GNU Debugger.
3 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 1999, 2000, 2001, 2002, 2003, 2005
5 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
26 #include <sys/types.h>
28 #include "gdb_string.h"
33 #include "exceptions.h"
38 #include "gdb_regex.h"
43 #include "completer.h"
44 #include "filenames.h" /* for DOSish file names */
48 #include "readline/readline.h"
50 /* external data declarations */
52 /* FIXME: gdbarch needs to control this variable */
53 struct target_so_ops *current_target_so_ops;
55 /* local data declarations */
57 static struct so_list *so_list_head; /* List of known shared objects */
59 static int solib_cleanup_queued = 0; /* make_run_cleanup called */
61 /* Local function prototypes */
63 static void do_clear_solib (void *);
65 /* If non-zero, this is a prefix that will be added to the front of the name
66 shared libraries with an absolute filename for loading. */
67 static char *solib_absolute_prefix = NULL;
69 /* If non-empty, this is a search path for loading non-absolute shared library
70 symbol files. This takes precedence over the environment variables PATH
71 and LD_LIBRARY_PATH. */
72 static char *solib_search_path = NULL;
74 show_solib_search_path (struct ui_file *file, int from_tty,
75 struct cmd_list_element *c, const char *value)
77 fprintf_filtered (file, _("\
78 The search path for loading non-absolute shared library symbol files is %s.\n"),
86 solib_open -- Find a shared library file and open it.
90 int solib_open (char *in_patname, char **found_pathname);
94 Global variable SOLIB_ABSOLUTE_PREFIX is used as a prefix directory
95 to search for shared libraries if they have an absolute path.
97 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
98 (or set of directories, as in LD_LIBRARY_PATH) to search for all
99 shared libraries if not found in SOLIB_ABSOLUTE_PREFIX.
102 * If there is a solib_absolute_prefix and path is absolute:
103 * Search for solib_absolute_prefix/path.
105 * Look for it literally (unmodified).
106 * Look in SOLIB_SEARCH_PATH.
107 * If available, use target defined search function.
108 * If solib_absolute_prefix is NOT set, perform the following two searches:
109 * Look in inferior's $PATH.
110 * Look in inferior's $LD_LIBRARY_PATH.
112 * The last check avoids doing this search when targetting remote
113 * machines since solib_absolute_prefix will almost always be set.
117 file handle for opened solib, or -1 for failure. */
120 solib_open (char *in_pathname, char **found_pathname)
123 char *temp_pathname = NULL;
124 char *p = in_pathname;
126 while (*p && !IS_DIR_SEPARATOR (*p))
131 if (! IS_ABSOLUTE_PATH (in_pathname) || solib_absolute_prefix == NULL)
132 temp_pathname = in_pathname;
135 int prefix_len = strlen (solib_absolute_prefix);
137 /* Remove trailing slashes from absolute prefix. */
138 while (prefix_len > 0
139 && IS_DIR_SEPARATOR (solib_absolute_prefix[prefix_len - 1]))
142 /* Cat the prefixed pathname together. */
143 temp_pathname = alloca (prefix_len + strlen (in_pathname) + 1);
144 strncpy (temp_pathname, solib_absolute_prefix, prefix_len);
145 temp_pathname[prefix_len] = '\0';
146 strcat (temp_pathname, in_pathname);
149 /* Now see if we can open it. */
150 found_file = open (temp_pathname, O_RDONLY, 0);
153 /* If the search in solib_absolute_prefix failed, and the path name is
154 absolute at this point, make it relative. (openp will try and open the
155 file according to its absolute path otherwise, which is not what we want.)
156 Affects subsequent searches for this solib. */
157 if (found_file < 0 && IS_ABSOLUTE_PATH (in_pathname))
159 /* First, get rid of any drive letters etc. */
160 while (!IS_DIR_SEPARATOR (*in_pathname))
163 /* Next, get rid of all leading dir separators. */
164 while (IS_DIR_SEPARATOR (*in_pathname))
168 /* If not found, search the solib_search_path (if any). */
169 if (found_file < 0 && solib_search_path != NULL)
170 found_file = openp (solib_search_path, OPF_TRY_CWD_FIRST,
171 in_pathname, O_RDONLY, 0, &temp_pathname);
173 /* If not found, next search the solib_search_path (if any) for the basename
174 only (ignoring the path). This is to allow reading solibs from a path
175 that differs from the opened path. */
176 if (found_file < 0 && solib_search_path != NULL)
177 found_file = openp (solib_search_path, OPF_TRY_CWD_FIRST,
178 lbasename (in_pathname), O_RDONLY, 0,
181 /* If not found, try to use target supplied solib search method */
182 if (found_file < 0 && TARGET_SO_FIND_AND_OPEN_SOLIB != NULL)
183 found_file = TARGET_SO_FIND_AND_OPEN_SOLIB
184 (in_pathname, O_RDONLY, &temp_pathname);
186 /* If not found, next search the inferior's $PATH environment variable. */
187 if (found_file < 0 && solib_absolute_prefix == NULL)
188 found_file = openp (get_in_environ (inferior_environ, "PATH"),
189 OPF_TRY_CWD_FIRST, in_pathname, O_RDONLY, 0,
192 /* If not found, next search the inferior's $LD_LIBRARY_PATH
193 environment variable. */
194 if (found_file < 0 && solib_absolute_prefix == NULL)
195 found_file = openp (get_in_environ (inferior_environ, "LD_LIBRARY_PATH"),
196 OPF_TRY_CWD_FIRST, in_pathname, O_RDONLY, 0,
199 /* Done. If not found, tough luck. Return found_file and
200 (optionally) found_pathname. */
201 if (found_pathname != NULL && temp_pathname != NULL)
202 *found_pathname = xstrdup (temp_pathname);
211 solib_map_sections -- open bfd and build sections for shared lib
215 static int solib_map_sections (struct so_list *so)
219 Given a pointer to one of the shared objects in our list
220 of mapped objects, use the recorded name to open a bfd
221 descriptor for the object, build a section table, and then
222 relocate all the section addresses by the base address at
223 which the shared object was mapped.
227 In most (all?) cases the shared object file name recorded in the
228 dynamic linkage tables will be a fully qualified pathname. For
229 cases where it isn't, do we really mimic the systems search
230 mechanism correctly in the below code (particularly the tilde
235 solib_map_sections (void *arg)
237 struct so_list *so = (struct so_list *) arg; /* catch_errors bogon */
239 char *scratch_pathname;
241 struct section_table *p;
242 struct cleanup *old_chain;
245 filename = tilde_expand (so->so_name);
247 old_chain = make_cleanup (xfree, filename);
248 scratch_chan = solib_open (filename, &scratch_pathname);
250 if (scratch_chan < 0)
252 perror_with_name (filename);
255 /* Leave scratch_pathname allocated. abfd->name will point to it. */
256 abfd = bfd_fdopenr (scratch_pathname, gnutarget, scratch_chan);
259 close (scratch_chan);
260 error (_("Could not open `%s' as an executable file: %s"),
261 scratch_pathname, bfd_errmsg (bfd_get_error ()));
264 /* Leave bfd open, core_xfer_memory and "info files" need it. */
266 bfd_set_cacheable (abfd, 1);
268 /* copy full path name into so_name, so that later symbol_file_add
270 if (strlen (scratch_pathname) >= SO_NAME_MAX_PATH_SIZE)
271 error (_("Full path name length of shared library exceeds SO_NAME_MAX_PATH_SIZE in so_list structure."));
272 strcpy (so->so_name, scratch_pathname);
274 if (!bfd_check_format (abfd, bfd_object))
276 error (_("\"%s\": not in executable format: %s."),
277 scratch_pathname, bfd_errmsg (bfd_get_error ()));
279 if (build_section_table (abfd, &so->sections, &so->sections_end))
281 error (_("Can't find the file sections in `%s': %s"),
282 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
285 for (p = so->sections; p < so->sections_end; p++)
287 /* Relocate the section binding addresses as recorded in the shared
288 object's file by the base address to which the object was actually
290 TARGET_SO_RELOCATE_SECTION_ADDRESSES (so, p);
291 if (strcmp (p->the_bfd_section->name, ".text") == 0)
297 /* Free the file names, close the file now. */
298 do_cleanups (old_chain);
305 free_so --- free a `struct so_list' object
309 void free_so (struct so_list *so)
313 Free the storage associated with the `struct so_list' object SO.
314 If we have opened a BFD for SO, close it.
316 The caller is responsible for removing SO from whatever list it is
317 a member of. If we have placed SO's sections in some target's
318 section table, the caller is responsible for removing them.
320 This function doesn't mess with objfiles at all. If there is an
321 objfile associated with SO that needs to be removed, the caller is
322 responsible for taking care of that. */
325 free_so (struct so_list *so)
327 char *bfd_filename = 0;
330 xfree (so->sections);
334 bfd_filename = bfd_get_filename (so->abfd);
335 if (! bfd_close (so->abfd))
336 warning (_("cannot close \"%s\": %s"),
337 bfd_filename, bfd_errmsg (bfd_get_error ()));
341 xfree (bfd_filename);
343 TARGET_SO_FREE_SO (so);
349 /* Return address of first so_list entry in master shared object list. */
351 master_so_list (void)
357 /* A small stub to get us past the arg-passing pinhole of catch_errors. */
360 symbol_add_stub (void *arg)
362 struct so_list *so = (struct so_list *) arg; /* catch_errs bogon */
363 struct section_addr_info *sap;
365 /* Have we already loaded this shared object? */
366 ALL_OBJFILES (so->objfile)
368 if (strcmp (so->objfile->name, so->so_name) == 0)
372 sap = build_section_addr_info_from_section_table (so->sections,
375 so->objfile = symbol_file_add (so->so_name, so->from_tty,
376 sap, 0, OBJF_SHARED);
377 free_section_addr_info (sap);
382 /* Read in symbols for shared object SO. If FROM_TTY is non-zero, be
383 chatty about it. Return non-zero if any symbols were actually
387 solib_read_symbols (struct so_list *so, int from_tty)
389 if (so->symbols_loaded)
392 printf_unfiltered (_("Symbols already loaded for %s\n"), so->so_name);
396 if (catch_errors (symbol_add_stub, so,
397 "Error while reading shared library symbols:\n",
401 printf_unfiltered (_("Loaded symbols for %s\n"), so->so_name);
402 so->symbols_loaded = 1;
412 update_solib_list --- synchronize GDB's shared object list with inferior's
416 void update_solib_list (int from_tty, struct target_ops *TARGET)
418 Extract the list of currently loaded shared objects from the
419 inferior, and compare it with the list of shared objects currently
420 in GDB's so_list_head list. Edit so_list_head to bring it in sync
421 with the inferior's new list.
423 If we notice that the inferior has unloaded some shared objects,
424 free any symbolic info GDB had read about those shared objects.
426 Don't load symbolic info for any new shared objects; just add them
427 to the list, and leave their symbols_loaded flag clear.
429 If FROM_TTY is non-null, feel free to print messages about what
432 If TARGET is non-null, add the sections of all new shared objects
433 to TARGET's section table. Note that this doesn't remove any
434 sections for shared objects that have been unloaded, and it
435 doesn't check to see if the new shared objects are already present in
436 the section table. But we only use this for core files and
437 processes we've just attached to, so that's okay. */
440 update_solib_list (int from_tty, struct target_ops *target)
442 struct so_list *inferior = TARGET_SO_CURRENT_SOS ();
443 struct so_list *gdb, **gdb_link;
445 /* If we are attaching to a running process for which we
446 have not opened a symbol file, we may be able to get its
449 symfile_objfile == NULL)
450 catch_errors (TARGET_SO_OPEN_SYMBOL_FILE_OBJECT, &from_tty,
451 "Error reading attached process's symbol file.\n",
454 /* Since this function might actually add some elements to the
455 so_list_head list, arrange for it to be cleaned up when
457 if (!solib_cleanup_queued)
459 make_run_cleanup (do_clear_solib, NULL);
460 solib_cleanup_queued = 1;
463 /* GDB and the inferior's dynamic linker each maintain their own
464 list of currently loaded shared objects; we want to bring the
465 former in sync with the latter. Scan both lists, seeing which
466 shared objects appear where. There are three cases:
468 - A shared object appears on both lists. This means that GDB
469 knows about it already, and it's still loaded in the inferior.
470 Nothing needs to happen.
472 - A shared object appears only on GDB's list. This means that
473 the inferior has unloaded it. We should remove the shared
474 object from GDB's tables.
476 - A shared object appears only on the inferior's list. This
477 means that it's just been loaded. We should add it to GDB's
480 So we walk GDB's list, checking each entry to see if it appears
481 in the inferior's list too. If it does, no action is needed, and
482 we remove it from the inferior's list. If it doesn't, the
483 inferior has unloaded it, and we remove it from GDB's list. By
484 the time we're done walking GDB's list, the inferior's list
485 contains only the new shared objects, which we then add. */
488 gdb_link = &so_list_head;
491 struct so_list *i = inferior;
492 struct so_list **i_link = &inferior;
494 /* Check to see whether the shared object *gdb also appears in
495 the inferior's current list. */
498 if (! strcmp (gdb->so_original_name, i->so_original_name))
505 /* If the shared object appears on the inferior's list too, then
506 it's still loaded, so we don't need to do anything. Delete
507 it from the inferior's list, and leave it on GDB's list. */
512 gdb_link = &gdb->next;
516 /* If it's not on the inferior's list, remove it from GDB's tables. */
519 /* Notify any observer that the shared object has been
520 unloaded before we remove it from GDB's tables. */
521 observer_notify_solib_unloaded (gdb);
523 *gdb_link = gdb->next;
525 /* Unless the user loaded it explicitly, free SO's objfile. */
526 if (gdb->objfile && ! (gdb->objfile->flags & OBJF_USERLOADED))
527 free_objfile (gdb->objfile);
529 /* Some targets' section tables might be referring to
530 sections from so->abfd; remove them. */
531 remove_target_sections (gdb->abfd);
538 /* Now the inferior's list contains only shared objects that don't
539 appear in GDB's list --- those that are newly loaded. Add them
540 to GDB's shared object list. */
545 /* Add the new shared objects to GDB's list. */
546 *gdb_link = inferior;
548 /* Fill in the rest of each of the `struct so_list' nodes. */
549 for (i = inferior; i; i = i->next)
551 i->from_tty = from_tty;
553 /* Fill in the rest of the `struct so_list' node. */
554 catch_errors (solib_map_sections, i,
555 "Error while mapping shared library sections:\n",
558 /* If requested, add the shared object's sections to the TARGET's
559 section table. Do this immediately after mapping the object so
560 that later nodes in the list can query this object, as is needed
564 int count = (i->sections_end - i->sections);
567 int space = target_resize_to_sections (target, count);
568 memcpy (target->to_sections + space,
570 count * sizeof (i->sections[0]));
574 /* Notify any observer that the shared object has been
575 loaded now that we've added it to GDB's tables. */
576 observer_notify_solib_loaded (i);
584 solib_add -- read in symbol info for newly added shared libraries
588 void solib_add (char *pattern, int from_tty, struct target_ops
589 *TARGET, int readsyms)
593 Read in symbolic information for any shared objects whose names
594 match PATTERN. (If we've already read a shared object's symbol
595 info, leave it alone.) If PATTERN is zero, read them all.
597 If READSYMS is 0, defer reading symbolic information until later
598 but still do any needed low level processing.
600 FROM_TTY and TARGET are as described for update_solib_list, above. */
603 solib_add (char *pattern, int from_tty, struct target_ops *target, int readsyms)
609 char *re_err = re_comp (pattern);
612 error (_("Invalid regexp: %s"), re_err);
615 update_solib_list (from_tty, target);
617 /* Walk the list of currently loaded shared libraries, and read
618 symbols for any that match the pattern --- or any whose symbols
619 aren't already loaded, if no pattern was given. */
622 int loaded_any_symbols = 0;
624 for (gdb = so_list_head; gdb; gdb = gdb->next)
625 if (! pattern || re_exec (gdb->so_name))
628 if (readsyms && solib_read_symbols (gdb, from_tty))
629 loaded_any_symbols = 1;
632 if (from_tty && pattern && ! any_matches)
634 ("No loaded shared libraries match the pattern `%s'.\n", pattern);
636 if (loaded_any_symbols)
638 /* Getting new symbols may change our opinion about what is
640 reinit_frame_cache ();
642 TARGET_SO_SPECIAL_SYMBOL_HANDLING ();
652 info_sharedlibrary_command -- code for "info sharedlibrary"
656 static void info_sharedlibrary_command ()
660 Walk through the shared library list and print information
661 about each attached library.
665 info_sharedlibrary_command (char *ignore, int from_tty)
667 struct so_list *so = NULL; /* link map state variable */
671 if (TARGET_PTR_BIT == 32)
673 else if (TARGET_PTR_BIT == 64)
677 internal_error (__FILE__, __LINE__,
678 _("TARGET_PTR_BIT returned unknown size %d"),
682 update_solib_list (from_tty, 0);
684 for (so = so_list_head; so; so = so->next)
690 printf_unfiltered ("%-*s%-*s%-12s%s\n", addr_width, "From",
691 addr_width, "To", "Syms Read",
692 "Shared Object Library");
696 printf_unfiltered ("%-*s", addr_width,
697 so->textsection != NULL
698 ? hex_string_custom (
699 (LONGEST) so->textsection->addr,
702 printf_unfiltered ("%-*s", addr_width,
703 so->textsection != NULL
704 ? hex_string_custom (
705 (LONGEST) so->textsection->endaddr,
708 printf_unfiltered ("%-12s", so->symbols_loaded ? "Yes" : "No");
709 printf_unfiltered ("%s\n", so->so_name);
712 if (so_list_head == NULL)
714 printf_unfiltered (_("No shared libraries loaded at this time.\n"));
722 solib_address -- check to see if an address is in a shared lib
726 char * solib_address (CORE_ADDR address)
730 Provides a hook for other gdb routines to discover whether or
731 not a particular address is within the mapped address space of
734 For example, this routine is called at one point to disable
735 breakpoints which are in shared libraries that are not currently
740 solib_address (CORE_ADDR address)
742 struct so_list *so = 0; /* link map state variable */
744 for (so = so_list_head; so; so = so->next)
746 struct section_table *p;
748 for (p = so->sections; p < so->sections_end; p++)
750 if (p->addr <= address && address < p->endaddr)
751 return (so->so_name);
758 /* Called by free_all_symtabs */
763 /* This function is expected to handle ELF shared libraries. It is
764 also used on Solaris, which can run either ELF or a.out binaries
765 (for compatibility with SunOS 4), both of which can use shared
766 libraries. So we don't know whether we have an ELF executable or
767 an a.out executable until the user chooses an executable file.
769 ELF shared libraries don't get mapped into the address space
770 until after the program starts, so we'd better not try to insert
771 breakpoints in them immediately. We have to wait until the
772 dynamic linker has loaded them; we'll hit a bp_shlib_event
773 breakpoint (look for calls to create_solib_event_breakpoint) when
776 SunOS shared libraries seem to be different --- they're present
777 as soon as the process begins execution, so there's no need to
778 put off inserting breakpoints. There's also nowhere to put a
779 bp_shlib_event breakpoint, so if we put it off, we'll never get
782 So: disable breakpoints only if we're using ELF shared libs. */
784 && bfd_get_flavour (exec_bfd) != bfd_target_aout_flavour)
785 disable_breakpoints_in_shlibs (1);
789 struct so_list *so = so_list_head;
790 so_list_head = so->next;
792 remove_target_sections (so->abfd);
796 TARGET_SO_CLEAR_SOLIB ();
800 do_clear_solib (void *dummy)
802 solib_cleanup_queued = 0;
808 solib_create_inferior_hook -- shared library startup support
812 void solib_create_inferior_hook ()
816 When gdb starts up the inferior, it nurses it along (through the
817 shell) until it is ready to execute it's first instruction. At this
818 point, this function gets called via expansion of the macro
819 SOLIB_CREATE_INFERIOR_HOOK. */
822 solib_create_inferior_hook (void)
824 TARGET_SO_SOLIB_CREATE_INFERIOR_HOOK ();
829 in_solib_dynsym_resolve_code -- check to see if an address is in
830 dynamic loader's dynamic symbol
835 int in_solib_dynsym_resolve_code (CORE_ADDR pc)
839 Determine if PC is in the dynamic linker's symbol resolution
840 code. Return 1 if so, 0 otherwise.
844 in_solib_dynsym_resolve_code (CORE_ADDR pc)
846 return TARGET_SO_IN_DYNSYM_RESOLVE_CODE (pc);
853 sharedlibrary_command -- handle command to explicitly add library
857 static void sharedlibrary_command (char *args, int from_tty)
864 sharedlibrary_command (char *args, int from_tty)
867 solib_add (args, from_tty, (struct target_ops *) 0, 1);
872 no_shared_libraries -- handle command to explicitly discard symbols
873 from shared libraries.
877 Implements the command "nosharedlibrary", which discards symbols
878 that have been auto-loaded from shared libraries. Symbols from
879 shared libraries that were added by explicit request of the user
880 are not discarded. Also called from remote.c. */
883 no_shared_libraries (char *ignored, int from_tty)
885 objfile_purge_solibs ();
886 do_clear_solib (NULL);
890 reload_shared_libraries (char *ignored, int from_tty,
891 struct cmd_list_element *e)
893 no_shared_libraries (NULL, from_tty);
894 solib_add (NULL, from_tty, NULL, auto_solib_add);
898 show_auto_solib_add (struct ui_file *file, int from_tty,
899 struct cmd_list_element *c, const char *value)
901 fprintf_filtered (file, _("Autoloading of shared library symbols is %s.\n"),
906 extern initialize_file_ftype _initialize_solib; /* -Wmissing-prototypes */
909 _initialize_solib (void)
911 struct cmd_list_element *c;
913 add_com ("sharedlibrary", class_files, sharedlibrary_command,
914 _("Load shared object library symbols for files matching REGEXP."));
915 add_info ("sharedlibrary", info_sharedlibrary_command,
916 _("Status of loaded shared object libraries."));
917 add_com ("nosharedlibrary", class_files, no_shared_libraries,
918 _("Unload all shared object library symbols."));
920 add_setshow_boolean_cmd ("auto-solib-add", class_support,
921 &auto_solib_add, _("\
922 Set autoloading of shared library symbols."), _("\
923 Show autoloading of shared library symbols."), _("\
924 If \"on\", symbols from all shared object libraries will be loaded\n\
925 automatically when the inferior begins execution, when the dynamic linker\n\
926 informs gdb that a new library has been loaded, or when attaching to the\n\
927 inferior. Otherwise, symbols must be loaded manually, using `sharedlibrary'."),
930 &setlist, &showlist);
932 add_setshow_filename_cmd ("solib-absolute-prefix", class_support,
933 &solib_absolute_prefix, _("\
934 Set prefix for loading absolute shared library symbol files."), _("\
935 Show prefix for loading absolute shared library symbol files."), _("\
936 For other (relative) files, you can add values using `set solib-search-path'."),
937 reload_shared_libraries,
939 &setlist, &showlist);
941 /* Set the default value of "solib-absolute-prefix" from the sysroot, if
943 solib_absolute_prefix = xstrdup (gdb_sysroot);
945 add_setshow_optional_filename_cmd ("solib-search-path", class_support,
946 &solib_search_path, _("\
947 Set the search path for loading non-absolute shared library symbol files."), _("\
948 Show the search path for loading non-absolute shared library symbol files."), _("\
949 This takes precedence over the environment variables PATH and LD_LIBRARY_PATH."),
950 reload_shared_libraries,
951 show_solib_search_path,
952 &setlist, &showlist);