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
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);
74 /* Set the solib operations for GDBARCH to NEW_OPS. */
77 set_solib_ops (struct gdbarch *gdbarch, struct target_so_ops *new_ops)
79 struct target_so_ops **ops = gdbarch_data (gdbarch, solib_data);
84 /* external data declarations */
86 /* FIXME: gdbarch needs to control this variable, or else every
87 configuration needs to call set_solib_ops. */
88 struct target_so_ops *current_target_so_ops;
90 /* List of known shared objects */
91 #define so_list_head current_program_space->so_list
93 /* Local function prototypes */
95 /* If non-empty, this is a search path for loading non-absolute shared library
96 symbol files. This takes precedence over the environment variables PATH
97 and LD_LIBRARY_PATH. */
98 static char *solib_search_path = NULL;
100 show_solib_search_path (struct ui_file *file, int from_tty,
101 struct cmd_list_element *c, const char *value)
103 fprintf_filtered (file, _("\
104 The search path for loading non-absolute shared library symbol files is %s.\n"),
108 /* Same as HAVE_DOS_BASED_FILE_SYSTEM, but useable as an rvalue. */
109 #if (HAVE_DOS_BASED_FILE_SYSTEM)
110 # define DOS_BASED_FILE_SYSTEM 1
112 # define DOS_BASED_FILE_SYSTEM 0
119 solib_find -- Find a shared library file.
123 char *solib_find (char *in_pathname, int *fd);
127 Global variable GDB_SYSROOT is used as a prefix directory
128 to search for shared libraries if they have an absolute path.
130 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
131 (or set of directories, as in LD_LIBRARY_PATH) to search for all
132 shared libraries if not found in GDB_SYSROOT.
135 * If there is a gdb_sysroot and path is absolute:
136 * Search for gdb_sysroot/path.
138 * Look for it literally (unmodified).
139 * Look in SOLIB_SEARCH_PATH.
140 * If available, use target defined search function.
141 * If gdb_sysroot is NOT set, perform the following two searches:
142 * Look in inferior's $PATH.
143 * Look in inferior's $LD_LIBRARY_PATH.
145 * The last check avoids doing this search when targetting remote
146 * machines since gdb_sysroot will almost always be set.
150 Full pathname of the shared library file, or NULL if not found.
151 (The pathname is malloc'ed; it needs to be freed by the caller.)
152 *FD is set to either -1 or an open file handle for the library. */
155 solib_find (char *in_pathname, int *fd)
157 struct target_so_ops *ops = solib_ops (target_gdbarch);
159 char *temp_pathname = NULL;
160 int gdb_sysroot_is_empty;
161 const char *solib_symbols_extension
162 = gdbarch_solib_symbols_extension (target_gdbarch);
163 const char *fskind = effective_target_file_system_kind ();
164 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
165 char *sysroot = NULL;
167 /* If solib_symbols_extension is set, replace the file's
169 if (solib_symbols_extension)
171 char *p = in_pathname + strlen (in_pathname);
172 while (p > in_pathname && *p != '.')
179 new_pathname = alloca (p - in_pathname + 1
180 + strlen (solib_symbols_extension) + 1);
181 memcpy (new_pathname, in_pathname, p - in_pathname + 1);
182 strcpy (new_pathname + (p - in_pathname) + 1,
183 solib_symbols_extension);
185 in_pathname = new_pathname;
189 gdb_sysroot_is_empty = (gdb_sysroot == NULL || *gdb_sysroot == 0);
191 if (!gdb_sysroot_is_empty)
193 int prefix_len = strlen (gdb_sysroot);
195 /* Remove trailing slashes from absolute prefix. */
196 while (prefix_len > 0
197 && IS_DIR_SEPARATOR (gdb_sysroot[prefix_len - 1]))
200 sysroot = savestring (gdb_sysroot, prefix_len);
201 make_cleanup (xfree, sysroot);
204 /* If we're on a non-DOS-based system, backslashes won't be
205 understood as directory separator, so, convert them to forward
206 slashes, iff we're supposed to handle DOS-based file system
207 semantics for target paths. */
208 if (!DOS_BASED_FILE_SYSTEM && fskind == file_system_kind_dos_based)
212 /* Avoid clobbering our input. */
213 p = alloca (strlen (in_pathname) + 1);
214 strcpy (p, in_pathname);
224 /* Note, we're interested in IS_TARGET_ABSOLUTE_PATH, not
225 IS_ABSOLUTE_PATH. The latter is for host paths only, while
226 IN_PATHNAME is a target path. For example, if we're supposed to
227 be handling DOS-like semantics we want to consider a
228 'c:/foo/bar.dll' path as an absolute path, even on a Unix box.
229 With such a path, before giving up on the sysroot, we'll try:
231 1st attempt, c:/foo/bar.dll ==> /sysroot/c:/foo/bar.dll
232 2nd attempt, c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll
233 3rd attempt, c:/foo/bar.dll ==> /sysroot/foo/bar.dll
236 if (!IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname) || gdb_sysroot_is_empty)
237 temp_pathname = xstrdup (in_pathname);
240 int need_dir_separator;
242 need_dir_separator = !IS_DIR_SEPARATOR (in_pathname[0]);
244 /* Cat the prefixed pathname together. */
245 temp_pathname = concat (sysroot,
246 need_dir_separator ? SLASH_STRING : "",
247 in_pathname, (char *) NULL);
250 /* Handle remote files. */
251 if (remote_filename_p (temp_pathname))
254 return temp_pathname;
257 /* Now see if we can open it. */
258 found_file = open (temp_pathname, O_RDONLY | O_BINARY, 0);
260 xfree (temp_pathname);
262 /* If the search in gdb_sysroot failed, and the path name has a
263 drive spec (e.g, c:/foo), try stripping ':' from the drive spec,
264 and retrying in the sysroot:
265 c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll. */
268 && !gdb_sysroot_is_empty
269 && HAS_TARGET_DRIVE_SPEC (fskind, in_pathname))
271 int need_dir_separator = !IS_DIR_SEPARATOR (in_pathname[2]);
272 char *drive = savestring (in_pathname, 1);
274 temp_pathname = concat (sysroot,
277 need_dir_separator ? SLASH_STRING : "",
278 in_pathname + 2, (char *) NULL);
281 found_file = open (temp_pathname, O_RDONLY | O_BINARY, 0);
284 xfree (temp_pathname);
286 /* If the search in gdb_sysroot still failed, try fully
287 stripping the drive spec, and trying once more in the
288 sysroot before giving up.
290 c:/foo/bar.dll ==> /sysroot/foo/bar.dll. */
292 temp_pathname = concat (sysroot,
293 need_dir_separator ? SLASH_STRING : "",
294 in_pathname + 2, (char *) NULL);
296 found_file = open (temp_pathname, O_RDONLY | O_BINARY, 0);
298 xfree (temp_pathname);
302 do_cleanups (old_chain);
304 /* We try to find the library in various ways. After each attempt,
305 either found_file >= 0 and temp_pathname is a malloc'd string, or
306 found_file < 0 and temp_pathname does not point to storage that
307 needs to be freed. */
310 temp_pathname = NULL;
312 /* If not found, search the solib_search_path (if any). */
313 if (found_file < 0 && solib_search_path != NULL)
314 found_file = openp (solib_search_path, OPF_TRY_CWD_FIRST,
315 in_pathname, O_RDONLY | O_BINARY, &temp_pathname);
317 /* If the search in gdb_sysroot failed, and the path name is
318 absolute at this point, make it relative. (openp will try and open the
319 file according to its absolute path otherwise, which is not what we want.)
320 Affects subsequent searches for this solib. */
321 if (found_file < 0 && IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname))
323 /* First, get rid of any drive letters etc. */
324 while (!IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
327 /* Next, get rid of all leading dir separators. */
328 while (IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
332 /* If not found, search the solib_search_path (if any). */
333 if (found_file < 0 && solib_search_path != NULL)
334 found_file = openp (solib_search_path, OPF_TRY_CWD_FIRST,
335 in_pathname, O_RDONLY | O_BINARY, &temp_pathname);
337 /* If not found, next search the solib_search_path (if any) for the basename
338 only (ignoring the path). This is to allow reading solibs from a path
339 that differs from the opened path. */
340 if (found_file < 0 && solib_search_path != NULL)
341 found_file = openp (solib_search_path, OPF_TRY_CWD_FIRST,
342 target_lbasename (fskind, in_pathname),
343 O_RDONLY | O_BINARY, &temp_pathname);
345 /* If not found, try to use target supplied solib search method */
346 if (found_file < 0 && ops->find_and_open_solib)
347 found_file = ops->find_and_open_solib (in_pathname, O_RDONLY | O_BINARY,
350 /* If not found, next search the inferior's $PATH environment variable. */
351 if (found_file < 0 && gdb_sysroot_is_empty)
352 found_file = openp (get_in_environ (current_inferior ()->environment,
354 OPF_TRY_CWD_FIRST, in_pathname, O_RDONLY | O_BINARY,
357 /* If not found, next search the inferior's $LD_LIBRARY_PATH
358 environment variable. */
359 if (found_file < 0 && gdb_sysroot_is_empty)
360 found_file = openp (get_in_environ (current_inferior ()->environment,
362 OPF_TRY_CWD_FIRST, in_pathname, O_RDONLY | O_BINARY,
366 return temp_pathname;
369 /* Open and return a BFD for the shared library PATHNAME. If FD is not -1,
370 it is used as file handle to open the file. Throws an error if the file
371 could not be opened. Handles both local and remote file access.
373 PATHNAME must be malloc'ed by the caller. If successful, the new BFD's
374 name will point to it. If unsuccessful, PATHNAME will be freed and the
375 FD will be closed (unless FD was -1). */
378 solib_bfd_fopen (char *pathname, int fd)
382 if (remote_filename_p (pathname))
384 gdb_assert (fd == -1);
385 abfd = remote_bfd_open (pathname, gnutarget);
389 abfd = bfd_fopen (pathname, gnutarget, FOPEN_RB, fd);
392 bfd_set_cacheable (abfd, 1);
399 make_cleanup (xfree, pathname);
400 error (_("Could not open `%s' as an executable file: %s"),
401 pathname, bfd_errmsg (bfd_get_error ()));
407 /* Find shared library PATHNAME and open a BFD for it. */
410 solib_bfd_open (char *pathname)
412 char *found_pathname;
415 const struct bfd_arch_info *b;
417 /* Search for shared library file. */
418 found_pathname = solib_find (pathname, &found_file);
419 if (found_pathname == NULL)
421 /* Return failure if the file could not be found, so that we can
422 accumulate messages about missing libraries. */
426 perror_with_name (pathname);
429 /* Open bfd for shared library. */
430 abfd = solib_bfd_fopen (found_pathname, found_file);
432 /* Check bfd format. */
433 if (!bfd_check_format (abfd, bfd_object))
436 make_cleanup (xfree, found_pathname);
437 error (_("`%s': not in executable format: %s"),
438 found_pathname, bfd_errmsg (bfd_get_error ()));
441 /* Check bfd arch. */
442 b = gdbarch_bfd_arch_info (target_gdbarch);
443 if (!b->compatible (b, bfd_get_arch_info (abfd)))
444 warning (_("`%s': Shared library architecture %s is not compatible "
445 "with target architecture %s."), found_pathname,
446 bfd_get_arch_info (abfd)->printable_name, b->printable_name);
456 solib_map_sections -- open bfd and build sections for shared lib
460 static int solib_map_sections (struct so_list *so)
464 Given a pointer to one of the shared objects in our list
465 of mapped objects, use the recorded name to open a bfd
466 descriptor for the object, build a section table, and then
467 relocate all the section addresses by the base address at
468 which the shared object was mapped.
472 In most (all?) cases the shared object file name recorded in the
473 dynamic linkage tables will be a fully qualified pathname. For
474 cases where it isn't, do we really mimic the systems search
475 mechanism correctly in the below code (particularly the tilde
480 solib_map_sections (struct so_list *so)
482 struct target_so_ops *ops = solib_ops (target_gdbarch);
484 struct target_section *p;
485 struct cleanup *old_chain;
488 filename = tilde_expand (so->so_name);
489 old_chain = make_cleanup (xfree, filename);
490 abfd = ops->bfd_open (filename);
491 do_cleanups (old_chain);
496 /* Leave bfd open, core_xfer_memory and "info files" need it. */
497 so->abfd = gdb_bfd_ref (abfd);
499 /* copy full path name into so_name, so that later symbol_file_add
501 if (strlen (bfd_get_filename (abfd)) >= SO_NAME_MAX_PATH_SIZE)
502 error (_("Shared library file name is too long."));
503 strcpy (so->so_name, bfd_get_filename (abfd));
505 if (build_section_table (abfd, &so->sections, &so->sections_end))
507 error (_("Can't find the file sections in `%s': %s"),
508 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
511 for (p = so->sections; p < so->sections_end; p++)
513 /* Relocate the section binding addresses as recorded in the shared
514 object's file by the base address to which the object was actually
516 ops->relocate_section_addresses (so, p);
518 /* If the target didn't provide information about the address
519 range of the shared object, assume we want the location of
520 the .text section. */
521 if (so->addr_low == 0 && so->addr_high == 0
522 && strcmp (p->the_bfd_section->name, ".text") == 0)
524 so->addr_low = p->addr;
525 so->addr_high = p->endaddr;
529 /* Add the shared object's sections to the current set of file
530 section tables. Do this immediately after mapping the object so
531 that later nodes in the list can query this object, as is needed
533 add_target_sections (so->sections, so->sections_end);
538 /* Free symbol-file related contents of SO. If we have opened a BFD
539 for SO, close it. If we have placed SO's sections in some target's
540 section table, the caller is responsible for removing them.
542 This function doesn't mess with objfiles at all. If there is an
543 objfile associated with SO that needs to be removed, the caller is
544 responsible for taking care of that. */
547 free_so_symbols (struct so_list *so)
551 xfree (so->sections);
552 so->sections = so->sections_end = NULL;
555 gdb_bfd_unref (so->abfd);
558 /* Our caller closed the objfile, possibly via objfile_purge_solibs. */
559 so->symbols_loaded = 0;
562 so->addr_low = so->addr_high = 0;
564 /* Restore the target-supplied file name. SO_NAME may be the path
565 of the symbol file. */
566 strcpy (so->so_name, so->so_original_name);
571 free_so --- free a `struct so_list' object
575 void free_so (struct so_list *so)
579 Free the storage associated with the `struct so_list' object SO.
580 If we have opened a BFD for SO, close it.
582 The caller is responsible for removing SO from whatever list it is
583 a member of. If we have placed SO's sections in some target's
584 section table, the caller is responsible for removing them.
586 This function doesn't mess with objfiles at all. If there is an
587 objfile associated with SO that needs to be removed, the caller is
588 responsible for taking care of that. */
591 free_so (struct so_list *so)
593 struct target_so_ops *ops = solib_ops (target_gdbarch);
595 free_so_symbols (so);
602 /* Return address of first so_list entry in master shared object list. */
604 master_so_list (void)
609 /* Read in symbols for shared object SO. If SYMFILE_VERBOSE is set in FLAGS,
610 be chatty about it. Return non-zero if any symbols were actually
614 solib_read_symbols (struct so_list *so, int flags)
616 const int from_tty = flags & SYMFILE_VERBOSE;
618 if (so->symbols_loaded)
620 /* If needed, we've already warned in our caller. */
622 else if (so->abfd == NULL)
624 /* We've already warned about this library, when trying to open
629 volatile struct gdb_exception e;
631 TRY_CATCH (e, RETURN_MASK_ERROR)
633 struct section_addr_info *sap;
635 /* Have we already loaded this shared object? */
636 ALL_OBJFILES (so->objfile)
638 if (strcmp (so->objfile->name, so->so_name) == 0)
641 if (so->objfile != NULL)
644 sap = build_section_addr_info_from_section_table (so->sections,
646 so->objfile = symbol_file_add_from_bfd (so->abfd,
647 flags, sap, OBJF_SHARED);
648 free_section_addr_info (sap);
656 _("Error while reading shared library symbols:\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 library sections:\n"));
839 /* Notify any observer that the shared object has been
840 loaded now that we've added it to GDB's tables. */
841 observer_notify_solib_loaded (i);
844 /* If a library was not found, issue an appropriate warning
845 message. We have to use a single call to warning in case the
846 front end does something special with warnings, e.g., pop up
847 a dialog box. It Would Be Nice if we could get a "warning: "
848 prefix on each line in the CLI front end, though - it doesn't
853 Could not load shared library symbols for %s.\n\
854 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
856 else if (not_found > 1)
858 Could not load shared library symbols for %d libraries, e.g. %s.\n\
859 Use the \"info sharedlibrary\" command to see the complete listing.\n\
860 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
861 not_found, not_found_filename);
866 /* Return non-zero if NAME is the libpthread shared library.
868 Uses a fairly simplistic heuristic approach where we check
869 the file name against "/libpthread". This can lead to false
870 positives, but this should be good enough in practice. */
873 libpthread_name_p (const char *name)
875 return (strstr (name, "/libpthread") != NULL);
878 /* Return non-zero if SO is the libpthread shared library. */
881 libpthread_solib_p (struct so_list *so)
883 return libpthread_name_p (so->so_name);
888 solib_add -- read in symbol info for newly added shared libraries
892 void solib_add (char *pattern, int from_tty, struct target_ops
893 *TARGET, int readsyms)
897 Read in symbolic information for any shared objects whose names
898 match PATTERN. (If we've already read a shared object's symbol
899 info, leave it alone.) If PATTERN is zero, read them all.
901 If READSYMS is 0, defer reading symbolic information until later
902 but still do any needed low level processing.
904 FROM_TTY and TARGET are as described for update_solib_list, above. */
907 solib_add (char *pattern, int from_tty, struct target_ops *target, int readsyms)
913 char *re_err = re_comp (pattern);
916 error (_("Invalid regexp: %s"), re_err);
919 update_solib_list (from_tty, target);
921 /* Walk the list of currently loaded shared libraries, and read
922 symbols for any that match the pattern --- or any whose symbols
923 aren't already loaded, if no pattern was given. */
926 int loaded_any_symbols = 0;
928 SYMFILE_DEFER_BP_RESET | (from_tty ? SYMFILE_VERBOSE : 0);
930 for (gdb = so_list_head; gdb; gdb = gdb->next)
931 if (! pattern || re_exec (gdb->so_name))
933 /* Normally, we would read the symbols from that library
934 only if READSYMS is set. However, we're making a small
935 exception for the pthread library, because we sometimes
936 need the library symbols to be loaded in order to provide
937 thread support (x86-linux for instance). */
938 const int add_this_solib =
939 (readsyms || libpthread_solib_p (gdb));
944 if (gdb->symbols_loaded)
946 /* If no pattern was given, be quiet for shared
947 libraries we have already loaded. */
948 if (pattern && (from_tty || info_verbose))
949 printf_unfiltered (_("Symbols already loaded for %s\n"),
952 else if (solib_read_symbols (gdb, flags))
953 loaded_any_symbols = 1;
957 if (loaded_any_symbols)
958 breakpoint_re_set ();
960 if (from_tty && pattern && ! any_matches)
962 ("No loaded shared libraries match the pattern `%s'.\n", pattern);
964 if (loaded_any_symbols)
966 struct target_so_ops *ops = solib_ops (target_gdbarch);
968 /* Getting new symbols may change our opinion about what is
970 reinit_frame_cache ();
972 ops->special_symbol_handling ();
982 info_sharedlibrary_command -- code for "info sharedlibrary"
986 static void info_sharedlibrary_command ()
990 Walk through the shared library list and print information
991 about each attached library matching PATTERN. If PATTERN is elided,
996 info_sharedlibrary_command (char *pattern, int from_tty)
998 struct so_list *so = NULL; /* link map state variable */
999 int so_missing_debug_info = 0;
1002 struct cleanup *table_cleanup;
1003 struct gdbarch *gdbarch = target_gdbarch;
1007 char *re_err = re_comp (pattern);
1010 error (_("Invalid regexp: %s"), re_err);
1013 /* "0x", a little whitespace, and two hex digits per byte of pointers. */
1014 addr_width = 4 + (gdbarch_ptr_bit (gdbarch) / 4);
1016 update_solib_list (from_tty, 0);
1018 /* make_cleanup_ui_out_table_begin_end needs to know the number of
1019 rows, so we need to make two passes over the libs. */
1021 for (nr_libs = 0, so = so_list_head; so; so = so->next)
1025 if (pattern && ! re_exec (so->so_name))
1032 make_cleanup_ui_out_table_begin_end (uiout, 4, nr_libs,
1033 "SharedLibraryTable");
1035 /* The "- 1" is because ui_out adds one space between columns. */
1036 ui_out_table_header (uiout, addr_width - 1, ui_left, "from", "From");
1037 ui_out_table_header (uiout, addr_width - 1, ui_left, "to", "To");
1038 ui_out_table_header (uiout, 12 - 1, ui_left, "syms-read", "Syms Read");
1039 ui_out_table_header (uiout, 0, ui_noalign,
1040 "name", "Shared Object Library");
1042 ui_out_table_body (uiout);
1044 for (so = so_list_head; so; so = so->next)
1046 struct cleanup *lib_cleanup;
1048 if (! so->so_name[0])
1050 if (pattern && ! re_exec (so->so_name))
1053 lib_cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, "lib");
1055 if (so->addr_high != 0)
1057 ui_out_field_core_addr (uiout, "from", gdbarch, so->addr_low);
1058 ui_out_field_core_addr (uiout, "to", gdbarch, so->addr_high);
1062 ui_out_field_skip (uiout, "from");
1063 ui_out_field_skip (uiout, "to");
1066 if (! ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ()))
1067 && so->symbols_loaded
1068 && !objfile_has_symbols (so->objfile))
1070 so_missing_debug_info = 1;
1071 ui_out_field_string (uiout, "syms-read", "Yes (*)");
1074 ui_out_field_string (uiout, "syms-read",
1075 so->symbols_loaded ? "Yes" : "No");
1077 ui_out_field_string (uiout, "name", so->so_name);
1079 ui_out_text (uiout, "\n");
1081 do_cleanups (lib_cleanup);
1084 do_cleanups (table_cleanup);
1089 ui_out_message (uiout, 0,
1090 _("No shared libraries matched.\n"));
1092 ui_out_message (uiout, 0,
1093 _("No shared libraries loaded at this time.\n"));
1097 if (so_missing_debug_info)
1098 ui_out_message (uiout, 0,
1099 _("(*): Shared library is missing debugging information.\n"));
1103 /* Return 1 if ADDRESS lies within SOLIB. */
1106 solib_contains_address_p (const struct so_list *const solib,
1109 struct target_section *p;
1111 for (p = solib->sections; p < solib->sections_end; p++)
1112 if (p->addr <= address && address < p->endaddr)
1122 solib_name_from_address -- if an address is in a shared lib, return
1127 char * solib_name_from_address (CORE_ADDR address)
1131 Provides a hook for other gdb routines to discover whether or
1132 not a particular address is within the mapped address space of
1135 For example, this routine is called at one point to disable
1136 breakpoints which are in shared libraries that are not currently
1141 solib_name_from_address (struct program_space *pspace, CORE_ADDR address)
1143 struct so_list *so = NULL;
1145 for (so = pspace->so_list; so; so = so->next)
1146 if (solib_contains_address_p (so, address))
1147 return (so->so_name);
1152 /* Return whether the data starting at VADDR, size SIZE, must be kept
1153 in a core file for shared libraries loaded before "gcore" is used
1154 to be handled correctly when the core file is loaded. This only
1155 applies when the section would otherwise not be kept in the core
1156 file (in particular, for readonly sections). */
1159 solib_keep_data_in_core (CORE_ADDR vaddr, unsigned long size)
1161 struct target_so_ops *ops = solib_ops (target_gdbarch);
1163 if (ops->keep_data_in_core)
1164 return ops->keep_data_in_core (vaddr, size);
1169 /* Called by free_all_symtabs */
1174 struct target_so_ops *ops = solib_ops (target_gdbarch);
1176 /* This function is expected to handle ELF shared libraries. It is
1177 also used on Solaris, which can run either ELF or a.out binaries
1178 (for compatibility with SunOS 4), both of which can use shared
1179 libraries. So we don't know whether we have an ELF executable or
1180 an a.out executable until the user chooses an executable file.
1182 ELF shared libraries don't get mapped into the address space
1183 until after the program starts, so we'd better not try to insert
1184 breakpoints in them immediately. We have to wait until the
1185 dynamic linker has loaded them; we'll hit a bp_shlib_event
1186 breakpoint (look for calls to create_solib_event_breakpoint) when
1189 SunOS shared libraries seem to be different --- they're present
1190 as soon as the process begins execution, so there's no need to
1191 put off inserting breakpoints. There's also nowhere to put a
1192 bp_shlib_event breakpoint, so if we put it off, we'll never get
1195 So: disable breakpoints only if we're using ELF shared libs. */
1196 if (exec_bfd != NULL
1197 && bfd_get_flavour (exec_bfd) != bfd_target_aout_flavour)
1198 disable_breakpoints_in_shlibs ();
1200 while (so_list_head)
1202 struct so_list *so = so_list_head;
1203 so_list_head = so->next;
1204 observer_notify_solib_unloaded (so);
1206 remove_target_sections (so->abfd);
1210 ops->clear_solib ();
1215 solib_create_inferior_hook -- shared library startup support
1219 void solib_create_inferior_hook (int from_tty)
1223 When gdb starts up the inferior, it nurses it along (through the
1224 shell) until it is ready to execute it's first instruction. At this
1225 point, this function gets called via expansion of the macro
1226 SOLIB_CREATE_INFERIOR_HOOK. */
1229 solib_create_inferior_hook (int from_tty)
1231 struct target_so_ops *ops = solib_ops (target_gdbarch);
1232 ops->solib_create_inferior_hook (from_tty);
1237 in_solib_dynsym_resolve_code -- check to see if an address is in
1238 dynamic loader's dynamic symbol
1243 int in_solib_dynsym_resolve_code (CORE_ADDR pc)
1247 Determine if PC is in the dynamic linker's symbol resolution
1248 code. Return 1 if so, 0 otherwise.
1252 in_solib_dynsym_resolve_code (CORE_ADDR pc)
1254 struct target_so_ops *ops = solib_ops (target_gdbarch);
1255 return ops->in_dynsym_resolve_code (pc);
1262 sharedlibrary_command -- handle command to explicitly add library
1266 static void sharedlibrary_command (char *args, int from_tty)
1273 sharedlibrary_command (char *args, int from_tty)
1276 solib_add (args, from_tty, (struct target_ops *) 0, 1);
1281 no_shared_libraries -- handle command to explicitly discard symbols
1282 from shared libraries.
1286 Implements the command "nosharedlibrary", which discards symbols
1287 that have been auto-loaded from shared libraries. Symbols from
1288 shared libraries that were added by explicit request of the user
1289 are not discarded. Also called from remote.c. */
1292 no_shared_libraries (char *ignored, int from_tty)
1294 /* The order of the two routines below is important: clear_solib notifies
1295 the solib_unloaded observers, and some of these observers might need
1296 access to their associated objfiles. Therefore, we can not purge the
1297 solibs' objfiles before clear_solib has been called. */
1300 objfile_purge_solibs ();
1303 /* Reload shared libraries, but avoid reloading the same symbol file
1304 we already have loaded. */
1307 reload_shared_libraries_1 (int from_tty)
1310 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
1312 for (so = so_list_head; so != NULL; so = so->next)
1314 char *filename, *found_pathname = NULL;
1316 int was_loaded = so->symbols_loaded;
1318 SYMFILE_DEFER_BP_RESET | (from_tty ? SYMFILE_VERBOSE : 0);
1320 filename = tilde_expand (so->so_original_name);
1321 abfd = solib_bfd_open (filename);
1324 found_pathname = xstrdup (bfd_get_filename (abfd));
1325 make_cleanup (xfree, found_pathname);
1326 gdb_bfd_close_or_warn (abfd);
1329 /* If this shared library is no longer associated with its previous
1330 symbol file, close that. */
1331 if ((found_pathname == NULL && was_loaded)
1332 || (found_pathname != NULL
1333 && strcmp (found_pathname, so->so_name) != 0))
1335 if (so->objfile && ! (so->objfile->flags & OBJF_USERLOADED))
1336 free_objfile (so->objfile);
1337 remove_target_sections (so->abfd);
1338 free_so_symbols (so);
1341 /* If this shared library is now associated with a new symbol
1343 if (found_pathname != NULL
1345 || strcmp (found_pathname, so->so_name) != 0))
1347 volatile struct gdb_exception e;
1349 TRY_CATCH (e, RETURN_MASK_ERROR)
1350 solib_map_sections (so);
1353 exception_fprintf (gdb_stderr, e, _("\
1354 Error while mapping shared library sections:\n"));
1355 else if (auto_solib_add || was_loaded || libpthread_solib_p (so))
1356 solib_read_symbols (so, flags);
1360 do_cleanups (old_chain);
1364 reload_shared_libraries (char *ignored, int from_tty,
1365 struct cmd_list_element *e)
1367 struct target_so_ops *ops;
1369 reload_shared_libraries_1 (from_tty);
1371 ops = solib_ops (target_gdbarch);
1373 /* Creating inferior hooks here has two purposes. First, if we reload
1374 shared libraries then the address of solib breakpoint we've computed
1375 previously might be no longer valid. For example, if we forgot to set
1376 solib-absolute-prefix and are setting it right now, then the previous
1377 breakpoint address is plain wrong. Second, installing solib hooks
1378 also implicitly figures were ld.so is and loads symbols for it.
1379 Absent this call, if we've just connected to a target and set
1380 solib-absolute-prefix or solib-search-path, we'll lose all information
1382 if (target_has_execution)
1384 /* Reset or free private data structures not associated with
1386 ops->clear_solib ();
1388 /* Remove any previous solib event breakpoint. This is usually
1389 done in common code, at breakpoint_init_inferior time, but
1390 we're not really starting up the inferior here. */
1391 remove_solib_event_breakpoints ();
1393 #ifdef SOLIB_CREATE_INFERIOR_HOOK
1394 SOLIB_CREATE_INFERIOR_HOOK (PIDGET (inferior_ptid));
1396 solib_create_inferior_hook (from_tty);
1400 /* Sometimes the platform-specific hook loads initial shared
1401 libraries, and sometimes it doesn't. If it doesn't FROM_TTY will be
1402 incorrectly 0 but such solib targets should be fixed anyway. If we
1403 made all the inferior hook methods consistent, this call could be
1404 removed. Call it only after the solib target has been initialized by
1405 solib_create_inferior_hook. */
1407 solib_add (NULL, 0, NULL, auto_solib_add);
1409 breakpoint_re_set ();
1411 /* We may have loaded or unloaded debug info for some (or all)
1412 shared libraries. However, frames may still reference them. For
1413 example, a frame's unwinder might still point at DWARF FDE
1414 structures that are now freed. Also, getting new symbols may
1415 change our opinion about what is frameless. */
1416 reinit_frame_cache ();
1418 ops->special_symbol_handling ();
1422 show_auto_solib_add (struct ui_file *file, int from_tty,
1423 struct cmd_list_element *c, const char *value)
1425 fprintf_filtered (file, _("Autoloading of shared library symbols is %s.\n"),
1430 /* Handler for library-specific lookup of global symbol NAME in OBJFILE. Call
1431 the library-specific handler if it is installed for the current target. */
1434 solib_global_lookup (const struct objfile *objfile,
1436 const domain_enum domain)
1438 struct target_so_ops *ops = solib_ops (target_gdbarch);
1440 if (ops->lookup_lib_global_symbol != NULL)
1441 return ops->lookup_lib_global_symbol (objfile, name, domain);
1446 extern initialize_file_ftype _initialize_solib; /* -Wmissing-prototypes */
1449 _initialize_solib (void)
1451 solib_data = gdbarch_data_register_pre_init (solib_init);
1453 add_com ("sharedlibrary", class_files, sharedlibrary_command,
1454 _("Load shared object library symbols for files matching REGEXP."));
1455 add_info ("sharedlibrary", info_sharedlibrary_command,
1456 _("Status of loaded shared object libraries."));
1457 add_com ("nosharedlibrary", class_files, no_shared_libraries,
1458 _("Unload all shared object library symbols."));
1460 add_setshow_boolean_cmd ("auto-solib-add", class_support,
1461 &auto_solib_add, _("\
1462 Set autoloading of shared library symbols."), _("\
1463 Show autoloading of shared library symbols."), _("\
1464 If \"on\", symbols from all shared object libraries will be loaded\n\
1465 automatically when the inferior begins execution, when the dynamic linker\n\
1466 informs gdb that a new library has been loaded, or when attaching to the\n\
1467 inferior. Otherwise, symbols must be loaded manually, using `sharedlibrary'."),
1469 show_auto_solib_add,
1470 &setlist, &showlist);
1472 add_setshow_filename_cmd ("sysroot", class_support,
1474 Set an alternate system root."), _("\
1475 Show the current system root."), _("\
1476 The system root is used to load absolute shared library symbol files.\n\
1477 For other (relative) files, you can add directories using\n\
1478 `set solib-search-path'."),
1479 reload_shared_libraries,
1481 &setlist, &showlist);
1483 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1485 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1488 add_setshow_optional_filename_cmd ("solib-search-path", class_support,
1489 &solib_search_path, _("\
1490 Set the search path for loading non-absolute shared library symbol files."), _("\
1491 Show the search path for loading non-absolute shared library symbol files."), _("\
1492 This takes precedence over the environment variables PATH and LD_LIBRARY_PATH."),
1493 reload_shared_libraries,
1494 show_solib_search_path,
1495 &setlist, &showlist);