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);
286 xfree (temp_pathname);
288 /* If the search in gdb_sysroot still failed, try fully
289 stripping the drive spec, and trying once more in the
290 sysroot before giving up.
292 c:/foo/bar.dll ==> /sysroot/foo/bar.dll. */
294 temp_pathname = concat (sysroot,
295 need_dir_separator ? SLASH_STRING : "",
296 in_pathname + 2, (char *) NULL);
298 found_file = open (temp_pathname, O_RDONLY | O_BINARY, 0);
300 xfree (temp_pathname);
304 do_cleanups (old_chain);
306 /* We try to find the library in various ways. After each attempt,
307 either found_file >= 0 and temp_pathname is a malloc'd string, or
308 found_file < 0 and temp_pathname does not point to storage that
309 needs to be freed. */
312 temp_pathname = NULL;
314 /* If not found, search the solib_search_path (if any). */
315 if (found_file < 0 && solib_search_path != NULL)
316 found_file = openp (solib_search_path, OPF_TRY_CWD_FIRST,
317 in_pathname, O_RDONLY | O_BINARY, &temp_pathname);
319 /* If the search in gdb_sysroot failed, and the path name is
320 absolute at this point, make it relative. (openp will try and open the
321 file according to its absolute path otherwise, which is not what we want.)
322 Affects subsequent searches for this solib. */
323 if (found_file < 0 && IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname))
325 /* First, get rid of any drive letters etc. */
326 while (!IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
329 /* Next, get rid of all leading dir separators. */
330 while (IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
334 /* If not found, search the solib_search_path (if any). */
335 if (found_file < 0 && solib_search_path != NULL)
336 found_file = openp (solib_search_path, OPF_TRY_CWD_FIRST,
337 in_pathname, O_RDONLY | O_BINARY, &temp_pathname);
339 /* If not found, next search the solib_search_path (if any) for the basename
340 only (ignoring the path). This is to allow reading solibs from a path
341 that differs from the opened path. */
342 if (found_file < 0 && solib_search_path != NULL)
343 found_file = openp (solib_search_path, OPF_TRY_CWD_FIRST,
344 target_lbasename (fskind, in_pathname),
345 O_RDONLY | O_BINARY, &temp_pathname);
347 /* If not found, try to use target supplied solib search method */
348 if (found_file < 0 && ops->find_and_open_solib)
349 found_file = ops->find_and_open_solib (in_pathname, O_RDONLY | O_BINARY,
352 /* If not found, next search the inferior's $PATH environment variable. */
353 if (found_file < 0 && gdb_sysroot_is_empty)
354 found_file = openp (get_in_environ (current_inferior ()->environment,
356 OPF_TRY_CWD_FIRST, in_pathname, O_RDONLY | O_BINARY,
359 /* If not found, next search the inferior's $LD_LIBRARY_PATH
360 environment variable. */
361 if (found_file < 0 && gdb_sysroot_is_empty)
362 found_file = openp (get_in_environ (current_inferior ()->environment,
364 OPF_TRY_CWD_FIRST, in_pathname, O_RDONLY | O_BINARY,
368 return temp_pathname;
371 /* Open and return a BFD for the shared library PATHNAME. If FD is not -1,
372 it is used as file handle to open the file. Throws an error if the file
373 could not be opened. Handles both local and remote file access.
375 PATHNAME must be malloc'ed by the caller. If successful, the new BFD's
376 name will point to it. If unsuccessful, PATHNAME will be freed and the
377 FD will be closed (unless FD was -1). */
380 solib_bfd_fopen (char *pathname, int fd)
384 if (remote_filename_p (pathname))
386 gdb_assert (fd == -1);
387 abfd = remote_bfd_open (pathname, gnutarget);
391 abfd = bfd_fopen (pathname, gnutarget, FOPEN_RB, fd);
394 bfd_set_cacheable (abfd, 1);
401 make_cleanup (xfree, pathname);
402 error (_("Could not open `%s' as an executable file: %s"),
403 pathname, bfd_errmsg (bfd_get_error ()));
409 /* Find shared library PATHNAME and open a BFD for it. */
412 solib_bfd_open (char *pathname)
414 char *found_pathname;
417 const struct bfd_arch_info *b;
419 /* Search for shared library file. */
420 found_pathname = solib_find (pathname, &found_file);
421 if (found_pathname == NULL)
423 /* Return failure if the file could not be found, so that we can
424 accumulate messages about missing libraries. */
428 perror_with_name (pathname);
431 /* Open bfd for shared library. */
432 abfd = solib_bfd_fopen (found_pathname, found_file);
434 /* Check bfd format. */
435 if (!bfd_check_format (abfd, bfd_object))
438 make_cleanup (xfree, found_pathname);
439 error (_("`%s': not in executable format: %s"),
440 found_pathname, bfd_errmsg (bfd_get_error ()));
443 /* Check bfd arch. */
444 b = gdbarch_bfd_arch_info (target_gdbarch);
445 if (!b->compatible (b, bfd_get_arch_info (abfd)))
446 warning (_("`%s': Shared library architecture %s is not compatible "
447 "with target architecture %s."), found_pathname,
448 bfd_get_arch_info (abfd)->printable_name, b->printable_name);
458 solib_map_sections -- open bfd and build sections for shared lib
462 static int solib_map_sections (struct so_list *so)
466 Given a pointer to one of the shared objects in our list
467 of mapped objects, use the recorded name to open a bfd
468 descriptor for the object, build a section table, and then
469 relocate all the section addresses by the base address at
470 which the shared object was mapped.
474 In most (all?) cases the shared object file name recorded in the
475 dynamic linkage tables will be a fully qualified pathname. For
476 cases where it isn't, do we really mimic the systems search
477 mechanism correctly in the below code (particularly the tilde
482 solib_map_sections (struct so_list *so)
484 struct target_so_ops *ops = solib_ops (target_gdbarch);
486 struct target_section *p;
487 struct cleanup *old_chain;
490 filename = tilde_expand (so->so_name);
491 old_chain = make_cleanup (xfree, filename);
492 abfd = ops->bfd_open (filename);
493 do_cleanups (old_chain);
498 /* Leave bfd open, core_xfer_memory and "info files" need it. */
499 so->abfd = gdb_bfd_ref (abfd);
501 /* copy full path name into so_name, so that later symbol_file_add
503 if (strlen (bfd_get_filename (abfd)) >= SO_NAME_MAX_PATH_SIZE)
504 error (_("Shared library file name is too long."));
505 strcpy (so->so_name, bfd_get_filename (abfd));
507 if (build_section_table (abfd, &so->sections, &so->sections_end))
509 error (_("Can't find the file sections in `%s': %s"),
510 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
513 for (p = so->sections; p < so->sections_end; p++)
515 /* Relocate the section binding addresses as recorded in the shared
516 object's file by the base address to which the object was actually
518 ops->relocate_section_addresses (so, p);
520 /* If the target didn't provide information about the address
521 range of the shared object, assume we want the location of
522 the .text section. */
523 if (so->addr_low == 0 && so->addr_high == 0
524 && strcmp (p->the_bfd_section->name, ".text") == 0)
526 so->addr_low = p->addr;
527 so->addr_high = p->endaddr;
531 /* Add the shared object's sections to the current set of file
532 section tables. Do this immediately after mapping the object so
533 that later nodes in the list can query this object, as is needed
535 add_target_sections (so->sections, so->sections_end);
540 /* Free symbol-file related contents of SO. If we have opened a BFD
541 for SO, close it. If we have placed SO's sections in some target's
542 section table, the caller is responsible for removing them.
544 This function doesn't mess with objfiles at all. If there is an
545 objfile associated with SO that needs to be removed, the caller is
546 responsible for taking care of that. */
549 free_so_symbols (struct so_list *so)
551 char *bfd_filename = 0;
555 xfree (so->sections);
556 so->sections = so->sections_end = NULL;
559 gdb_bfd_unref (so->abfd);
562 /* Our caller closed the objfile, possibly via objfile_purge_solibs. */
563 so->symbols_loaded = 0;
566 so->addr_low = so->addr_high = 0;
568 /* Restore the target-supplied file name. SO_NAME may be the path
569 of the symbol file. */
570 strcpy (so->so_name, so->so_original_name);
575 free_so --- free a `struct so_list' object
579 void free_so (struct so_list *so)
583 Free the storage associated with the `struct so_list' object SO.
584 If we have opened a BFD for SO, close it.
586 The caller is responsible for removing SO from whatever list it is
587 a member of. If we have placed SO's sections in some target's
588 section table, the caller is responsible for removing them.
590 This function doesn't mess with objfiles at all. If there is an
591 objfile associated with SO that needs to be removed, the caller is
592 responsible for taking care of that. */
595 free_so (struct so_list *so)
597 struct target_so_ops *ops = solib_ops (target_gdbarch);
599 free_so_symbols (so);
606 /* Return address of first so_list entry in master shared object list. */
608 master_so_list (void)
613 /* Read in symbols for shared object SO. If SYMFILE_VERBOSE is set in FLAGS,
614 be chatty about it. Return non-zero if any symbols were actually
618 solib_read_symbols (struct so_list *so, int flags)
620 const int from_tty = flags & SYMFILE_VERBOSE;
622 if (so->symbols_loaded)
624 /* If needed, we've already warned in our caller. */
626 else if (so->abfd == NULL)
628 /* We've already warned about this library, when trying to open
633 volatile struct gdb_exception e;
635 TRY_CATCH (e, RETURN_MASK_ERROR)
637 struct section_addr_info *sap;
639 /* Have we already loaded this shared object? */
640 ALL_OBJFILES (so->objfile)
642 if (strcmp (so->objfile->name, so->so_name) == 0)
645 if (so->objfile != NULL)
648 sap = build_section_addr_info_from_section_table (so->sections,
650 so->objfile = symbol_file_add_from_bfd (so->abfd,
651 flags, sap, OBJF_SHARED);
652 free_section_addr_info (sap);
660 _("Error while reading shared library symbols:\n"));
664 if (from_tty || info_verbose)
665 printf_unfiltered (_("Loaded symbols for %s\n"), so->so_name);
666 so->symbols_loaded = 1;
676 update_solib_list --- synchronize GDB's shared object list with inferior's
680 void update_solib_list (int from_tty, struct target_ops *TARGET)
682 Extract the list of currently loaded shared objects from the
683 inferior, and compare it with the list of shared objects currently
684 in GDB's so_list_head list. Edit so_list_head to bring it in sync
685 with the inferior's new list.
687 If we notice that the inferior has unloaded some shared objects,
688 free any symbolic info GDB had read about those shared objects.
690 Don't load symbolic info for any new shared objects; just add them
691 to the list, and leave their symbols_loaded flag clear.
693 If FROM_TTY is non-null, feel free to print messages about what
696 If TARGET is non-null, add the sections of all new shared objects
697 to TARGET's section table. Note that this doesn't remove any
698 sections for shared objects that have been unloaded, and it
699 doesn't check to see if the new shared objects are already present in
700 the section table. But we only use this for core files and
701 processes we've just attached to, so that's okay. */
704 update_solib_list (int from_tty, struct target_ops *target)
706 struct target_so_ops *ops = solib_ops (target_gdbarch);
707 struct so_list *inferior = ops->current_sos();
708 struct so_list *gdb, **gdb_link;
710 /* We can reach here due to changing solib-search-path or the
711 sysroot, before having any inferior. */
712 if (target_has_execution && !ptid_equal (inferior_ptid, null_ptid))
714 struct inferior *inf = current_inferior ();
716 /* If we are attaching to a running process for which we
717 have not opened a symbol file, we may be able to get its
719 if (inf->attach_flag && symfile_objfile == NULL)
720 catch_errors (ops->open_symbol_file_object, &from_tty,
721 "Error reading attached process's symbol file.\n",
725 /* GDB and the inferior's dynamic linker each maintain their own
726 list of currently loaded shared objects; we want to bring the
727 former in sync with the latter. Scan both lists, seeing which
728 shared objects appear where. There are three cases:
730 - A shared object appears on both lists. This means that GDB
731 knows about it already, and it's still loaded in the inferior.
732 Nothing needs to happen.
734 - A shared object appears only on GDB's list. This means that
735 the inferior has unloaded it. We should remove the shared
736 object from GDB's tables.
738 - A shared object appears only on the inferior's list. This
739 means that it's just been loaded. We should add it to GDB's
742 So we walk GDB's list, checking each entry to see if it appears
743 in the inferior's list too. If it does, no action is needed, and
744 we remove it from the inferior's list. If it doesn't, the
745 inferior has unloaded it, and we remove it from GDB's list. By
746 the time we're done walking GDB's list, the inferior's list
747 contains only the new shared objects, which we then add. */
750 gdb_link = &so_list_head;
753 struct so_list *i = inferior;
754 struct so_list **i_link = &inferior;
756 /* Check to see whether the shared object *gdb also appears in
757 the inferior's current list. */
762 if (ops->same (gdb, i))
767 if (! strcmp (gdb->so_original_name, i->so_original_name))
775 /* If the shared object appears on the inferior's list too, then
776 it's still loaded, so we don't need to do anything. Delete
777 it from the inferior's list, and leave it on GDB's list. */
782 gdb_link = &gdb->next;
786 /* If it's not on the inferior's list, remove it from GDB's tables. */
789 /* Notify any observer that the shared object has been
790 unloaded before we remove it from GDB's tables. */
791 observer_notify_solib_unloaded (gdb);
793 *gdb_link = gdb->next;
795 /* Unless the user loaded it explicitly, free SO's objfile. */
796 if (gdb->objfile && ! (gdb->objfile->flags & OBJF_USERLOADED))
797 free_objfile (gdb->objfile);
799 /* Some targets' section tables might be referring to
800 sections from so->abfd; remove them. */
801 remove_target_sections (gdb->abfd);
808 /* Now the inferior's list contains only shared objects that don't
809 appear in GDB's list --- those that are newly loaded. Add them
810 to GDB's shared object list. */
814 const char *not_found_filename = NULL;
818 /* Add the new shared objects to GDB's list. */
819 *gdb_link = inferior;
821 /* Fill in the rest of each of the `struct so_list' nodes. */
822 for (i = inferior; i; i = i->next)
824 volatile struct gdb_exception e;
826 i->pspace = current_program_space;
828 TRY_CATCH (e, RETURN_MASK_ERROR)
830 /* Fill in the rest of the `struct so_list' node. */
831 if (!solib_map_sections (i))
834 if (not_found_filename == NULL)
835 not_found_filename = i->so_original_name;
840 exception_fprintf (gdb_stderr, e, _("\
841 Error while mapping shared library sections:\n"));
843 /* Notify any observer that the shared object has been
844 loaded now that we've added it to GDB's tables. */
845 observer_notify_solib_loaded (i);
848 /* If a library was not found, issue an appropriate warning
849 message. We have to use a single call to warning in case the
850 front end does something special with warnings, e.g., pop up
851 a dialog box. It Would Be Nice if we could get a "warning: "
852 prefix on each line in the CLI front end, though - it doesn't
857 Could not load shared library symbols for %s.\n\
858 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
860 else if (not_found > 1)
862 Could not load shared library symbols for %d libraries, e.g. %s.\n\
863 Use the \"info sharedlibrary\" command to see the complete listing.\n\
864 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
865 not_found, not_found_filename);
870 /* Return non-zero if NAME is the libpthread shared library.
872 Uses a fairly simplistic heuristic approach where we check
873 the file name against "/libpthread". This can lead to false
874 positives, but this should be good enough in practice. */
877 libpthread_name_p (const char *name)
879 return (strstr (name, "/libpthread") != NULL);
882 /* Return non-zero if SO is the libpthread shared library. */
885 libpthread_solib_p (struct so_list *so)
887 return libpthread_name_p (so->so_name);
892 solib_add -- read in symbol info for newly added shared libraries
896 void solib_add (char *pattern, int from_tty, struct target_ops
897 *TARGET, int readsyms)
901 Read in symbolic information for any shared objects whose names
902 match PATTERN. (If we've already read a shared object's symbol
903 info, leave it alone.) If PATTERN is zero, read them all.
905 If READSYMS is 0, defer reading symbolic information until later
906 but still do any needed low level processing.
908 FROM_TTY and TARGET are as described for update_solib_list, above. */
911 solib_add (char *pattern, int from_tty, struct target_ops *target, int readsyms)
917 char *re_err = re_comp (pattern);
920 error (_("Invalid regexp: %s"), re_err);
923 update_solib_list (from_tty, target);
925 /* Walk the list of currently loaded shared libraries, and read
926 symbols for any that match the pattern --- or any whose symbols
927 aren't already loaded, if no pattern was given. */
930 int loaded_any_symbols = 0;
932 SYMFILE_DEFER_BP_RESET | (from_tty ? SYMFILE_VERBOSE : 0);
934 for (gdb = so_list_head; gdb; gdb = gdb->next)
935 if (! pattern || re_exec (gdb->so_name))
937 /* Normally, we would read the symbols from that library
938 only if READSYMS is set. However, we're making a small
939 exception for the pthread library, because we sometimes
940 need the library symbols to be loaded in order to provide
941 thread support (x86-linux for instance). */
942 const int add_this_solib =
943 (readsyms || libpthread_solib_p (gdb));
948 if (gdb->symbols_loaded)
950 /* If no pattern was given, be quiet for shared
951 libraries we have already loaded. */
952 if (pattern && (from_tty || info_verbose))
953 printf_unfiltered (_("Symbols already loaded for %s\n"),
956 else if (solib_read_symbols (gdb, flags))
957 loaded_any_symbols = 1;
961 if (loaded_any_symbols)
962 breakpoint_re_set ();
964 if (from_tty && pattern && ! any_matches)
966 ("No loaded shared libraries match the pattern `%s'.\n", pattern);
968 if (loaded_any_symbols)
970 struct target_so_ops *ops = solib_ops (target_gdbarch);
972 /* Getting new symbols may change our opinion about what is
974 reinit_frame_cache ();
976 ops->special_symbol_handling ();
986 info_sharedlibrary_command -- code for "info sharedlibrary"
990 static void info_sharedlibrary_command ()
994 Walk through the shared library list and print information
995 about each attached library matching PATTERN. If PATTERN is elided,
1000 info_sharedlibrary_command (char *pattern, int from_tty)
1002 struct so_list *so = NULL; /* link map state variable */
1003 int header_done = 0;
1004 int so_missing_debug_info = 0;
1007 struct cleanup *table_cleanup;
1008 struct gdbarch *gdbarch = target_gdbarch;
1012 char *re_err = re_comp (pattern);
1015 error (_("Invalid regexp: %s"), re_err);
1018 /* "0x", a little whitespace, and two hex digits per byte of pointers. */
1019 addr_width = 4 + (gdbarch_ptr_bit (gdbarch) / 4);
1021 update_solib_list (from_tty, 0);
1023 /* make_cleanup_ui_out_table_begin_end needs to know the number of
1024 rows, so we need to make two passes over the libs. */
1026 for (nr_libs = 0, so = so_list_head; so; so = so->next)
1030 if (pattern && ! re_exec (so->so_name))
1037 make_cleanup_ui_out_table_begin_end (uiout, 4, nr_libs,
1038 "SharedLibraryTable");
1040 /* The "- 1" is because ui_out adds one space between columns. */
1041 ui_out_table_header (uiout, addr_width - 1, ui_left, "from", "From");
1042 ui_out_table_header (uiout, addr_width - 1, ui_left, "to", "To");
1043 ui_out_table_header (uiout, 12 - 1, ui_left, "syms-read", "Syms Read");
1044 ui_out_table_header (uiout, 0, ui_noalign,
1045 "name", "Shared Object Library");
1047 ui_out_table_body (uiout);
1049 for (so = so_list_head; so; so = so->next)
1051 struct cleanup *lib_cleanup;
1053 if (! so->so_name[0])
1055 if (pattern && ! re_exec (so->so_name))
1058 lib_cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, "lib");
1060 if (so->addr_high != 0)
1062 ui_out_field_core_addr (uiout, "from", gdbarch, so->addr_low);
1063 ui_out_field_core_addr (uiout, "to", gdbarch, so->addr_high);
1067 ui_out_field_skip (uiout, "from");
1068 ui_out_field_skip (uiout, "to");
1071 if (! ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ()))
1072 && so->symbols_loaded
1073 && !objfile_has_symbols (so->objfile))
1075 so_missing_debug_info = 1;
1076 ui_out_field_string (uiout, "syms-read", "Yes (*)");
1079 ui_out_field_string (uiout, "syms-read",
1080 so->symbols_loaded ? "Yes" : "No");
1082 ui_out_field_string (uiout, "name", so->so_name);
1084 ui_out_text (uiout, "\n");
1086 do_cleanups (lib_cleanup);
1089 do_cleanups (table_cleanup);
1094 ui_out_message (uiout, 0,
1095 _("No shared libraries matched.\n"));
1097 ui_out_message (uiout, 0,
1098 _("No shared libraries loaded at this time.\n"));
1102 if (so_missing_debug_info)
1103 ui_out_message (uiout, 0,
1104 _("(*): Shared library is missing debugging information.\n"));
1108 /* Return 1 if ADDRESS lies within SOLIB. */
1111 solib_contains_address_p (const struct so_list *const solib,
1114 struct target_section *p;
1116 for (p = solib->sections; p < solib->sections_end; p++)
1117 if (p->addr <= address && address < p->endaddr)
1127 solib_name_from_address -- if an address is in a shared lib, return
1132 char * solib_name_from_address (CORE_ADDR address)
1136 Provides a hook for other gdb routines to discover whether or
1137 not a particular address is within the mapped address space of
1140 For example, this routine is called at one point to disable
1141 breakpoints which are in shared libraries that are not currently
1146 solib_name_from_address (struct program_space *pspace, CORE_ADDR address)
1148 struct so_list *so = NULL;
1150 for (so = pspace->so_list; so; so = so->next)
1151 if (solib_contains_address_p (so, address))
1152 return (so->so_name);
1157 /* Return whether the data starting at VADDR, size SIZE, must be kept
1158 in a core file for shared libraries loaded before "gcore" is used
1159 to be handled correctly when the core file is loaded. This only
1160 applies when the section would otherwise not be kept in the core
1161 file (in particular, for readonly sections). */
1164 solib_keep_data_in_core (CORE_ADDR vaddr, unsigned long size)
1166 struct target_so_ops *ops = solib_ops (target_gdbarch);
1168 if (ops->keep_data_in_core)
1169 return ops->keep_data_in_core (vaddr, size);
1174 /* Called by free_all_symtabs */
1179 struct target_so_ops *ops = solib_ops (target_gdbarch);
1181 /* This function is expected to handle ELF shared libraries. It is
1182 also used on Solaris, which can run either ELF or a.out binaries
1183 (for compatibility with SunOS 4), both of which can use shared
1184 libraries. So we don't know whether we have an ELF executable or
1185 an a.out executable until the user chooses an executable file.
1187 ELF shared libraries don't get mapped into the address space
1188 until after the program starts, so we'd better not try to insert
1189 breakpoints in them immediately. We have to wait until the
1190 dynamic linker has loaded them; we'll hit a bp_shlib_event
1191 breakpoint (look for calls to create_solib_event_breakpoint) when
1194 SunOS shared libraries seem to be different --- they're present
1195 as soon as the process begins execution, so there's no need to
1196 put off inserting breakpoints. There's also nowhere to put a
1197 bp_shlib_event breakpoint, so if we put it off, we'll never get
1200 So: disable breakpoints only if we're using ELF shared libs. */
1201 if (exec_bfd != NULL
1202 && bfd_get_flavour (exec_bfd) != bfd_target_aout_flavour)
1203 disable_breakpoints_in_shlibs ();
1205 while (so_list_head)
1207 struct so_list *so = so_list_head;
1208 so_list_head = so->next;
1209 observer_notify_solib_unloaded (so);
1211 remove_target_sections (so->abfd);
1215 ops->clear_solib ();
1220 solib_create_inferior_hook -- shared library startup support
1224 void solib_create_inferior_hook (int from_tty)
1228 When gdb starts up the inferior, it nurses it along (through the
1229 shell) until it is ready to execute it's first instruction. At this
1230 point, this function gets called via expansion of the macro
1231 SOLIB_CREATE_INFERIOR_HOOK. */
1234 solib_create_inferior_hook (int from_tty)
1236 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);
1260 return ops->in_dynsym_resolve_code (pc);
1267 sharedlibrary_command -- handle command to explicitly add library
1271 static void sharedlibrary_command (char *args, int from_tty)
1278 sharedlibrary_command (char *args, int from_tty)
1281 solib_add (args, from_tty, (struct target_ops *) 0, 1);
1286 no_shared_libraries -- handle command to explicitly discard symbols
1287 from shared libraries.
1291 Implements the command "nosharedlibrary", which discards symbols
1292 that have been auto-loaded from shared libraries. Symbols from
1293 shared libraries that were added by explicit request of the user
1294 are not discarded. Also called from remote.c. */
1297 no_shared_libraries (char *ignored, int from_tty)
1299 /* The order of the two routines below is important: clear_solib notifies
1300 the solib_unloaded observers, and some of these observers might need
1301 access to their associated objfiles. Therefore, we can not purge the
1302 solibs' objfiles before clear_solib has been called. */
1305 objfile_purge_solibs ();
1308 /* Reload shared libraries, but avoid reloading the same symbol file
1309 we already have loaded. */
1312 reload_shared_libraries_1 (int from_tty)
1315 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
1317 for (so = so_list_head; so != NULL; so = so->next)
1319 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 shared library sections:\n"));
1361 else if (auto_solib_add || was_loaded || libpthread_solib_p (so))
1362 solib_read_symbols (so, flags);
1366 do_cleanups (old_chain);
1370 reload_shared_libraries (char *ignored, int from_tty,
1371 struct cmd_list_element *e)
1373 struct target_so_ops *ops;
1375 reload_shared_libraries_1 (from_tty);
1377 ops = solib_ops (target_gdbarch);
1379 /* Creating inferior hooks here has two purposes. First, if we reload
1380 shared libraries then the address of solib breakpoint we've computed
1381 previously might be no longer valid. For example, if we forgot to set
1382 solib-absolute-prefix and are setting it right now, then the previous
1383 breakpoint address is plain wrong. Second, installing solib hooks
1384 also implicitly figures were ld.so is and loads symbols for it.
1385 Absent this call, if we've just connected to a target and set
1386 solib-absolute-prefix or solib-search-path, we'll lose all information
1388 if (target_has_execution)
1390 /* Reset or free private data structures not associated with
1392 ops->clear_solib ();
1394 /* Remove any previous solib event breakpoint. This is usually
1395 done in common code, at breakpoint_init_inferior time, but
1396 we're not really starting up the inferior here. */
1397 remove_solib_event_breakpoints ();
1399 #ifdef SOLIB_CREATE_INFERIOR_HOOK
1400 SOLIB_CREATE_INFERIOR_HOOK (PIDGET (inferior_ptid));
1402 solib_create_inferior_hook (from_tty);
1406 /* Sometimes the platform-specific hook loads initial shared
1407 libraries, and sometimes it doesn't. If it doesn't FROM_TTY will be
1408 incorrectly 0 but such solib targets should be fixed anyway. If we
1409 made all the inferior hook methods consistent, this call could be
1410 removed. Call it only after the solib target has been initialized by
1411 solib_create_inferior_hook. */
1413 solib_add (NULL, 0, NULL, auto_solib_add);
1415 breakpoint_re_set ();
1417 /* We may have loaded or unloaded debug info for some (or all)
1418 shared libraries. However, frames may still reference them. For
1419 example, a frame's unwinder might still point at DWARF FDE
1420 structures that are now freed. Also, getting new symbols may
1421 change our opinion about what is frameless. */
1422 reinit_frame_cache ();
1424 ops->special_symbol_handling ();
1428 show_auto_solib_add (struct ui_file *file, int from_tty,
1429 struct cmd_list_element *c, const char *value)
1431 fprintf_filtered (file, _("Autoloading of shared library symbols is %s.\n"),
1436 /* Handler for library-specific lookup of global symbol NAME in OBJFILE. Call
1437 the library-specific handler if it is installed for the current target. */
1440 solib_global_lookup (const struct objfile *objfile,
1442 const domain_enum domain)
1444 struct target_so_ops *ops = solib_ops (target_gdbarch);
1446 if (ops->lookup_lib_global_symbol != NULL)
1447 return ops->lookup_lib_global_symbol (objfile, name, domain);
1452 extern initialize_file_ftype _initialize_solib; /* -Wmissing-prototypes */
1455 _initialize_solib (void)
1457 struct cmd_list_element *c;
1459 solib_data = gdbarch_data_register_pre_init (solib_init);
1461 add_com ("sharedlibrary", class_files, sharedlibrary_command,
1462 _("Load shared object library symbols for files matching REGEXP."));
1463 add_info ("sharedlibrary", info_sharedlibrary_command,
1464 _("Status of loaded shared object libraries."));
1465 add_com ("nosharedlibrary", class_files, no_shared_libraries,
1466 _("Unload all shared object library symbols."));
1468 add_setshow_boolean_cmd ("auto-solib-add", class_support,
1469 &auto_solib_add, _("\
1470 Set autoloading of shared library symbols."), _("\
1471 Show autoloading of shared library symbols."), _("\
1472 If \"on\", symbols from all shared object libraries will be loaded\n\
1473 automatically when the inferior begins execution, when the dynamic linker\n\
1474 informs gdb that a new library has been loaded, or when attaching to the\n\
1475 inferior. Otherwise, symbols must be loaded manually, using `sharedlibrary'."),
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."), _("\
1499 Show the search path for loading non-absolute shared library symbol files."), _("\
1500 This takes precedence over the environment variables PATH and LD_LIBRARY_PATH."),
1501 reload_shared_libraries,
1502 show_solib_search_path,
1503 &setlist, &showlist);