1 /* Handle shared libraries for GDB, the GNU Debugger.
3 Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 2000, 2001, 2002, 2003, 2005, 2006, 2007, 2008, 2009, 2010, 2011
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 3 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, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
26 #include "gdb_string.h"
31 #include "exceptions.h"
36 #include "gdb_regex.h"
41 #include "completer.h"
42 #include "filenames.h" /* for DOSish file names */
46 #include "readline/readline.h"
50 #include "filesystem.h"
52 /* Architecture-specific operations. */
54 /* Per-architecture data key. */
55 static struct gdbarch_data *solib_data;
58 solib_init (struct obstack *obstack)
60 struct target_so_ops **ops;
62 ops = OBSTACK_ZALLOC (obstack, struct target_so_ops *);
63 *ops = current_target_so_ops;
67 static struct target_so_ops *
68 solib_ops (struct gdbarch *gdbarch)
70 struct target_so_ops **ops = gdbarch_data (gdbarch, solib_data);
75 /* Set the solib operations for GDBARCH to NEW_OPS. */
78 set_solib_ops (struct gdbarch *gdbarch, struct target_so_ops *new_ops)
80 struct target_so_ops **ops = gdbarch_data (gdbarch, solib_data);
86 /* external data declarations */
88 /* FIXME: gdbarch needs to control this variable, or else every
89 configuration needs to call set_solib_ops. */
90 struct target_so_ops *current_target_so_ops;
92 /* List of known shared objects */
93 #define so_list_head current_program_space->so_list
95 /* Local function prototypes */
97 /* If non-empty, this is a search path for loading non-absolute shared library
98 symbol files. This takes precedence over the environment variables PATH
99 and LD_LIBRARY_PATH. */
100 static char *solib_search_path = NULL;
102 show_solib_search_path (struct ui_file *file, int from_tty,
103 struct cmd_list_element *c, const char *value)
105 fprintf_filtered (file, _("The search path for loading non-absolute "
106 "shared library symbol files is %s.\n"),
110 /* Same as HAVE_DOS_BASED_FILE_SYSTEM, but useable as an rvalue. */
111 #if (HAVE_DOS_BASED_FILE_SYSTEM)
112 # define DOS_BASED_FILE_SYSTEM 1
114 # define DOS_BASED_FILE_SYSTEM 0
121 solib_find -- Find a shared library file.
125 char *solib_find (char *in_pathname, int *fd);
129 Global variable GDB_SYSROOT is used as a prefix directory
130 to search for shared libraries if they have an absolute path.
132 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
133 (or set of directories, as in LD_LIBRARY_PATH) to search for all
134 shared libraries if not found in GDB_SYSROOT.
137 * If there is a gdb_sysroot and path is absolute:
138 * Search for gdb_sysroot/path.
140 * Look for it literally (unmodified).
141 * Look in SOLIB_SEARCH_PATH.
142 * If available, use target defined search function.
143 * If gdb_sysroot is NOT set, perform the following two searches:
144 * Look in inferior's $PATH.
145 * Look in inferior's $LD_LIBRARY_PATH.
147 * The last check avoids doing this search when targetting remote
148 * machines since gdb_sysroot will almost always be set.
152 Full pathname of the shared library file, or NULL if not found.
153 (The pathname is malloc'ed; it needs to be freed by the caller.)
154 *FD is set to either -1 or an open file handle for the library. */
157 solib_find (char *in_pathname, int *fd)
159 struct target_so_ops *ops = solib_ops (target_gdbarch);
161 char *temp_pathname = NULL;
162 int gdb_sysroot_is_empty;
163 const char *solib_symbols_extension
164 = gdbarch_solib_symbols_extension (target_gdbarch);
165 const char *fskind = effective_target_file_system_kind ();
166 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
167 char *sysroot = NULL;
169 /* If solib_symbols_extension is set, replace the file's
171 if (solib_symbols_extension)
173 char *p = in_pathname + strlen (in_pathname);
175 while (p > in_pathname && *p != '.')
182 new_pathname = alloca (p - in_pathname + 1
183 + strlen (solib_symbols_extension) + 1);
184 memcpy (new_pathname, in_pathname, p - in_pathname + 1);
185 strcpy (new_pathname + (p - in_pathname) + 1,
186 solib_symbols_extension);
188 in_pathname = new_pathname;
192 gdb_sysroot_is_empty = (gdb_sysroot == NULL || *gdb_sysroot == 0);
194 if (!gdb_sysroot_is_empty)
196 int prefix_len = strlen (gdb_sysroot);
198 /* Remove trailing slashes from absolute prefix. */
199 while (prefix_len > 0
200 && IS_DIR_SEPARATOR (gdb_sysroot[prefix_len - 1]))
203 sysroot = savestring (gdb_sysroot, prefix_len);
204 make_cleanup (xfree, sysroot);
207 /* If we're on a non-DOS-based system, backslashes won't be
208 understood as directory separator, so, convert them to forward
209 slashes, iff we're supposed to handle DOS-based file system
210 semantics for target paths. */
211 if (!DOS_BASED_FILE_SYSTEM && fskind == file_system_kind_dos_based)
215 /* Avoid clobbering our input. */
216 p = alloca (strlen (in_pathname) + 1);
217 strcpy (p, in_pathname);
227 /* Note, we're interested in IS_TARGET_ABSOLUTE_PATH, not
228 IS_ABSOLUTE_PATH. The latter is for host paths only, while
229 IN_PATHNAME is a target path. For example, if we're supposed to
230 be handling DOS-like semantics we want to consider a
231 'c:/foo/bar.dll' path as an absolute path, even on a Unix box.
232 With such a path, before giving up on the sysroot, we'll try:
234 1st attempt, c:/foo/bar.dll ==> /sysroot/c:/foo/bar.dll
235 2nd attempt, c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll
236 3rd attempt, c:/foo/bar.dll ==> /sysroot/foo/bar.dll
239 if (!IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname) || gdb_sysroot_is_empty)
240 temp_pathname = xstrdup (in_pathname);
243 int need_dir_separator;
245 need_dir_separator = !IS_DIR_SEPARATOR (in_pathname[0]);
247 /* Cat the prefixed pathname together. */
248 temp_pathname = concat (sysroot,
249 need_dir_separator ? SLASH_STRING : "",
250 in_pathname, (char *) NULL);
253 /* Handle remote files. */
254 if (remote_filename_p (temp_pathname))
257 return temp_pathname;
260 /* Now see if we can open it. */
261 found_file = open (temp_pathname, O_RDONLY | O_BINARY, 0);
263 xfree (temp_pathname);
265 /* If the search in gdb_sysroot failed, and the path name has a
266 drive spec (e.g, c:/foo), try stripping ':' from the drive spec,
267 and retrying in the sysroot:
268 c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll. */
271 && !gdb_sysroot_is_empty
272 && HAS_TARGET_DRIVE_SPEC (fskind, in_pathname))
274 int need_dir_separator = !IS_DIR_SEPARATOR (in_pathname[2]);
275 char *drive = savestring (in_pathname, 1);
277 temp_pathname = concat (sysroot,
280 need_dir_separator ? SLASH_STRING : "",
281 in_pathname + 2, (char *) NULL);
284 found_file = open (temp_pathname, O_RDONLY | O_BINARY, 0);
287 xfree (temp_pathname);
289 /* If the search in gdb_sysroot still failed, try fully
290 stripping the drive spec, and trying once more in the
291 sysroot before giving up.
293 c:/foo/bar.dll ==> /sysroot/foo/bar.dll. */
295 temp_pathname = concat (sysroot,
296 need_dir_separator ? SLASH_STRING : "",
297 in_pathname + 2, (char *) NULL);
299 found_file = open (temp_pathname, O_RDONLY | O_BINARY, 0);
301 xfree (temp_pathname);
305 do_cleanups (old_chain);
307 /* We try to find the library in various ways. After each attempt,
308 either found_file >= 0 and temp_pathname is a malloc'd string, or
309 found_file < 0 and temp_pathname does not point to storage that
310 needs to be freed. */
313 temp_pathname = NULL;
315 /* If not found, search the solib_search_path (if any). */
316 if (found_file < 0 && solib_search_path != NULL)
317 found_file = openp (solib_search_path, OPF_TRY_CWD_FIRST,
318 in_pathname, O_RDONLY | O_BINARY, &temp_pathname);
320 /* If the search in gdb_sysroot failed, and the path name is
321 absolute at this point, make it relative. (openp will try and open the
322 file according to its absolute path otherwise, which is not what we want.)
323 Affects subsequent searches for this solib. */
324 if (found_file < 0 && IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname))
326 /* First, get rid of any drive letters etc. */
327 while (!IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
330 /* Next, get rid of all leading dir separators. */
331 while (IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
335 /* If not found, search the solib_search_path (if any). */
336 if (found_file < 0 && solib_search_path != NULL)
337 found_file = openp (solib_search_path, OPF_TRY_CWD_FIRST,
338 in_pathname, O_RDONLY | O_BINARY, &temp_pathname);
340 /* If not found, next search the solib_search_path (if any) for the basename
341 only (ignoring the path). This is to allow reading solibs from a path
342 that differs from the opened path. */
343 if (found_file < 0 && solib_search_path != NULL)
344 found_file = openp (solib_search_path, OPF_TRY_CWD_FIRST,
345 target_lbasename (fskind, in_pathname),
346 O_RDONLY | O_BINARY, &temp_pathname);
348 /* If not found, try to use target supplied solib search method. */
349 if (found_file < 0 && ops->find_and_open_solib)
350 found_file = ops->find_and_open_solib (in_pathname, O_RDONLY | O_BINARY,
353 /* If not found, next search the inferior's $PATH environment variable. */
354 if (found_file < 0 && gdb_sysroot_is_empty)
355 found_file = openp (get_in_environ (current_inferior ()->environment,
357 OPF_TRY_CWD_FIRST, in_pathname, O_RDONLY | O_BINARY,
360 /* If not found, next search the inferior's $LD_LIBRARY_PATH
361 environment variable. */
362 if (found_file < 0 && gdb_sysroot_is_empty)
363 found_file = openp (get_in_environ (current_inferior ()->environment,
365 OPF_TRY_CWD_FIRST, in_pathname, O_RDONLY | O_BINARY,
369 return temp_pathname;
372 /* Open and return a BFD for the shared library PATHNAME. If FD is not -1,
373 it is used as file handle to open the file. Throws an error if the file
374 could not be opened. Handles both local and remote file access.
376 PATHNAME must be malloc'ed by the caller. If successful, the new BFD's
377 name will point to it. If unsuccessful, PATHNAME will be freed and the
378 FD will be closed (unless FD was -1). */
381 solib_bfd_fopen (char *pathname, int fd)
385 if (remote_filename_p (pathname))
387 gdb_assert (fd == -1);
388 abfd = remote_bfd_open (pathname, gnutarget);
392 abfd = bfd_fopen (pathname, gnutarget, FOPEN_RB, fd);
395 bfd_set_cacheable (abfd, 1);
402 make_cleanup (xfree, pathname);
403 error (_("Could not open `%s' as an executable file: %s"),
404 pathname, bfd_errmsg (bfd_get_error ()));
410 /* Find shared library PATHNAME and open a BFD for it. */
413 solib_bfd_open (char *pathname)
415 char *found_pathname;
418 const struct bfd_arch_info *b;
420 /* Search for shared library file. */
421 found_pathname = solib_find (pathname, &found_file);
422 if (found_pathname == NULL)
424 /* Return failure if the file could not be found, so that we can
425 accumulate messages about missing libraries. */
429 perror_with_name (pathname);
432 /* Open bfd for shared library. */
433 abfd = solib_bfd_fopen (found_pathname, found_file);
435 /* Check bfd format. */
436 if (!bfd_check_format (abfd, bfd_object))
439 make_cleanup (xfree, found_pathname);
440 error (_("`%s': not in executable format: %s"),
441 found_pathname, bfd_errmsg (bfd_get_error ()));
444 /* Check bfd arch. */
445 b = gdbarch_bfd_arch_info (target_gdbarch);
446 if (!b->compatible (b, bfd_get_arch_info (abfd)))
447 warning (_("`%s': Shared library architecture %s is not compatible "
448 "with target architecture %s."), found_pathname,
449 bfd_get_arch_info (abfd)->printable_name, b->printable_name);
459 solib_map_sections -- open bfd and build sections for shared lib
463 static int solib_map_sections (struct so_list *so)
467 Given a pointer to one of the shared objects in our list
468 of mapped objects, use the recorded name to open a bfd
469 descriptor for the object, build a section table, and then
470 relocate all the section addresses by the base address at
471 which the shared object was mapped.
475 In most (all?) cases the shared object file name recorded in the
476 dynamic linkage tables will be a fully qualified pathname. For
477 cases where it isn't, do we really mimic the systems search
478 mechanism correctly in the below code (particularly the tilde
483 solib_map_sections (struct so_list *so)
485 struct target_so_ops *ops = solib_ops (target_gdbarch);
487 struct target_section *p;
488 struct cleanup *old_chain;
491 filename = tilde_expand (so->so_name);
492 old_chain = make_cleanup (xfree, filename);
493 abfd = ops->bfd_open (filename);
494 do_cleanups (old_chain);
499 /* Leave bfd open, core_xfer_memory and "info files" need it. */
500 so->abfd = gdb_bfd_ref (abfd);
502 /* copy full path name into so_name, so that later symbol_file_add
504 if (strlen (bfd_get_filename (abfd)) >= SO_NAME_MAX_PATH_SIZE)
505 error (_("Shared library file name is too long."));
506 strcpy (so->so_name, bfd_get_filename (abfd));
508 if (build_section_table (abfd, &so->sections, &so->sections_end))
510 error (_("Can't find the file sections in `%s': %s"),
511 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
514 for (p = so->sections; p < so->sections_end; p++)
516 /* Relocate the section binding addresses as recorded in the shared
517 object's file by the base address to which the object was actually
519 ops->relocate_section_addresses (so, p);
521 /* If the target didn't provide information about the address
522 range of the shared object, assume we want the location of
523 the .text section. */
524 if (so->addr_low == 0 && so->addr_high == 0
525 && strcmp (p->the_bfd_section->name, ".text") == 0)
527 so->addr_low = p->addr;
528 so->addr_high = p->endaddr;
532 /* Add the shared object's sections to the current set of file
533 section tables. Do this immediately after mapping the object so
534 that later nodes in the list can query this object, as is needed
536 add_target_sections (so->sections, so->sections_end);
541 /* Free symbol-file related contents of SO. If we have opened a BFD
542 for SO, close it. If we have placed SO's sections in some target's
543 section table, the caller is responsible for removing them.
545 This function doesn't mess with objfiles at all. If there is an
546 objfile associated with SO that needs to be removed, the caller is
547 responsible for taking care of that. */
550 free_so_symbols (struct so_list *so)
554 xfree (so->sections);
555 so->sections = so->sections_end = NULL;
558 gdb_bfd_unref (so->abfd);
561 /* Our caller closed the objfile, possibly via objfile_purge_solibs. */
562 so->symbols_loaded = 0;
565 so->addr_low = so->addr_high = 0;
567 /* Restore the target-supplied file name. SO_NAME may be the path
568 of the symbol file. */
569 strcpy (so->so_name, so->so_original_name);
574 free_so --- free a `struct so_list' object
578 void free_so (struct so_list *so)
582 Free the storage associated with the `struct so_list' object SO.
583 If we have opened a BFD for SO, close it.
585 The caller is responsible for removing SO from whatever list it is
586 a member of. If we have placed SO's sections in some target's
587 section table, the caller is responsible for removing them.
589 This function doesn't mess with objfiles at all. If there is an
590 objfile associated with SO that needs to be removed, the caller is
591 responsible for taking care of that. */
594 free_so (struct so_list *so)
596 struct target_so_ops *ops = solib_ops (target_gdbarch);
598 free_so_symbols (so);
605 /* Return address of first so_list entry in master shared object list. */
607 master_so_list (void)
612 /* Read in symbols for shared object SO. If SYMFILE_VERBOSE is set in FLAGS,
613 be chatty about it. Return non-zero if any symbols were actually
617 solib_read_symbols (struct so_list *so, int flags)
619 const int from_tty = flags & SYMFILE_VERBOSE;
621 if (so->symbols_loaded)
623 /* If needed, we've already warned in our caller. */
625 else if (so->abfd == NULL)
627 /* We've already warned about this library, when trying to open
632 volatile struct gdb_exception e;
634 TRY_CATCH (e, RETURN_MASK_ERROR)
636 struct section_addr_info *sap;
638 /* Have we already loaded this shared object? */
639 ALL_OBJFILES (so->objfile)
641 if (strcmp (so->objfile->name, so->so_name) == 0)
644 if (so->objfile != NULL)
647 sap = build_section_addr_info_from_section_table (so->sections,
649 so->objfile = symbol_file_add_from_bfd (so->abfd,
650 flags, sap, OBJF_SHARED);
651 free_section_addr_info (sap);
655 exception_fprintf (gdb_stderr, e, _("Error while reading shared"
656 " library symbols for %s:\n"),
660 if (from_tty || info_verbose)
661 printf_unfiltered (_("Loaded symbols for %s\n"), so->so_name);
662 so->symbols_loaded = 1;
672 update_solib_list --- synchronize GDB's shared object list with inferior's
676 void update_solib_list (int from_tty, struct target_ops *TARGET)
678 Extract the list of currently loaded shared objects from the
679 inferior, and compare it with the list of shared objects currently
680 in GDB's so_list_head list. Edit so_list_head to bring it in sync
681 with the inferior's new list.
683 If we notice that the inferior has unloaded some shared objects,
684 free any symbolic info GDB had read about those shared objects.
686 Don't load symbolic info for any new shared objects; just add them
687 to the list, and leave their symbols_loaded flag clear.
689 If FROM_TTY is non-null, feel free to print messages about what
692 If TARGET is non-null, add the sections of all new shared objects
693 to TARGET's section table. Note that this doesn't remove any
694 sections for shared objects that have been unloaded, and it
695 doesn't check to see if the new shared objects are already present in
696 the section table. But we only use this for core files and
697 processes we've just attached to, so that's okay. */
700 update_solib_list (int from_tty, struct target_ops *target)
702 struct target_so_ops *ops = solib_ops (target_gdbarch);
703 struct so_list *inferior = ops->current_sos();
704 struct so_list *gdb, **gdb_link;
706 /* We can reach here due to changing solib-search-path or the
707 sysroot, before having any inferior. */
708 if (target_has_execution && !ptid_equal (inferior_ptid, null_ptid))
710 struct inferior *inf = current_inferior ();
712 /* If we are attaching to a running process for which we
713 have not opened a symbol file, we may be able to get its
715 if (inf->attach_flag && symfile_objfile == NULL)
716 catch_errors (ops->open_symbol_file_object, &from_tty,
717 "Error reading attached process's symbol file.\n",
721 /* GDB and the inferior's dynamic linker each maintain their own
722 list of currently loaded shared objects; we want to bring the
723 former in sync with the latter. Scan both lists, seeing which
724 shared objects appear where. There are three cases:
726 - A shared object appears on both lists. This means that GDB
727 knows about it already, and it's still loaded in the inferior.
728 Nothing needs to happen.
730 - A shared object appears only on GDB's list. This means that
731 the inferior has unloaded it. We should remove the shared
732 object from GDB's tables.
734 - A shared object appears only on the inferior's list. This
735 means that it's just been loaded. We should add it to GDB's
738 So we walk GDB's list, checking each entry to see if it appears
739 in the inferior's list too. If it does, no action is needed, and
740 we remove it from the inferior's list. If it doesn't, the
741 inferior has unloaded it, and we remove it from GDB's list. By
742 the time we're done walking GDB's list, the inferior's list
743 contains only the new shared objects, which we then add. */
746 gdb_link = &so_list_head;
749 struct so_list *i = inferior;
750 struct so_list **i_link = &inferior;
752 /* Check to see whether the shared object *gdb also appears in
753 the inferior's current list. */
758 if (ops->same (gdb, i))
763 if (! strcmp (gdb->so_original_name, i->so_original_name))
771 /* If the shared object appears on the inferior's list too, then
772 it's still loaded, so we don't need to do anything. Delete
773 it from the inferior's list, and leave it on GDB's list. */
778 gdb_link = &gdb->next;
782 /* If it's not on the inferior's list, remove it from GDB's tables. */
785 /* Notify any observer that the shared object has been
786 unloaded before we remove it from GDB's tables. */
787 observer_notify_solib_unloaded (gdb);
789 *gdb_link = gdb->next;
791 /* Unless the user loaded it explicitly, free SO's objfile. */
792 if (gdb->objfile && ! (gdb->objfile->flags & OBJF_USERLOADED))
793 free_objfile (gdb->objfile);
795 /* Some targets' section tables might be referring to
796 sections from so->abfd; remove them. */
797 remove_target_sections (gdb->abfd);
804 /* Now the inferior's list contains only shared objects that don't
805 appear in GDB's list --- those that are newly loaded. Add them
806 to GDB's shared object list. */
810 const char *not_found_filename = NULL;
814 /* Add the new shared objects to GDB's list. */
815 *gdb_link = inferior;
817 /* Fill in the rest of each of the `struct so_list' nodes. */
818 for (i = inferior; i; i = i->next)
820 volatile struct gdb_exception e;
822 i->pspace = current_program_space;
824 TRY_CATCH (e, RETURN_MASK_ERROR)
826 /* Fill in the rest of the `struct so_list' node. */
827 if (!solib_map_sections (i))
830 if (not_found_filename == NULL)
831 not_found_filename = i->so_original_name;
836 exception_fprintf (gdb_stderr, e,
837 _("Error while mapping shared "
838 "library sections:\n"));
840 /* Notify any observer that the shared object has been
841 loaded now that we've added it to GDB's tables. */
842 observer_notify_solib_loaded (i);
845 /* If a library was not found, issue an appropriate warning
846 message. We have to use a single call to warning in case the
847 front end does something special with warnings, e.g., pop up
848 a dialog box. It Would Be Nice if we could get a "warning: "
849 prefix on each line in the CLI front end, though - it doesn't
853 warning (_("Could not load shared library symbols for %s.\n"
854 "Do you need \"set solib-search-path\" "
855 "or \"set sysroot\"?"),
857 else if (not_found > 1)
859 Could not load shared library symbols for %d libraries, e.g. %s.\n\
860 Use the \"info sharedlibrary\" command to see the complete listing.\n\
861 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
862 not_found, not_found_filename);
867 /* Return non-zero if NAME is the libpthread shared library.
869 Uses a fairly simplistic heuristic approach where we check
870 the file name against "/libpthread". This can lead to false
871 positives, but this should be good enough in practice. */
874 libpthread_name_p (const char *name)
876 return (strstr (name, "/libpthread") != NULL);
879 /* Return non-zero if SO is the libpthread shared library. */
882 libpthread_solib_p (struct so_list *so)
884 return libpthread_name_p (so->so_name);
889 solib_add -- read in symbol info for newly added shared libraries
893 void solib_add (char *pattern, int from_tty, struct target_ops
894 *TARGET, int readsyms)
898 Read in symbolic information for any shared objects whose names
899 match PATTERN. (If we've already read a shared object's symbol
900 info, leave it alone.) If PATTERN is zero, read them all.
902 If READSYMS is 0, defer reading symbolic information until later
903 but still do any needed low level processing.
905 FROM_TTY and TARGET are as described for update_solib_list, above. */
908 solib_add (char *pattern, int from_tty,
909 struct target_ops *target, int readsyms)
915 char *re_err = re_comp (pattern);
918 error (_("Invalid regexp: %s"), re_err);
921 update_solib_list (from_tty, target);
923 /* Walk the list of currently loaded shared libraries, and read
924 symbols for any that match the pattern --- or any whose symbols
925 aren't already loaded, if no pattern was given. */
928 int loaded_any_symbols = 0;
930 SYMFILE_DEFER_BP_RESET | (from_tty ? SYMFILE_VERBOSE : 0);
932 for (gdb = so_list_head; gdb; gdb = gdb->next)
933 if (! pattern || re_exec (gdb->so_name))
935 /* Normally, we would read the symbols from that library
936 only if READSYMS is set. However, we're making a small
937 exception for the pthread library, because we sometimes
938 need the library symbols to be loaded in order to provide
939 thread support (x86-linux for instance). */
940 const int add_this_solib =
941 (readsyms || libpthread_solib_p (gdb));
946 if (gdb->symbols_loaded)
948 /* If no pattern was given, be quiet for shared
949 libraries we have already loaded. */
950 if (pattern && (from_tty || info_verbose))
951 printf_unfiltered (_("Symbols already loaded for %s\n"),
954 else if (solib_read_symbols (gdb, flags))
955 loaded_any_symbols = 1;
959 if (loaded_any_symbols)
960 breakpoint_re_set ();
962 if (from_tty && pattern && ! any_matches)
964 ("No loaded shared libraries match the pattern `%s'.\n", pattern);
966 if (loaded_any_symbols)
968 struct target_so_ops *ops = solib_ops (target_gdbarch);
970 /* Getting new symbols may change our opinion about what is
972 reinit_frame_cache ();
974 ops->special_symbol_handling ();
984 info_sharedlibrary_command -- code for "info sharedlibrary"
988 static void info_sharedlibrary_command ()
992 Walk through the shared library list and print information
993 about each attached library matching PATTERN. If PATTERN is elided,
998 info_sharedlibrary_command (char *pattern, int from_tty)
1000 struct so_list *so = NULL; /* link map state variable */
1001 int so_missing_debug_info = 0;
1004 struct cleanup *table_cleanup;
1005 struct gdbarch *gdbarch = target_gdbarch;
1009 char *re_err = re_comp (pattern);
1012 error (_("Invalid regexp: %s"), re_err);
1015 /* "0x", a little whitespace, and two hex digits per byte of pointers. */
1016 addr_width = 4 + (gdbarch_ptr_bit (gdbarch) / 4);
1018 update_solib_list (from_tty, 0);
1020 /* make_cleanup_ui_out_table_begin_end needs to know the number of
1021 rows, so we need to make two passes over the libs. */
1023 for (nr_libs = 0, so = so_list_head; so; so = so->next)
1027 if (pattern && ! re_exec (so->so_name))
1034 make_cleanup_ui_out_table_begin_end (uiout, 4, nr_libs,
1035 "SharedLibraryTable");
1037 /* The "- 1" is because ui_out adds one space between columns. */
1038 ui_out_table_header (uiout, addr_width - 1, ui_left, "from", "From");
1039 ui_out_table_header (uiout, addr_width - 1, ui_left, "to", "To");
1040 ui_out_table_header (uiout, 12 - 1, ui_left, "syms-read", "Syms Read");
1041 ui_out_table_header (uiout, 0, ui_noalign,
1042 "name", "Shared Object Library");
1044 ui_out_table_body (uiout);
1046 for (so = so_list_head; so; so = so->next)
1048 struct cleanup *lib_cleanup;
1050 if (! so->so_name[0])
1052 if (pattern && ! re_exec (so->so_name))
1055 lib_cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, "lib");
1057 if (so->addr_high != 0)
1059 ui_out_field_core_addr (uiout, "from", gdbarch, so->addr_low);
1060 ui_out_field_core_addr (uiout, "to", gdbarch, so->addr_high);
1064 ui_out_field_skip (uiout, "from");
1065 ui_out_field_skip (uiout, "to");
1068 if (! ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ()))
1069 && so->symbols_loaded
1070 && !objfile_has_symbols (so->objfile))
1072 so_missing_debug_info = 1;
1073 ui_out_field_string (uiout, "syms-read", "Yes (*)");
1076 ui_out_field_string (uiout, "syms-read",
1077 so->symbols_loaded ? "Yes" : "No");
1079 ui_out_field_string (uiout, "name", so->so_name);
1081 ui_out_text (uiout, "\n");
1083 do_cleanups (lib_cleanup);
1086 do_cleanups (table_cleanup);
1091 ui_out_message (uiout, 0,
1092 _("No shared libraries matched.\n"));
1094 ui_out_message (uiout, 0,
1095 _("No shared libraries loaded at this time.\n"));
1099 if (so_missing_debug_info)
1100 ui_out_message (uiout, 0,
1101 _("(*): Shared library is missing "
1102 "debugging information.\n"));
1106 /* Return 1 if ADDRESS lies within SOLIB. */
1109 solib_contains_address_p (const struct so_list *const solib,
1112 struct target_section *p;
1114 for (p = solib->sections; p < solib->sections_end; p++)
1115 if (p->addr <= address && address < p->endaddr)
1125 solib_name_from_address -- if an address is in a shared lib, return
1130 char * solib_name_from_address (CORE_ADDR address)
1134 Provides a hook for other gdb routines to discover whether or
1135 not a particular address is within the mapped address space of
1138 For example, this routine is called at one point to disable
1139 breakpoints which are in shared libraries that are not currently
1144 solib_name_from_address (struct program_space *pspace, CORE_ADDR address)
1146 struct so_list *so = NULL;
1148 for (so = pspace->so_list; so; so = so->next)
1149 if (solib_contains_address_p (so, address))
1150 return (so->so_name);
1155 /* Return whether the data starting at VADDR, size SIZE, must be kept
1156 in a core file for shared libraries loaded before "gcore" is used
1157 to be handled correctly when the core file is loaded. This only
1158 applies when the section would otherwise not be kept in the core
1159 file (in particular, for readonly sections). */
1162 solib_keep_data_in_core (CORE_ADDR vaddr, unsigned long size)
1164 struct target_so_ops *ops = solib_ops (target_gdbarch);
1166 if (ops->keep_data_in_core)
1167 return ops->keep_data_in_core (vaddr, size);
1172 /* Called by free_all_symtabs */
1177 struct target_so_ops *ops = solib_ops (target_gdbarch);
1179 /* This function is expected to handle ELF shared libraries. It is
1180 also used on Solaris, which can run either ELF or a.out binaries
1181 (for compatibility with SunOS 4), both of which can use shared
1182 libraries. So we don't know whether we have an ELF executable or
1183 an a.out executable until the user chooses an executable file.
1185 ELF shared libraries don't get mapped into the address space
1186 until after the program starts, so we'd better not try to insert
1187 breakpoints in them immediately. We have to wait until the
1188 dynamic linker has loaded them; we'll hit a bp_shlib_event
1189 breakpoint (look for calls to create_solib_event_breakpoint) when
1192 SunOS shared libraries seem to be different --- they're present
1193 as soon as the process begins execution, so there's no need to
1194 put off inserting breakpoints. There's also nowhere to put a
1195 bp_shlib_event breakpoint, so if we put it off, we'll never get
1198 So: disable breakpoints only if we're using ELF shared libs. */
1199 if (exec_bfd != NULL
1200 && bfd_get_flavour (exec_bfd) != bfd_target_aout_flavour)
1201 disable_breakpoints_in_shlibs ();
1203 while (so_list_head)
1205 struct so_list *so = so_list_head;
1207 so_list_head = so->next;
1208 observer_notify_solib_unloaded (so);
1210 remove_target_sections (so->abfd);
1214 ops->clear_solib ();
1219 solib_create_inferior_hook -- shared library startup support
1223 void solib_create_inferior_hook (int from_tty)
1227 When gdb starts up the inferior, it nurses it along (through the
1228 shell) until it is ready to execute it's first instruction. At this
1229 point, this function gets called via expansion of the macro
1230 SOLIB_CREATE_INFERIOR_HOOK. */
1233 solib_create_inferior_hook (int from_tty)
1235 struct target_so_ops *ops = solib_ops (target_gdbarch);
1237 ops->solib_create_inferior_hook (from_tty);
1242 in_solib_dynsym_resolve_code -- check to see if an address is in
1243 dynamic loader's dynamic symbol
1248 int in_solib_dynsym_resolve_code (CORE_ADDR pc)
1252 Determine if PC is in the dynamic linker's symbol resolution
1253 code. Return 1 if so, 0 otherwise.
1257 in_solib_dynsym_resolve_code (CORE_ADDR pc)
1259 struct target_so_ops *ops = solib_ops (target_gdbarch);
1261 return ops->in_dynsym_resolve_code (pc);
1268 sharedlibrary_command -- handle command to explicitly add library
1272 static void sharedlibrary_command (char *args, int from_tty)
1279 sharedlibrary_command (char *args, int from_tty)
1282 solib_add (args, from_tty, (struct target_ops *) 0, 1);
1287 no_shared_libraries -- handle command to explicitly discard symbols
1288 from shared libraries.
1292 Implements the command "nosharedlibrary", which discards symbols
1293 that have been auto-loaded from shared libraries. Symbols from
1294 shared libraries that were added by explicit request of the user
1295 are not discarded. Also called from remote.c. */
1298 no_shared_libraries (char *ignored, int from_tty)
1300 /* The order of the two routines below is important: clear_solib notifies
1301 the solib_unloaded observers, and some of these observers might need
1302 access to their associated objfiles. Therefore, we can not purge the
1303 solibs' objfiles before clear_solib has been called. */
1306 objfile_purge_solibs ();
1309 /* Reload shared libraries, but avoid reloading the same symbol file
1310 we already have loaded. */
1313 reload_shared_libraries_1 (int from_tty)
1316 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
1318 for (so = so_list_head; so != NULL; so = so->next)
1320 char *filename, *found_pathname = NULL;
1322 int was_loaded = so->symbols_loaded;
1324 SYMFILE_DEFER_BP_RESET | (from_tty ? SYMFILE_VERBOSE : 0);
1326 filename = tilde_expand (so->so_original_name);
1327 abfd = solib_bfd_open (filename);
1330 found_pathname = xstrdup (bfd_get_filename (abfd));
1331 make_cleanup (xfree, found_pathname);
1332 gdb_bfd_close_or_warn (abfd);
1335 /* If this shared library is no longer associated with its previous
1336 symbol file, close that. */
1337 if ((found_pathname == NULL && was_loaded)
1338 || (found_pathname != NULL
1339 && strcmp (found_pathname, so->so_name) != 0))
1341 if (so->objfile && ! (so->objfile->flags & OBJF_USERLOADED))
1342 free_objfile (so->objfile);
1343 remove_target_sections (so->abfd);
1344 free_so_symbols (so);
1347 /* If this shared library is now associated with a new symbol
1349 if (found_pathname != NULL
1351 || strcmp (found_pathname, so->so_name) != 0))
1353 volatile struct gdb_exception e;
1355 TRY_CATCH (e, RETURN_MASK_ERROR)
1356 solib_map_sections (so);
1359 exception_fprintf (gdb_stderr, e,
1360 _("Error while mapping "
1361 "shared library sections:\n"));
1362 else if (auto_solib_add || was_loaded || libpthread_solib_p (so))
1363 solib_read_symbols (so, flags);
1367 do_cleanups (old_chain);
1371 reload_shared_libraries (char *ignored, int from_tty,
1372 struct cmd_list_element *e)
1374 struct target_so_ops *ops;
1376 reload_shared_libraries_1 (from_tty);
1378 ops = solib_ops (target_gdbarch);
1380 /* Creating inferior hooks here has two purposes. First, if we reload
1381 shared libraries then the address of solib breakpoint we've computed
1382 previously might be no longer valid. For example, if we forgot to set
1383 solib-absolute-prefix and are setting it right now, then the previous
1384 breakpoint address is plain wrong. Second, installing solib hooks
1385 also implicitly figures were ld.so is and loads symbols for it.
1386 Absent this call, if we've just connected to a target and set
1387 solib-absolute-prefix or solib-search-path, we'll lose all information
1389 if (target_has_execution)
1391 /* Reset or free private data structures not associated with
1393 ops->clear_solib ();
1395 /* Remove any previous solib event breakpoint. This is usually
1396 done in common code, at breakpoint_init_inferior time, but
1397 we're not really starting up the inferior here. */
1398 remove_solib_event_breakpoints ();
1400 #ifdef SOLIB_CREATE_INFERIOR_HOOK
1401 SOLIB_CREATE_INFERIOR_HOOK (PIDGET (inferior_ptid));
1403 solib_create_inferior_hook (from_tty);
1407 /* Sometimes the platform-specific hook loads initial shared
1408 libraries, and sometimes it doesn't. If it doesn't FROM_TTY will be
1409 incorrectly 0 but such solib targets should be fixed anyway. If we
1410 made all the inferior hook methods consistent, this call could be
1411 removed. Call it only after the solib target has been initialized by
1412 solib_create_inferior_hook. */
1414 solib_add (NULL, 0, NULL, auto_solib_add);
1416 breakpoint_re_set ();
1418 /* We may have loaded or unloaded debug info for some (or all)
1419 shared libraries. However, frames may still reference them. For
1420 example, a frame's unwinder might still point at DWARF FDE
1421 structures that are now freed. Also, getting new symbols may
1422 change our opinion about what is frameless. */
1423 reinit_frame_cache ();
1425 ops->special_symbol_handling ();
1429 show_auto_solib_add (struct ui_file *file, int from_tty,
1430 struct cmd_list_element *c, const char *value)
1432 fprintf_filtered (file, _("Autoloading of shared library symbols is %s.\n"),
1437 /* Handler for library-specific lookup of global symbol NAME in OBJFILE. Call
1438 the library-specific handler if it is installed for the current target. */
1441 solib_global_lookup (const struct objfile *objfile,
1443 const domain_enum domain)
1445 struct target_so_ops *ops = solib_ops (target_gdbarch);
1447 if (ops->lookup_lib_global_symbol != NULL)
1448 return ops->lookup_lib_global_symbol (objfile, name, domain);
1453 extern initialize_file_ftype _initialize_solib; /* -Wmissing-prototypes */
1456 _initialize_solib (void)
1458 solib_data = gdbarch_data_register_pre_init (solib_init);
1460 add_com ("sharedlibrary", class_files, sharedlibrary_command,
1461 _("Load shared object library symbols for files matching REGEXP."));
1462 add_info ("sharedlibrary", info_sharedlibrary_command,
1463 _("Status of loaded shared object libraries."));
1464 add_com ("nosharedlibrary", class_files, no_shared_libraries,
1465 _("Unload all shared object library symbols."));
1467 add_setshow_boolean_cmd ("auto-solib-add", class_support,
1468 &auto_solib_add, _("\
1469 Set autoloading of shared library symbols."), _("\
1470 Show autoloading of shared library symbols."), _("\
1471 If \"on\", symbols from all shared object libraries will be loaded\n\
1472 automatically when the inferior begins execution, when the dynamic linker\n\
1473 informs gdb that a new library has been loaded, or when attaching to the\n\
1474 inferior. Otherwise, symbols must be loaded manually, using \
1477 show_auto_solib_add,
1478 &setlist, &showlist);
1480 add_setshow_filename_cmd ("sysroot", class_support,
1482 Set an alternate system root."), _("\
1483 Show the current system root."), _("\
1484 The system root is used to load absolute shared library symbol files.\n\
1485 For other (relative) files, you can add directories using\n\
1486 `set solib-search-path'."),
1487 reload_shared_libraries,
1489 &setlist, &showlist);
1491 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1493 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1496 add_setshow_optional_filename_cmd ("solib-search-path", class_support,
1497 &solib_search_path, _("\
1498 Set the search path for loading non-absolute shared library symbol files."),
1500 Show the search path for loading non-absolute shared library symbol files."),
1502 This takes precedence over the environment variables \
1503 PATH and LD_LIBRARY_PATH."),
1504 reload_shared_libraries,
1505 show_solib_search_path,
1506 &setlist, &showlist);