1 /* Handle shared libraries for GDB, the GNU Debugger.
3 Copyright (C) 1990-2014 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include <sys/types.h>
29 #include "exceptions.h"
34 #include "gdb_regex.h"
39 #include "completer.h"
40 #include "filenames.h" /* for DOSish file names */
44 #include "readline/readline.h"
48 #include "filesystem.h"
50 #include "filestuff.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 const struct target_so_ops *
68 solib_ops (struct gdbarch *gdbarch)
70 const 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, const struct target_so_ops *new_ops)
80 const 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
117 /* Returns the full pathname of the shared library file, or NULL if
118 not found. (The pathname is malloc'ed; it needs to be freed by the
119 caller.) *FD is set to either -1 or an open file handle for the
122 Global variable GDB_SYSROOT is used as a prefix directory
123 to search for shared libraries if they have an absolute path.
125 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
126 (or set of directories, as in LD_LIBRARY_PATH) to search for all
127 shared libraries if not found in GDB_SYSROOT.
130 * If there is a gdb_sysroot and path is absolute:
131 * Search for gdb_sysroot/path.
133 * Look for it literally (unmodified).
134 * Look in SOLIB_SEARCH_PATH.
135 * If available, use target defined search function.
136 * If gdb_sysroot is NOT set, perform the following two searches:
137 * Look in inferior's $PATH.
138 * Look in inferior's $LD_LIBRARY_PATH.
140 * The last check avoids doing this search when targetting remote
141 * machines since gdb_sysroot will almost always be set.
145 solib_find (char *in_pathname, int *fd)
147 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
149 char *temp_pathname = NULL;
150 int gdb_sysroot_is_empty;
151 const char *solib_symbols_extension
152 = gdbarch_solib_symbols_extension (target_gdbarch ());
153 const char *fskind = effective_target_file_system_kind ();
154 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
155 char *sysroot = NULL;
157 /* If solib_symbols_extension is set, replace the file's
159 if (solib_symbols_extension)
161 char *p = in_pathname + strlen (in_pathname);
163 while (p > in_pathname && *p != '.')
170 new_pathname = alloca (p - in_pathname + 1
171 + strlen (solib_symbols_extension) + 1);
172 memcpy (new_pathname, in_pathname, p - in_pathname + 1);
173 strcpy (new_pathname + (p - in_pathname) + 1,
174 solib_symbols_extension);
176 in_pathname = new_pathname;
180 gdb_sysroot_is_empty = (gdb_sysroot == NULL || *gdb_sysroot == 0);
182 if (!gdb_sysroot_is_empty)
184 int prefix_len = strlen (gdb_sysroot);
186 /* Remove trailing slashes from absolute prefix. */
187 while (prefix_len > 0
188 && IS_DIR_SEPARATOR (gdb_sysroot[prefix_len - 1]))
191 sysroot = savestring (gdb_sysroot, prefix_len);
192 make_cleanup (xfree, sysroot);
195 /* If we're on a non-DOS-based system, backslashes won't be
196 understood as directory separator, so, convert them to forward
197 slashes, iff we're supposed to handle DOS-based file system
198 semantics for target paths. */
199 if (!DOS_BASED_FILE_SYSTEM && fskind == file_system_kind_dos_based)
203 /* Avoid clobbering our input. */
204 p = alloca (strlen (in_pathname) + 1);
205 strcpy (p, in_pathname);
215 /* Note, we're interested in IS_TARGET_ABSOLUTE_PATH, not
216 IS_ABSOLUTE_PATH. The latter is for host paths only, while
217 IN_PATHNAME is a target path. For example, if we're supposed to
218 be handling DOS-like semantics we want to consider a
219 'c:/foo/bar.dll' path as an absolute path, even on a Unix box.
220 With such a path, before giving up on the sysroot, we'll try:
222 1st attempt, c:/foo/bar.dll ==> /sysroot/c:/foo/bar.dll
223 2nd attempt, c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll
224 3rd attempt, c:/foo/bar.dll ==> /sysroot/foo/bar.dll
227 if (!IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname) || gdb_sysroot_is_empty)
228 temp_pathname = xstrdup (in_pathname);
231 int need_dir_separator;
233 /* Concatenate the sysroot and the target reported filename. We
234 may need to glue them with a directory separator. Cases to
237 | sysroot | separator | in_pathname |
238 |-----------------+-----------+----------------|
239 | /some/dir | / | c:/foo/bar.dll |
240 | /some/dir | | /foo/bar.dll |
241 | remote: | | c:/foo/bar.dll |
242 | remote: | | /foo/bar.dll |
243 | remote:some/dir | / | c:/foo/bar.dll |
244 | remote:some/dir | | /foo/bar.dll |
246 IOW, we don't need to add a separator if IN_PATHNAME already
247 has one, or when the the sysroot is exactly "remote:".
248 There's no need to check for drive spec explicitly, as we only
249 get here if IN_PATHNAME is considered an absolute path. */
250 need_dir_separator = !(IS_DIR_SEPARATOR (in_pathname[0])
251 || strcmp (REMOTE_SYSROOT_PREFIX, sysroot) == 0);
253 /* Cat the prefixed pathname together. */
254 temp_pathname = concat (sysroot,
255 need_dir_separator ? SLASH_STRING : "",
256 in_pathname, (char *) NULL);
259 /* Handle remote files. */
260 if (remote_filename_p (temp_pathname))
263 do_cleanups (old_chain);
264 return temp_pathname;
267 /* Now see if we can open it. */
268 found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
270 xfree (temp_pathname);
272 /* If the search in gdb_sysroot failed, and the path name has a
273 drive spec (e.g, c:/foo), try stripping ':' from the drive spec,
274 and retrying in the sysroot:
275 c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll. */
278 && !gdb_sysroot_is_empty
279 && HAS_TARGET_DRIVE_SPEC (fskind, in_pathname))
281 int need_dir_separator = !IS_DIR_SEPARATOR (in_pathname[2]);
282 char *drive = savestring (in_pathname, 1);
284 temp_pathname = concat (sysroot,
287 need_dir_separator ? SLASH_STRING : "",
288 in_pathname + 2, (char *) NULL);
291 found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
294 xfree (temp_pathname);
296 /* If the search in gdb_sysroot still failed, try fully
297 stripping the drive spec, and trying once more in the
298 sysroot before giving up.
300 c:/foo/bar.dll ==> /sysroot/foo/bar.dll. */
302 temp_pathname = concat (sysroot,
303 need_dir_separator ? SLASH_STRING : "",
304 in_pathname + 2, (char *) NULL);
306 found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
308 xfree (temp_pathname);
312 do_cleanups (old_chain);
314 /* We try to find the library in various ways. After each attempt,
315 either found_file >= 0 and temp_pathname is a malloc'd string, or
316 found_file < 0 and temp_pathname does not point to storage that
317 needs to be freed. */
320 temp_pathname = NULL;
322 /* If the search in gdb_sysroot failed, and the path name is
323 absolute at this point, make it relative. (openp will try and open the
324 file according to its absolute path otherwise, which is not what we want.)
325 Affects subsequent searches for this solib. */
326 if (found_file < 0 && IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname))
328 /* First, get rid of any drive letters etc. */
329 while (!IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
332 /* Next, get rid of all leading dir separators. */
333 while (IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
337 /* If not found, search the solib_search_path (if any). */
338 if (found_file < 0 && solib_search_path != NULL)
339 found_file = openp (solib_search_path,
340 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
341 in_pathname, O_RDONLY | O_BINARY, &temp_pathname);
343 /* If not found, next search the solib_search_path (if any) for the basename
344 only (ignoring the path). This is to allow reading solibs from a path
345 that differs from the opened path. */
346 if (found_file < 0 && solib_search_path != NULL)
347 found_file = openp (solib_search_path,
348 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
349 target_lbasename (fskind, in_pathname),
350 O_RDONLY | O_BINARY, &temp_pathname);
352 /* If not found, try to use target supplied solib search method. */
353 if (found_file < 0 && ops->find_and_open_solib)
354 found_file = ops->find_and_open_solib (in_pathname, O_RDONLY | O_BINARY,
357 /* If not found, next search the inferior's $PATH environment variable. */
358 if (found_file < 0 && gdb_sysroot_is_empty)
359 found_file = openp (get_in_environ (current_inferior ()->environment,
361 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
362 O_RDONLY | O_BINARY, &temp_pathname);
364 /* If not found, next search the inferior's $LD_LIBRARY_PATH
365 environment variable. */
366 if (found_file < 0 && gdb_sysroot_is_empty)
367 found_file = openp (get_in_environ (current_inferior ()->environment,
369 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
370 O_RDONLY | O_BINARY, &temp_pathname);
373 return temp_pathname;
376 /* Open and return a BFD for the shared library PATHNAME. If FD is not -1,
377 it is used as file handle to open the file. Throws an error if the file
378 could not be opened. Handles both local and remote file access.
380 PATHNAME must be malloc'ed by the caller. It will be freed by this
381 function. If unsuccessful, the FD will be closed (unless FD was
385 solib_bfd_fopen (char *pathname, int fd)
389 if (remote_filename_p (pathname))
391 gdb_assert (fd == -1);
392 abfd = remote_bfd_open (pathname, gnutarget);
396 abfd = gdb_bfd_open (pathname, gnutarget, fd);
399 bfd_set_cacheable (abfd, 1);
404 make_cleanup (xfree, pathname);
405 error (_("Could not open `%s' as an executable file: %s"),
406 pathname, bfd_errmsg (bfd_get_error ()));
414 /* Find shared library PATHNAME and open a BFD for it. */
417 solib_bfd_open (char *pathname)
419 char *found_pathname;
422 const struct bfd_arch_info *b;
424 /* Search for shared library file. */
425 found_pathname = solib_find (pathname, &found_file);
426 if (found_pathname == NULL)
428 /* Return failure if the file could not be found, so that we can
429 accumulate messages about missing libraries. */
433 perror_with_name (pathname);
436 /* Open bfd for shared library. */
437 abfd = solib_bfd_fopen (found_pathname, found_file);
439 /* Check bfd format. */
440 if (!bfd_check_format (abfd, bfd_object))
442 make_cleanup_bfd_unref (abfd);
443 error (_("`%s': not in executable format: %s"),
444 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
447 /* Check bfd arch. */
448 b = gdbarch_bfd_arch_info (target_gdbarch ());
449 if (!b->compatible (b, bfd_get_arch_info (abfd)))
450 warning (_("`%s': Shared library architecture %s is not compatible "
451 "with target architecture %s."), bfd_get_filename (abfd),
452 bfd_get_arch_info (abfd)->printable_name, b->printable_name);
457 /* Given a pointer to one of the shared objects in our list of mapped
458 objects, use the recorded name to open a bfd descriptor for the
459 object, build a section table, relocate all the section addresses
460 by the base address at which the shared object was mapped, and then
461 add the sections to the target's section table.
463 FIXME: In most (all?) cases the shared object file name recorded in
464 the dynamic linkage tables will be a fully qualified pathname. For
465 cases where it isn't, do we really mimic the systems search
466 mechanism correctly in the below code (particularly the tilde
467 expansion stuff?). */
470 solib_map_sections (struct so_list *so)
472 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
474 struct target_section *p;
475 struct cleanup *old_chain;
478 filename = tilde_expand (so->so_name);
479 old_chain = make_cleanup (xfree, filename);
480 abfd = ops->bfd_open (filename);
481 do_cleanups (old_chain);
486 /* Leave bfd open, core_xfer_memory and "info files" need it. */
489 /* Copy the full path name into so_name, allowing symbol_file_add
490 to find it later. This also affects the =library-loaded GDB/MI
491 event, and in particular the part of that notification providing
492 the library's host-side path. If we let the target dictate
493 that objfile's path, and the target is different from the host,
494 GDB/MI will not provide the correct host-side path. */
495 if (strlen (bfd_get_filename (abfd)) >= SO_NAME_MAX_PATH_SIZE)
496 error (_("Shared library file name is too long."));
497 strcpy (so->so_name, bfd_get_filename (abfd));
499 if (build_section_table (abfd, &so->sections, &so->sections_end))
501 error (_("Can't find the file sections in `%s': %s"),
502 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
505 for (p = so->sections; p < so->sections_end; p++)
507 /* Relocate the section binding addresses as recorded in the shared
508 object's file by the base address to which the object was actually
510 ops->relocate_section_addresses (so, p);
512 /* If the target didn't provide information about the address
513 range of the shared object, assume we want the location of
514 the .text section. */
515 if (so->addr_low == 0 && so->addr_high == 0
516 && strcmp (p->the_bfd_section->name, ".text") == 0)
518 so->addr_low = p->addr;
519 so->addr_high = p->endaddr;
523 /* Add the shared object's sections to the current set of file
524 section tables. Do this immediately after mapping the object so
525 that later nodes in the list can query this object, as is needed
527 add_target_sections (so, so->sections, so->sections_end);
532 /* Free symbol-file related contents of SO and reset for possible reloading
533 of SO. If we have opened a BFD for SO, close it. If we have placed SO's
534 sections in some target's section table, the caller is responsible for
537 This function doesn't mess with objfiles at all. If there is an
538 objfile associated with SO that needs to be removed, the caller is
539 responsible for taking care of that. */
542 clear_so (struct so_list *so)
544 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
548 xfree (so->sections);
549 so->sections = so->sections_end = NULL;
552 gdb_bfd_unref (so->abfd);
555 /* Our caller closed the objfile, possibly via objfile_purge_solibs. */
556 so->symbols_loaded = 0;
559 so->addr_low = so->addr_high = 0;
561 /* Restore the target-supplied file name. SO_NAME may be the path
562 of the symbol file. */
563 strcpy (so->so_name, so->so_original_name);
565 /* Do the same for target-specific data. */
566 if (ops->clear_so != NULL)
570 /* Free the storage associated with the `struct so_list' object SO.
571 If we have opened a BFD for SO, close it.
573 The caller is responsible for removing SO from whatever list it is
574 a member of. If we have placed SO's sections in some target's
575 section table, the caller is responsible for removing them.
577 This function doesn't mess with objfiles at all. If there is an
578 objfile associated with SO that needs to be removed, the caller is
579 responsible for taking care of that. */
582 free_so (struct so_list *so)
584 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
593 /* Return address of first so_list entry in master shared object list. */
595 master_so_list (void)
600 /* Read in symbols for shared object SO. If SYMFILE_VERBOSE is set in FLAGS,
601 be chatty about it. Return non-zero if any symbols were actually
605 solib_read_symbols (struct so_list *so, int flags)
607 const int from_tty = flags & SYMFILE_VERBOSE;
609 if (so->symbols_loaded)
611 /* If needed, we've already warned in our caller. */
613 else if (so->abfd == NULL)
615 /* We've already warned about this library, when trying to open
620 volatile struct gdb_exception e;
622 flags |= current_inferior ()->symfile_flags;
624 TRY_CATCH (e, RETURN_MASK_ERROR)
626 struct section_addr_info *sap;
628 /* Have we already loaded this shared object? */
629 ALL_OBJFILES (so->objfile)
631 if (filename_cmp (objfile_name (so->objfile), so->so_name) == 0
632 && so->objfile->addr_low == so->addr_low)
635 if (so->objfile != NULL)
638 sap = build_section_addr_info_from_section_table (so->sections,
640 so->objfile = symbol_file_add_from_bfd (so->abfd, so->so_name,
641 flags, sap, OBJF_SHARED,
643 so->objfile->addr_low = so->addr_low;
644 free_section_addr_info (sap);
648 exception_fprintf (gdb_stderr, e, _("Error while reading shared"
649 " library symbols for %s:\n"),
653 if (print_symbol_loading_p (from_tty, 0, 1))
654 printf_unfiltered (_("Loaded symbols for %s\n"), so->so_name);
655 so->symbols_loaded = 1;
663 /* Return 1 if KNOWN->objfile is used by any other so_list object in the
664 SO_LIST_HEAD list. Return 0 otherwise. */
667 solib_used (const struct so_list *const known)
669 const struct so_list *pivot;
671 for (pivot = so_list_head; pivot != NULL; pivot = pivot->next)
672 if (pivot != known && pivot->objfile == known->objfile)
677 /* Synchronize GDB's shared object list with inferior's.
679 Extract the list of currently loaded shared objects from the
680 inferior, and compare it with the list of shared objects currently
681 in GDB's so_list_head list. Edit so_list_head to bring it in sync
682 with the inferior's new list.
684 If we notice that the inferior has unloaded some shared objects,
685 free any symbolic info GDB had read about those shared objects.
687 Don't load symbolic info for any new shared objects; just add them
688 to the list, and leave their symbols_loaded flag clear.
690 If FROM_TTY is non-null, feel free to print messages about what
693 If TARGET is non-null, add the sections of all new shared objects
694 to TARGET's section table. Note that this doesn't remove any
695 sections for shared objects that have been unloaded, and it
696 doesn't check to see if the new shared objects are already present in
697 the section table. But we only use this for core files and
698 processes we've just attached to, so that's okay. */
701 update_solib_list (int from_tty, struct target_ops *target)
703 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
704 struct so_list *inferior = ops->current_sos();
705 struct so_list *gdb, **gdb_link;
707 /* We can reach here due to changing solib-search-path or the
708 sysroot, before having any inferior. */
709 if (target_has_execution && !ptid_equal (inferior_ptid, null_ptid))
711 struct inferior *inf = current_inferior ();
713 /* If we are attaching to a running process for which we
714 have not opened a symbol file, we may be able to get its
716 if (inf->attach_flag && symfile_objfile == NULL)
717 catch_errors (ops->open_symbol_file_object, &from_tty,
718 "Error reading attached process's symbol file.\n",
722 /* GDB and the inferior's dynamic linker each maintain their own
723 list of currently loaded shared objects; we want to bring the
724 former in sync with the latter. Scan both lists, seeing which
725 shared objects appear where. There are three cases:
727 - A shared object appears on both lists. This means that GDB
728 knows about it already, and it's still loaded in the inferior.
729 Nothing needs to happen.
731 - A shared object appears only on GDB's list. This means that
732 the inferior has unloaded it. We should remove the shared
733 object from GDB's tables.
735 - A shared object appears only on the inferior's list. This
736 means that it's just been loaded. We should add it to GDB's
739 So we walk GDB's list, checking each entry to see if it appears
740 in the inferior's list too. If it does, no action is needed, and
741 we remove it from the inferior's list. If it doesn't, the
742 inferior has unloaded it, and we remove it from GDB's list. By
743 the time we're done walking GDB's list, the inferior's list
744 contains only the new shared objects, which we then add. */
747 gdb_link = &so_list_head;
750 struct so_list *i = inferior;
751 struct so_list **i_link = &inferior;
753 /* Check to see whether the shared object *gdb also appears in
754 the inferior's current list. */
759 if (ops->same (gdb, i))
764 if (! filename_cmp (gdb->so_original_name, i->so_original_name))
772 /* If the shared object appears on the inferior's list too, then
773 it's still loaded, so we don't need to do anything. Delete
774 it from the inferior's list, and leave it on GDB's list. */
779 gdb_link = &gdb->next;
783 /* If it's not on the inferior's list, remove it from GDB's tables. */
786 /* Notify any observer that the shared object has been
787 unloaded before we remove it from GDB's tables. */
788 observer_notify_solib_unloaded (gdb);
790 VEC_safe_push (char_ptr, current_program_space->deleted_solibs,
791 xstrdup (gdb->so_name));
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 && !solib_used (gdb))
798 free_objfile (gdb->objfile);
800 /* Some targets' section tables might be referring to
801 sections from so->abfd; remove them. */
802 remove_target_sections (gdb);
809 /* Now the inferior's list contains only shared objects that don't
810 appear in GDB's list --- those that are newly loaded. Add them
811 to GDB's shared object list. */
815 const char *not_found_filename = NULL;
819 /* Add the new shared objects to GDB's list. */
820 *gdb_link = inferior;
822 /* Fill in the rest of each of the `struct so_list' nodes. */
823 for (i = inferior; i; i = i->next)
825 volatile struct gdb_exception e;
827 i->pspace = current_program_space;
828 VEC_safe_push (so_list_ptr, current_program_space->added_solibs, i);
830 TRY_CATCH (e, RETURN_MASK_ERROR)
832 /* Fill in the rest of the `struct so_list' node. */
833 if (!solib_map_sections (i))
836 if (not_found_filename == NULL)
837 not_found_filename = i->so_original_name;
842 exception_fprintf (gdb_stderr, e,
843 _("Error while mapping shared "
844 "library sections:\n"));
846 /* Notify any observer that the shared object has been
847 loaded now that we've added it to GDB's tables. */
848 observer_notify_solib_loaded (i);
851 /* If a library was not found, issue an appropriate warning
852 message. We have to use a single call to warning in case the
853 front end does something special with warnings, e.g., pop up
854 a dialog box. It Would Be Nice if we could get a "warning: "
855 prefix on each line in the CLI front end, though - it doesn't
859 warning (_("Could not load shared library symbols for %s.\n"
860 "Do you need \"set solib-search-path\" "
861 "or \"set sysroot\"?"),
863 else if (not_found > 1)
865 Could not load shared library symbols for %d libraries, e.g. %s.\n\
866 Use the \"info sharedlibrary\" command to see the complete listing.\n\
867 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
868 not_found, not_found_filename);
873 /* Return non-zero if NAME is the libpthread shared library.
875 Uses a fairly simplistic heuristic approach where we check
876 the file name against "/libpthread". This can lead to false
877 positives, but this should be good enough in practice. */
880 libpthread_name_p (const char *name)
882 return (strstr (name, "/libpthread") != NULL);
885 /* Return non-zero if SO is the libpthread shared library. */
888 libpthread_solib_p (struct so_list *so)
890 return libpthread_name_p (so->so_name);
893 /* Read in symbolic information for any shared objects whose names
894 match PATTERN. (If we've already read a shared object's symbol
895 info, leave it alone.) If PATTERN is zero, read them all.
897 If READSYMS is 0, defer reading symbolic information until later
898 but still do any needed low level processing.
900 FROM_TTY and TARGET are as described for update_solib_list, above. */
903 solib_add (const char *pattern, int from_tty,
904 struct target_ops *target, int readsyms)
908 if (print_symbol_loading_p (from_tty, 0, 0))
912 printf_unfiltered (_("Loading symbols for shared libraries: %s\n"),
916 printf_unfiltered (_("Loading symbols for shared libraries.\n"));
919 current_program_space->solib_add_generation++;
923 char *re_err = re_comp (pattern);
926 error (_("Invalid regexp: %s"), re_err);
929 update_solib_list (from_tty, target);
931 /* Walk the list of currently loaded shared libraries, and read
932 symbols for any that match the pattern --- or any whose symbols
933 aren't already loaded, if no pattern was given. */
936 int loaded_any_symbols = 0;
938 SYMFILE_DEFER_BP_RESET | (from_tty ? SYMFILE_VERBOSE : 0);
940 for (gdb = so_list_head; gdb; gdb = gdb->next)
941 if (! pattern || re_exec (gdb->so_name))
943 /* Normally, we would read the symbols from that library
944 only if READSYMS is set. However, we're making a small
945 exception for the pthread library, because we sometimes
946 need the library symbols to be loaded in order to provide
947 thread support (x86-linux for instance). */
948 const int add_this_solib =
949 (readsyms || libpthread_solib_p (gdb));
954 if (gdb->symbols_loaded)
956 /* If no pattern was given, be quiet for shared
957 libraries we have already loaded. */
958 if (pattern && (from_tty || info_verbose))
959 printf_unfiltered (_("Symbols already loaded for %s\n"),
962 else if (solib_read_symbols (gdb, flags))
963 loaded_any_symbols = 1;
967 if (loaded_any_symbols)
968 breakpoint_re_set ();
970 if (from_tty && pattern && ! any_matches)
972 ("No loaded shared libraries match the pattern `%s'.\n", pattern);
974 if (loaded_any_symbols)
976 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
978 /* Getting new symbols may change our opinion about what is
980 reinit_frame_cache ();
982 ops->special_symbol_handling ();
987 /* Implement the "info sharedlibrary" command. Walk through the
988 shared library list and print information about each attached
989 library matching PATTERN. If PATTERN is elided, print them
993 info_sharedlibrary_command (char *pattern, int from_tty)
995 struct so_list *so = NULL; /* link map state variable */
996 int so_missing_debug_info = 0;
999 struct cleanup *table_cleanup;
1000 struct gdbarch *gdbarch = target_gdbarch ();
1001 struct ui_out *uiout = current_uiout;
1005 char *re_err = re_comp (pattern);
1008 error (_("Invalid regexp: %s"), re_err);
1011 /* "0x", a little whitespace, and two hex digits per byte of pointers. */
1012 addr_width = 4 + (gdbarch_ptr_bit (gdbarch) / 4);
1014 update_solib_list (from_tty, 0);
1016 /* make_cleanup_ui_out_table_begin_end needs to know the number of
1017 rows, so we need to make two passes over the libs. */
1019 for (nr_libs = 0, so = so_list_head; so; so = so->next)
1023 if (pattern && ! re_exec (so->so_name))
1030 make_cleanup_ui_out_table_begin_end (uiout, 4, nr_libs,
1031 "SharedLibraryTable");
1033 /* The "- 1" is because ui_out adds one space between columns. */
1034 ui_out_table_header (uiout, addr_width - 1, ui_left, "from", "From");
1035 ui_out_table_header (uiout, addr_width - 1, ui_left, "to", "To");
1036 ui_out_table_header (uiout, 12 - 1, ui_left, "syms-read", "Syms Read");
1037 ui_out_table_header (uiout, 0, ui_noalign,
1038 "name", "Shared Object Library");
1040 ui_out_table_body (uiout);
1042 for (so = so_list_head; so; so = so->next)
1044 struct cleanup *lib_cleanup;
1046 if (! so->so_name[0])
1048 if (pattern && ! re_exec (so->so_name))
1051 lib_cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, "lib");
1053 if (so->addr_high != 0)
1055 ui_out_field_core_addr (uiout, "from", gdbarch, so->addr_low);
1056 ui_out_field_core_addr (uiout, "to", gdbarch, so->addr_high);
1060 ui_out_field_skip (uiout, "from");
1061 ui_out_field_skip (uiout, "to");
1064 if (! ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ()))
1065 && so->symbols_loaded
1066 && !objfile_has_symbols (so->objfile))
1068 so_missing_debug_info = 1;
1069 ui_out_field_string (uiout, "syms-read", "Yes (*)");
1072 ui_out_field_string (uiout, "syms-read",
1073 so->symbols_loaded ? "Yes" : "No");
1075 ui_out_field_string (uiout, "name", so->so_name);
1077 ui_out_text (uiout, "\n");
1079 do_cleanups (lib_cleanup);
1082 do_cleanups (table_cleanup);
1087 ui_out_message (uiout, 0,
1088 _("No shared libraries matched.\n"));
1090 ui_out_message (uiout, 0,
1091 _("No shared libraries loaded at this time.\n"));
1095 if (so_missing_debug_info)
1096 ui_out_message (uiout, 0,
1097 _("(*): Shared library is missing "
1098 "debugging information.\n"));
1102 /* Return 1 if ADDRESS lies within SOLIB. */
1105 solib_contains_address_p (const struct so_list *const solib,
1108 struct target_section *p;
1110 for (p = solib->sections; p < solib->sections_end; p++)
1111 if (p->addr <= address && address < p->endaddr)
1117 /* If ADDRESS is in a shared lib in program space PSPACE, return its
1120 Provides a hook for other gdb routines to discover whether or not a
1121 particular address is within the mapped address space of a shared
1124 For example, this routine is called at one point to disable
1125 breakpoints which are in shared libraries that are not currently
1129 solib_name_from_address (struct program_space *pspace, CORE_ADDR address)
1131 struct so_list *so = NULL;
1133 for (so = pspace->so_list; so; so = so->next)
1134 if (solib_contains_address_p (so, address))
1135 return (so->so_name);
1140 /* Return whether the data starting at VADDR, size SIZE, must be kept
1141 in a core file for shared libraries loaded before "gcore" is used
1142 to be handled correctly when the core file is loaded. This only
1143 applies when the section would otherwise not be kept in the core
1144 file (in particular, for readonly sections). */
1147 solib_keep_data_in_core (CORE_ADDR vaddr, unsigned long size)
1149 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1151 if (ops->keep_data_in_core)
1152 return ops->keep_data_in_core (vaddr, size);
1157 /* Called by free_all_symtabs */
1162 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1164 /* This function is expected to handle ELF shared libraries. It is
1165 also used on Solaris, which can run either ELF or a.out binaries
1166 (for compatibility with SunOS 4), both of which can use shared
1167 libraries. So we don't know whether we have an ELF executable or
1168 an a.out executable until the user chooses an executable file.
1170 ELF shared libraries don't get mapped into the address space
1171 until after the program starts, so we'd better not try to insert
1172 breakpoints in them immediately. We have to wait until the
1173 dynamic linker has loaded them; we'll hit a bp_shlib_event
1174 breakpoint (look for calls to create_solib_event_breakpoint) when
1177 SunOS shared libraries seem to be different --- they're present
1178 as soon as the process begins execution, so there's no need to
1179 put off inserting breakpoints. There's also nowhere to put a
1180 bp_shlib_event breakpoint, so if we put it off, we'll never get
1183 So: disable breakpoints only if we're using ELF shared libs. */
1184 if (exec_bfd != NULL
1185 && bfd_get_flavour (exec_bfd) != bfd_target_aout_flavour)
1186 disable_breakpoints_in_shlibs ();
1188 while (so_list_head)
1190 struct so_list *so = so_list_head;
1192 so_list_head = so->next;
1193 observer_notify_solib_unloaded (so);
1194 remove_target_sections (so);
1198 ops->clear_solib ();
1201 /* Shared library startup support. When GDB starts up the inferior,
1202 it nurses it along (through the shell) until it is ready to execute
1203 its first instruction. At this point, this function gets
1207 solib_create_inferior_hook (int from_tty)
1209 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1211 ops->solib_create_inferior_hook (from_tty);
1214 /* Check to see if an address is in the dynamic loader's dynamic
1215 symbol resolution code. Return 1 if so, 0 otherwise. */
1218 in_solib_dynsym_resolve_code (CORE_ADDR pc)
1220 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1222 return ops->in_dynsym_resolve_code (pc);
1225 /* Implements the "sharedlibrary" command. */
1228 sharedlibrary_command (char *args, int from_tty)
1231 solib_add (args, from_tty, (struct target_ops *) 0, 1);
1234 /* Implements the command "nosharedlibrary", which discards symbols
1235 that have been auto-loaded from shared libraries. Symbols from
1236 shared libraries that were added by explicit request of the user
1237 are not discarded. Also called from remote.c. */
1240 no_shared_libraries (char *ignored, int from_tty)
1242 /* The order of the two routines below is important: clear_solib notifies
1243 the solib_unloaded observers, and some of these observers might need
1244 access to their associated objfiles. Therefore, we can not purge the
1245 solibs' objfiles before clear_solib has been called. */
1248 objfile_purge_solibs ();
1254 update_solib_breakpoints (void)
1256 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1258 if (ops->update_breakpoints != NULL)
1259 ops->update_breakpoints ();
1265 handle_solib_event (void)
1267 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1269 if (ops->handle_event != NULL)
1270 ops->handle_event ();
1272 clear_program_space_solib_cache (current_inferior ()->pspace);
1274 /* Check for any newly added shared libraries if we're supposed to
1275 be adding them automatically. Switch terminal for any messages
1276 produced by breakpoint_re_set. */
1277 target_terminal_ours_for_output ();
1278 solib_add (NULL, 0, ¤t_target, auto_solib_add);
1279 target_terminal_inferior ();
1282 /* Reload shared libraries, but avoid reloading the same symbol file
1283 we already have loaded. */
1286 reload_shared_libraries_1 (int from_tty)
1289 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
1291 if (print_symbol_loading_p (from_tty, 0, 0))
1292 printf_unfiltered (_("Loading symbols for shared libraries.\n"));
1294 for (so = so_list_head; so != NULL; so = so->next)
1296 char *filename, *found_pathname = NULL;
1298 int was_loaded = so->symbols_loaded;
1300 SYMFILE_DEFER_BP_RESET | (from_tty ? SYMFILE_VERBOSE : 0);
1302 filename = tilde_expand (so->so_original_name);
1303 make_cleanup (xfree, filename);
1304 abfd = solib_bfd_open (filename);
1307 found_pathname = xstrdup (bfd_get_filename (abfd));
1308 make_cleanup (xfree, found_pathname);
1309 gdb_bfd_unref (abfd);
1312 /* If this shared library is no longer associated with its previous
1313 symbol file, close that. */
1314 if ((found_pathname == NULL && was_loaded)
1315 || (found_pathname != NULL
1316 && filename_cmp (found_pathname, so->so_name) != 0))
1318 if (so->objfile && ! (so->objfile->flags & OBJF_USERLOADED)
1319 && !solib_used (so))
1320 free_objfile (so->objfile);
1321 remove_target_sections (so);
1325 /* If this shared library is now associated with a new symbol
1327 if (found_pathname != NULL
1329 || filename_cmp (found_pathname, so->so_name) != 0))
1331 volatile struct gdb_exception e;
1333 TRY_CATCH (e, RETURN_MASK_ERROR)
1334 solib_map_sections (so);
1337 exception_fprintf (gdb_stderr, e,
1338 _("Error while mapping "
1339 "shared library sections:\n"));
1340 else if (auto_solib_add || was_loaded || libpthread_solib_p (so))
1341 solib_read_symbols (so, flags);
1345 do_cleanups (old_chain);
1349 reload_shared_libraries (char *ignored, int from_tty,
1350 struct cmd_list_element *e)
1352 const struct target_so_ops *ops;
1354 reload_shared_libraries_1 (from_tty);
1356 ops = solib_ops (target_gdbarch ());
1358 /* Creating inferior hooks here has two purposes. First, if we reload
1359 shared libraries then the address of solib breakpoint we've computed
1360 previously might be no longer valid. For example, if we forgot to set
1361 solib-absolute-prefix and are setting it right now, then the previous
1362 breakpoint address is plain wrong. Second, installing solib hooks
1363 also implicitly figures were ld.so is and loads symbols for it.
1364 Absent this call, if we've just connected to a target and set
1365 solib-absolute-prefix or solib-search-path, we'll lose all information
1367 if (target_has_execution)
1369 /* Reset or free private data structures not associated with
1371 ops->clear_solib ();
1373 /* Remove any previous solib event breakpoint. This is usually
1374 done in common code, at breakpoint_init_inferior time, but
1375 we're not really starting up the inferior here. */
1376 remove_solib_event_breakpoints ();
1378 solib_create_inferior_hook (from_tty);
1381 /* Sometimes the platform-specific hook loads initial shared
1382 libraries, and sometimes it doesn't. If it doesn't FROM_TTY will be
1383 incorrectly 0 but such solib targets should be fixed anyway. If we
1384 made all the inferior hook methods consistent, this call could be
1385 removed. Call it only after the solib target has been initialized by
1386 solib_create_inferior_hook. */
1388 solib_add (NULL, 0, NULL, auto_solib_add);
1390 breakpoint_re_set ();
1392 /* We may have loaded or unloaded debug info for some (or all)
1393 shared libraries. However, frames may still reference them. For
1394 example, a frame's unwinder might still point at DWARF FDE
1395 structures that are now freed. Also, getting new symbols may
1396 change our opinion about what is frameless. */
1397 reinit_frame_cache ();
1399 ops->special_symbol_handling ();
1403 show_auto_solib_add (struct ui_file *file, int from_tty,
1404 struct cmd_list_element *c, const char *value)
1406 fprintf_filtered (file, _("Autoloading of shared library symbols is %s.\n"),
1411 /* Handler for library-specific lookup of global symbol NAME in OBJFILE. Call
1412 the library-specific handler if it is installed for the current target. */
1415 solib_global_lookup (const struct objfile *objfile,
1417 const domain_enum domain)
1419 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1421 if (ops->lookup_lib_global_symbol != NULL)
1422 return ops->lookup_lib_global_symbol (objfile, name, domain);
1426 /* Lookup the value for a specific symbol from dynamic symbol table. Look
1427 up symbol from ABFD. MATCH_SYM is a callback function to determine
1428 whether to pick up a symbol. DATA is the input of this callback
1429 function. Return NULL if symbol is not found. */
1432 gdb_bfd_lookup_symbol_from_symtab (bfd *abfd,
1433 int (*match_sym) (asymbol *, void *),
1436 long storage_needed = bfd_get_symtab_upper_bound (abfd);
1437 CORE_ADDR symaddr = 0;
1439 if (storage_needed > 0)
1443 asymbol **symbol_table = (asymbol **) xmalloc (storage_needed);
1444 struct cleanup *back_to = make_cleanup (xfree, symbol_table);
1445 unsigned int number_of_symbols =
1446 bfd_canonicalize_symtab (abfd, symbol_table);
1448 for (i = 0; i < number_of_symbols; i++)
1450 asymbol *sym = *symbol_table++;
1452 if (match_sym (sym, data))
1454 /* BFD symbols are section relative. */
1455 symaddr = sym->value + sym->section->vma;
1459 do_cleanups (back_to);
1465 /* Lookup the value for a specific symbol from symbol table. Look up symbol
1466 from ABFD. MATCH_SYM is a callback function to determine whether to pick
1467 up a symbol. DATA is the input of this callback function. Return NULL
1468 if symbol is not found. */
1471 bfd_lookup_symbol_from_dyn_symtab (bfd *abfd,
1472 int (*match_sym) (asymbol *, void *),
1475 long storage_needed = bfd_get_dynamic_symtab_upper_bound (abfd);
1476 CORE_ADDR symaddr = 0;
1478 if (storage_needed > 0)
1481 asymbol **symbol_table = (asymbol **) xmalloc (storage_needed);
1482 struct cleanup *back_to = make_cleanup (xfree, symbol_table);
1483 unsigned int number_of_symbols =
1484 bfd_canonicalize_dynamic_symtab (abfd, symbol_table);
1486 for (i = 0; i < number_of_symbols; i++)
1488 asymbol *sym = *symbol_table++;
1490 if (match_sym (sym, data))
1492 /* BFD symbols are section relative. */
1493 symaddr = sym->value + sym->section->vma;
1497 do_cleanups (back_to);
1502 /* Lookup the value for a specific symbol from symbol table and dynamic
1503 symbol table. Look up symbol from ABFD. MATCH_SYM is a callback
1504 function to determine whether to pick up a symbol. DATA is the
1505 input of this callback function. Return NULL if symbol is not
1509 gdb_bfd_lookup_symbol (bfd *abfd,
1510 int (*match_sym) (asymbol *, void *),
1513 CORE_ADDR symaddr = gdb_bfd_lookup_symbol_from_symtab (abfd, match_sym, data);
1515 /* On FreeBSD, the dynamic linker is stripped by default. So we'll
1516 have to check the dynamic string table too. */
1518 symaddr = bfd_lookup_symbol_from_dyn_symtab (abfd, match_sym, data);
1523 /* SO_LIST_HEAD may contain user-loaded object files that can be removed
1524 out-of-band by the user. So upon notification of free_objfile remove
1525 all references to any user-loaded file that is about to be freed. */
1528 remove_user_added_objfile (struct objfile *objfile)
1532 if (objfile != 0 && objfile->flags & OBJF_USERLOADED)
1534 for (so = so_list_head; so != NULL; so = so->next)
1535 if (so->objfile == objfile)
1540 extern initialize_file_ftype _initialize_solib; /* -Wmissing-prototypes */
1543 _initialize_solib (void)
1545 solib_data = gdbarch_data_register_pre_init (solib_init);
1547 observer_attach_free_objfile (remove_user_added_objfile);
1549 add_com ("sharedlibrary", class_files, sharedlibrary_command,
1550 _("Load shared object library symbols for files matching REGEXP."));
1551 add_info ("sharedlibrary", info_sharedlibrary_command,
1552 _("Status of loaded shared object libraries."));
1553 add_com ("nosharedlibrary", class_files, no_shared_libraries,
1554 _("Unload all shared object library symbols."));
1556 add_setshow_boolean_cmd ("auto-solib-add", class_support,
1557 &auto_solib_add, _("\
1558 Set autoloading of shared library symbols."), _("\
1559 Show autoloading of shared library symbols."), _("\
1560 If \"on\", symbols from all shared object libraries will be loaded\n\
1561 automatically when the inferior begins execution, when the dynamic linker\n\
1562 informs gdb that a new library has been loaded, or when attaching to the\n\
1563 inferior. Otherwise, symbols must be loaded manually, using \
1566 show_auto_solib_add,
1567 &setlist, &showlist);
1569 add_setshow_filename_cmd ("sysroot", class_support,
1571 Set an alternate system root."), _("\
1572 Show the current system root."), _("\
1573 The system root is used to load absolute shared library symbol files.\n\
1574 For other (relative) files, you can add directories using\n\
1575 `set solib-search-path'."),
1576 reload_shared_libraries,
1578 &setlist, &showlist);
1580 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1582 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1585 add_setshow_optional_filename_cmd ("solib-search-path", class_support,
1586 &solib_search_path, _("\
1587 Set the search path for loading non-absolute shared library symbol files."),
1589 Show the search path for loading non-absolute shared library symbol files."),
1591 This takes precedence over the environment variables \
1592 PATH and LD_LIBRARY_PATH."),
1593 reload_shared_libraries,
1594 show_solib_search_path,
1595 &setlist, &showlist);