1 /* Handle shared libraries for GDB, the GNU Debugger.
3 Copyright (C) 1990-2015 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>
32 #include "gdb_regex.h"
37 #include "completer.h"
38 #include "filenames.h" /* for DOSish file names */
42 #include "readline/readline.h"
46 #include "filesystem.h"
48 #include "filestuff.h"
50 /* Architecture-specific operations. */
52 /* Per-architecture data key. */
53 static struct gdbarch_data *solib_data;
56 solib_init (struct obstack *obstack)
58 struct target_so_ops **ops;
60 ops = OBSTACK_ZALLOC (obstack, struct target_so_ops *);
61 *ops = current_target_so_ops;
65 static const struct target_so_ops *
66 solib_ops (struct gdbarch *gdbarch)
68 const struct target_so_ops **ops = gdbarch_data (gdbarch, solib_data);
73 /* Set the solib operations for GDBARCH to NEW_OPS. */
76 set_solib_ops (struct gdbarch *gdbarch, const struct target_so_ops *new_ops)
78 const 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, _("The search path for loading non-absolute "
104 "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
115 /* Returns the full pathname of the shared library file, or NULL if
116 not found. (The pathname is malloc'ed; it needs to be freed by the
117 caller.) *FD is set to either -1 or an open file handle for the
120 Global variable GDB_SYSROOT is used as a prefix directory
121 to search for shared libraries if they have an absolute path.
123 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
124 (or set of directories, as in LD_LIBRARY_PATH) to search for all
125 shared libraries if not found in GDB_SYSROOT.
128 * If there is a gdb_sysroot and path is absolute:
129 * Search for gdb_sysroot/path.
131 * Look for it literally (unmodified).
132 * Look in SOLIB_SEARCH_PATH.
133 * If available, use target defined search function.
134 * If gdb_sysroot is NOT set, perform the following two searches:
135 * Look in inferior's $PATH.
136 * Look in inferior's $LD_LIBRARY_PATH.
138 * The last check avoids doing this search when targetting remote
139 * machines since gdb_sysroot will almost always be set.
143 solib_find (char *in_pathname, int *fd)
145 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
147 char *temp_pathname = NULL;
148 int gdb_sysroot_is_empty;
149 const char *solib_symbols_extension
150 = gdbarch_solib_symbols_extension (target_gdbarch ());
151 const char *fskind = effective_target_file_system_kind ();
152 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
153 char *sysroot = NULL;
155 /* If solib_symbols_extension is set, replace the file's
157 if (solib_symbols_extension)
159 char *p = in_pathname + strlen (in_pathname);
161 while (p > in_pathname && *p != '.')
168 new_pathname = alloca (p - in_pathname + 1
169 + strlen (solib_symbols_extension) + 1);
170 memcpy (new_pathname, in_pathname, p - in_pathname + 1);
171 strcpy (new_pathname + (p - in_pathname) + 1,
172 solib_symbols_extension);
174 in_pathname = new_pathname;
178 gdb_sysroot_is_empty = (gdb_sysroot == NULL || *gdb_sysroot == 0);
180 if (!gdb_sysroot_is_empty)
182 int prefix_len = strlen (gdb_sysroot);
184 /* Remove trailing slashes from absolute prefix. */
185 while (prefix_len > 0
186 && IS_DIR_SEPARATOR (gdb_sysroot[prefix_len - 1]))
189 sysroot = savestring (gdb_sysroot, prefix_len);
190 make_cleanup (xfree, sysroot);
193 /* If we're on a non-DOS-based system, backslashes won't be
194 understood as directory separator, so, convert them to forward
195 slashes, iff we're supposed to handle DOS-based file system
196 semantics for target paths. */
197 if (!DOS_BASED_FILE_SYSTEM && fskind == file_system_kind_dos_based)
201 /* Avoid clobbering our input. */
202 p = alloca (strlen (in_pathname) + 1);
203 strcpy (p, in_pathname);
213 /* Note, we're interested in IS_TARGET_ABSOLUTE_PATH, not
214 IS_ABSOLUTE_PATH. The latter is for host paths only, while
215 IN_PATHNAME is a target path. For example, if we're supposed to
216 be handling DOS-like semantics we want to consider a
217 'c:/foo/bar.dll' path as an absolute path, even on a Unix box.
218 With such a path, before giving up on the sysroot, we'll try:
220 1st attempt, c:/foo/bar.dll ==> /sysroot/c:/foo/bar.dll
221 2nd attempt, c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll
222 3rd attempt, c:/foo/bar.dll ==> /sysroot/foo/bar.dll
225 if (!IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname) || gdb_sysroot_is_empty)
226 temp_pathname = xstrdup (in_pathname);
229 int need_dir_separator;
231 /* Concatenate the sysroot and the target reported filename. We
232 may need to glue them with a directory separator. Cases to
235 | sysroot | separator | in_pathname |
236 |-----------------+-----------+----------------|
237 | /some/dir | / | c:/foo/bar.dll |
238 | /some/dir | | /foo/bar.dll |
239 | remote: | | c:/foo/bar.dll |
240 | remote: | | /foo/bar.dll |
241 | remote:some/dir | / | c:/foo/bar.dll |
242 | remote:some/dir | | /foo/bar.dll |
244 IOW, we don't need to add a separator if IN_PATHNAME already
245 has one, or when the the sysroot is exactly "remote:".
246 There's no need to check for drive spec explicitly, as we only
247 get here if IN_PATHNAME is considered an absolute path. */
248 need_dir_separator = !(IS_DIR_SEPARATOR (in_pathname[0])
249 || strcmp (REMOTE_SYSROOT_PREFIX, sysroot) == 0);
251 /* Cat the prefixed pathname together. */
252 temp_pathname = concat (sysroot,
253 need_dir_separator ? SLASH_STRING : "",
254 in_pathname, (char *) NULL);
257 /* Handle remote files. */
258 if (remote_filename_p (temp_pathname))
261 do_cleanups (old_chain);
262 return temp_pathname;
265 /* Now see if we can open it. */
266 found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
268 xfree (temp_pathname);
270 /* If the search in gdb_sysroot failed, and the path name has a
271 drive spec (e.g, c:/foo), try stripping ':' from the drive spec,
272 and retrying in the sysroot:
273 c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll. */
276 && !gdb_sysroot_is_empty
277 && HAS_TARGET_DRIVE_SPEC (fskind, in_pathname))
279 int need_dir_separator = !IS_DIR_SEPARATOR (in_pathname[2]);
280 char *drive = savestring (in_pathname, 1);
282 temp_pathname = concat (sysroot,
285 need_dir_separator ? SLASH_STRING : "",
286 in_pathname + 2, (char *) NULL);
289 found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
292 xfree (temp_pathname);
294 /* If the search in gdb_sysroot still failed, try fully
295 stripping the drive spec, and trying once more in the
296 sysroot before giving up.
298 c:/foo/bar.dll ==> /sysroot/foo/bar.dll. */
300 temp_pathname = concat (sysroot,
301 need_dir_separator ? SLASH_STRING : "",
302 in_pathname + 2, (char *) NULL);
304 found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
306 xfree (temp_pathname);
310 do_cleanups (old_chain);
312 /* We try to find the library in various ways. After each attempt,
313 either found_file >= 0 and temp_pathname is a malloc'd string, or
314 found_file < 0 and temp_pathname does not point to storage that
315 needs to be freed. */
318 temp_pathname = NULL;
320 /* If the search in gdb_sysroot failed, and the path name is
321 absolute at this point, make it relative. (openp will try and open the
322 file according to its absolute path otherwise, which is not what we want.)
323 Affects subsequent searches for this solib. */
324 if (found_file < 0 && IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname))
326 /* First, get rid of any drive letters etc. */
327 while (!IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
330 /* Next, get rid of all leading dir separators. */
331 while (IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
335 /* If not found, search the solib_search_path (if any). */
336 if (found_file < 0 && solib_search_path != NULL)
337 found_file = openp (solib_search_path,
338 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
339 in_pathname, O_RDONLY | O_BINARY, &temp_pathname);
341 /* If not found, next search the solib_search_path (if any) for the basename
342 only (ignoring the path). This is to allow reading solibs from a path
343 that differs from the opened path. */
344 if (found_file < 0 && solib_search_path != NULL)
345 found_file = openp (solib_search_path,
346 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
347 target_lbasename (fskind, in_pathname),
348 O_RDONLY | O_BINARY, &temp_pathname);
350 /* If not found, try to use target supplied solib search method. */
351 if (found_file < 0 && ops->find_and_open_solib)
352 found_file = ops->find_and_open_solib (in_pathname, O_RDONLY | O_BINARY,
355 /* If not found, next search the inferior's $PATH environment variable. */
356 if (found_file < 0 && gdb_sysroot_is_empty)
357 found_file = openp (get_in_environ (current_inferior ()->environment,
359 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
360 O_RDONLY | O_BINARY, &temp_pathname);
362 /* If not found, next search the inferior's $LD_LIBRARY_PATH
363 environment variable. */
364 if (found_file < 0 && gdb_sysroot_is_empty)
365 found_file = openp (get_in_environ (current_inferior ()->environment,
367 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
368 O_RDONLY | O_BINARY, &temp_pathname);
371 return temp_pathname;
374 /* Open and return a BFD for the shared library PATHNAME. If FD is not -1,
375 it is used as file handle to open the file. Throws an error if the file
376 could not be opened. Handles both local and remote file access.
378 PATHNAME must be malloc'ed by the caller. It will be freed by this
379 function. If unsuccessful, the FD will be closed (unless FD was
383 solib_bfd_fopen (char *pathname, int fd)
387 if (remote_filename_p (pathname))
389 gdb_assert (fd == -1);
390 abfd = remote_bfd_open (pathname, gnutarget);
394 abfd = gdb_bfd_open (pathname, gnutarget, fd);
397 bfd_set_cacheable (abfd, 1);
402 make_cleanup (xfree, pathname);
403 error (_("Could not open `%s' as an executable file: %s"),
404 pathname, bfd_errmsg (bfd_get_error ()));
412 /* Find shared library PATHNAME and open a BFD for it. */
415 solib_bfd_open (char *pathname)
417 char *found_pathname;
420 const struct bfd_arch_info *b;
422 /* Search for shared library file. */
423 found_pathname = solib_find (pathname, &found_file);
424 if (found_pathname == NULL)
426 /* Return failure if the file could not be found, so that we can
427 accumulate messages about missing libraries. */
431 perror_with_name (pathname);
434 /* Open bfd for shared library. */
435 abfd = solib_bfd_fopen (found_pathname, found_file);
437 /* Check bfd format. */
438 if (!bfd_check_format (abfd, bfd_object))
440 make_cleanup_bfd_unref (abfd);
441 error (_("`%s': not in executable format: %s"),
442 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
445 /* Check bfd arch. */
446 b = gdbarch_bfd_arch_info (target_gdbarch ());
447 if (!b->compatible (b, bfd_get_arch_info (abfd)))
448 warning (_("`%s': Shared library architecture %s is not compatible "
449 "with target architecture %s."), bfd_get_filename (abfd),
450 bfd_get_arch_info (abfd)->printable_name, b->printable_name);
455 /* Given a pointer to one of the shared objects in our list of mapped
456 objects, use the recorded name to open a bfd descriptor for the
457 object, build a section table, relocate all the section addresses
458 by the base address at which the shared object was mapped, and then
459 add the sections to the target's section table.
461 FIXME: In most (all?) cases the shared object file name recorded in
462 the dynamic linkage tables will be a fully qualified pathname. For
463 cases where it isn't, do we really mimic the systems search
464 mechanism correctly in the below code (particularly the tilde
465 expansion stuff?). */
468 solib_map_sections (struct so_list *so)
470 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
472 struct target_section *p;
473 struct cleanup *old_chain;
476 filename = tilde_expand (so->so_name);
477 old_chain = make_cleanup (xfree, filename);
478 abfd = ops->bfd_open (filename);
479 do_cleanups (old_chain);
484 /* Leave bfd open, core_xfer_memory and "info files" need it. */
487 /* Copy the full path name into so_name, allowing symbol_file_add
488 to find it later. This also affects the =library-loaded GDB/MI
489 event, and in particular the part of that notification providing
490 the library's host-side path. If we let the target dictate
491 that objfile's path, and the target is different from the host,
492 GDB/MI will not provide the correct host-side path. */
493 if (strlen (bfd_get_filename (abfd)) >= SO_NAME_MAX_PATH_SIZE)
494 error (_("Shared library file name is too long."));
495 strcpy (so->so_name, bfd_get_filename (abfd));
497 if (build_section_table (abfd, &so->sections, &so->sections_end))
499 error (_("Can't find the file sections in `%s': %s"),
500 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
503 for (p = so->sections; p < so->sections_end; p++)
505 /* Relocate the section binding addresses as recorded in the shared
506 object's file by the base address to which the object was actually
508 ops->relocate_section_addresses (so, p);
510 /* If the target didn't provide information about the address
511 range of the shared object, assume we want the location of
512 the .text section. */
513 if (so->addr_low == 0 && so->addr_high == 0
514 && strcmp (p->the_bfd_section->name, ".text") == 0)
516 so->addr_low = p->addr;
517 so->addr_high = p->endaddr;
521 /* Add the shared object's sections to the current set of file
522 section tables. Do this immediately after mapping the object so
523 that later nodes in the list can query this object, as is needed
525 add_target_sections (so, so->sections, so->sections_end);
530 /* Free symbol-file related contents of SO and reset for possible reloading
531 of SO. If we have opened a BFD for SO, close it. If we have placed SO's
532 sections in some target's section table, the caller is responsible for
535 This function doesn't mess with objfiles at all. If there is an
536 objfile associated with SO that needs to be removed, the caller is
537 responsible for taking care of that. */
540 clear_so (struct so_list *so)
542 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
546 xfree (so->sections);
547 so->sections = so->sections_end = NULL;
550 gdb_bfd_unref (so->abfd);
553 /* Our caller closed the objfile, possibly via objfile_purge_solibs. */
554 so->symbols_loaded = 0;
557 so->addr_low = so->addr_high = 0;
559 /* Restore the target-supplied file name. SO_NAME may be the path
560 of the symbol file. */
561 strcpy (so->so_name, so->so_original_name);
563 /* Do the same for target-specific data. */
564 if (ops->clear_so != NULL)
568 /* Free the storage associated with the `struct so_list' object SO.
569 If we have opened a BFD for SO, close it.
571 The caller is responsible for removing SO from whatever list it is
572 a member of. If we have placed SO's sections in some target's
573 section table, the caller is responsible for removing them.
575 This function doesn't mess with objfiles at all. If there is an
576 objfile associated with SO that needs to be removed, the caller is
577 responsible for taking care of that. */
580 free_so (struct so_list *so)
582 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
591 /* Return address of first so_list entry in master shared object list. */
593 master_so_list (void)
598 /* Read in symbols for shared object SO. If SYMFILE_VERBOSE is set in FLAGS,
599 be chatty about it. Return non-zero if any symbols were actually
603 solib_read_symbols (struct so_list *so, int flags)
605 if (so->symbols_loaded)
607 /* If needed, we've already warned in our caller. */
609 else if (so->abfd == NULL)
611 /* We've already warned about this library, when trying to open
617 flags |= current_inferior ()->symfile_flags;
621 struct section_addr_info *sap;
623 /* Have we already loaded this shared object? */
624 ALL_OBJFILES (so->objfile)
626 if (filename_cmp (objfile_name (so->objfile), so->so_name) == 0
627 && so->objfile->addr_low == so->addr_low)
630 if (so->objfile != NULL)
633 sap = build_section_addr_info_from_section_table (so->sections,
635 so->objfile = symbol_file_add_from_bfd (so->abfd, so->so_name,
636 flags, sap, OBJF_SHARED,
638 so->objfile->addr_low = so->addr_low;
639 free_section_addr_info (sap);
641 so->symbols_loaded = 1;
643 CATCH (e, RETURN_MASK_ERROR)
645 exception_fprintf (gdb_stderr, e, _("Error while reading shared"
646 " library symbols for %s:\n"),
657 /* Return 1 if KNOWN->objfile is used by any other so_list object in the
658 SO_LIST_HEAD list. Return 0 otherwise. */
661 solib_used (const struct so_list *const known)
663 const struct so_list *pivot;
665 for (pivot = so_list_head; pivot != NULL; pivot = pivot->next)
666 if (pivot != known && pivot->objfile == known->objfile)
671 /* Synchronize GDB's shared object list with inferior's.
673 Extract the list of currently loaded shared objects from the
674 inferior, and compare it with the list of shared objects currently
675 in GDB's so_list_head list. Edit so_list_head to bring it in sync
676 with the inferior's new list.
678 If we notice that the inferior has unloaded some shared objects,
679 free any symbolic info GDB had read about those shared objects.
681 Don't load symbolic info for any new shared objects; just add them
682 to the list, and leave their symbols_loaded flag clear.
684 If FROM_TTY is non-null, feel free to print messages about what
687 If TARGET is non-null, add the sections of all new shared objects
688 to TARGET's section table. Note that this doesn't remove any
689 sections for shared objects that have been unloaded, and it
690 doesn't check to see if the new shared objects are already present in
691 the section table. But we only use this for core files and
692 processes we've just attached to, so that's okay. */
695 update_solib_list (int from_tty, struct target_ops *target)
697 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
698 struct so_list *inferior = ops->current_sos();
699 struct so_list *gdb, **gdb_link;
701 /* We can reach here due to changing solib-search-path or the
702 sysroot, before having any inferior. */
703 if (target_has_execution && !ptid_equal (inferior_ptid, null_ptid))
705 struct inferior *inf = current_inferior ();
707 /* If we are attaching to a running process for which we
708 have not opened a symbol file, we may be able to get its
710 if (inf->attach_flag && symfile_objfile == NULL)
711 catch_errors (ops->open_symbol_file_object, &from_tty,
712 "Error reading attached process's symbol file.\n",
716 /* GDB and the inferior's dynamic linker each maintain their own
717 list of currently loaded shared objects; we want to bring the
718 former in sync with the latter. Scan both lists, seeing which
719 shared objects appear where. There are three cases:
721 - A shared object appears on both lists. This means that GDB
722 knows about it already, and it's still loaded in the inferior.
723 Nothing needs to happen.
725 - A shared object appears only on GDB's list. This means that
726 the inferior has unloaded it. We should remove the shared
727 object from GDB's tables.
729 - A shared object appears only on the inferior's list. This
730 means that it's just been loaded. We should add it to GDB's
733 So we walk GDB's list, checking each entry to see if it appears
734 in the inferior's list too. If it does, no action is needed, and
735 we remove it from the inferior's list. If it doesn't, the
736 inferior has unloaded it, and we remove it from GDB's list. By
737 the time we're done walking GDB's list, the inferior's list
738 contains only the new shared objects, which we then add. */
741 gdb_link = &so_list_head;
744 struct so_list *i = inferior;
745 struct so_list **i_link = &inferior;
747 /* Check to see whether the shared object *gdb also appears in
748 the inferior's current list. */
753 if (ops->same (gdb, i))
758 if (! filename_cmp (gdb->so_original_name, i->so_original_name))
766 /* If the shared object appears on the inferior's list too, then
767 it's still loaded, so we don't need to do anything. Delete
768 it from the inferior's list, and leave it on GDB's list. */
773 gdb_link = &gdb->next;
777 /* If it's not on the inferior's list, remove it from GDB's tables. */
780 /* Notify any observer that the shared object has been
781 unloaded before we remove it from GDB's tables. */
782 observer_notify_solib_unloaded (gdb);
784 VEC_safe_push (char_ptr, current_program_space->deleted_solibs,
785 xstrdup (gdb->so_name));
787 *gdb_link = gdb->next;
789 /* Unless the user loaded it explicitly, free SO's objfile. */
790 if (gdb->objfile && ! (gdb->objfile->flags & OBJF_USERLOADED)
791 && !solib_used (gdb))
792 free_objfile (gdb->objfile);
794 /* Some targets' section tables might be referring to
795 sections from so->abfd; remove them. */
796 remove_target_sections (gdb);
803 /* Now the inferior's list contains only shared objects that don't
804 appear in GDB's list --- those that are newly loaded. Add them
805 to GDB's shared object list. */
809 const char *not_found_filename = NULL;
813 /* Add the new shared objects to GDB's list. */
814 *gdb_link = inferior;
816 /* Fill in the rest of each of the `struct so_list' nodes. */
817 for (i = inferior; i; i = i->next)
820 i->pspace = current_program_space;
821 VEC_safe_push (so_list_ptr, current_program_space->added_solibs, i);
825 /* Fill in the rest of the `struct so_list' node. */
826 if (!solib_map_sections (i))
829 if (not_found_filename == NULL)
830 not_found_filename = i->so_original_name;
834 CATCH (e, RETURN_MASK_ERROR)
836 exception_fprintf (gdb_stderr, e,
837 _("Error while mapping shared "
838 "library sections:\n"));
842 /* Notify any observer that the shared object has been
843 loaded now that we've added it to GDB's tables. */
844 observer_notify_solib_loaded (i);
847 /* If a library was not found, issue an appropriate warning
848 message. We have to use a single call to warning in case the
849 front end does something special with warnings, e.g., pop up
850 a dialog box. It Would Be Nice if we could get a "warning: "
851 prefix on each line in the CLI front end, though - it doesn't
855 warning (_("Could not load shared library symbols for %s.\n"
856 "Do you need \"set solib-search-path\" "
857 "or \"set sysroot\"?"),
859 else if (not_found > 1)
861 Could not load shared library symbols for %d libraries, e.g. %s.\n\
862 Use the \"info sharedlibrary\" command to see the complete listing.\n\
863 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
864 not_found, not_found_filename);
869 /* Return non-zero if NAME is the libpthread shared library.
871 Uses a fairly simplistic heuristic approach where we check
872 the file name against "/libpthread". This can lead to false
873 positives, but this should be good enough in practice. */
876 libpthread_name_p (const char *name)
878 return (strstr (name, "/libpthread") != NULL);
881 /* Return non-zero if SO is the libpthread shared library. */
884 libpthread_solib_p (struct so_list *so)
886 return libpthread_name_p (so->so_name);
889 /* Read in symbolic information for any shared objects whose names
890 match PATTERN. (If we've already read a shared object's symbol
891 info, leave it alone.) If PATTERN is zero, read them all.
893 If READSYMS is 0, defer reading symbolic information until later
894 but still do any needed low level processing.
896 FROM_TTY and TARGET are as described for update_solib_list, above. */
899 solib_add (const char *pattern, int from_tty,
900 struct target_ops *target, int readsyms)
904 if (print_symbol_loading_p (from_tty, 0, 0))
908 printf_unfiltered (_("Loading symbols for shared libraries: %s\n"),
912 printf_unfiltered (_("Loading symbols for shared libraries.\n"));
915 current_program_space->solib_add_generation++;
919 char *re_err = re_comp (pattern);
922 error (_("Invalid regexp: %s"), re_err);
925 update_solib_list (from_tty, target);
927 /* Walk the list of currently loaded shared libraries, and read
928 symbols for any that match the pattern --- or any whose symbols
929 aren't already loaded, if no pattern was given. */
932 int loaded_any_symbols = 0;
934 SYMFILE_DEFER_BP_RESET | (from_tty ? SYMFILE_VERBOSE : 0);
936 for (gdb = so_list_head; gdb; gdb = gdb->next)
937 if (! pattern || re_exec (gdb->so_name))
939 /* Normally, we would read the symbols from that library
940 only if READSYMS is set. However, we're making a small
941 exception for the pthread library, because we sometimes
942 need the library symbols to be loaded in order to provide
943 thread support (x86-linux for instance). */
944 const int add_this_solib =
945 (readsyms || libpthread_solib_p (gdb));
950 if (gdb->symbols_loaded)
952 /* If no pattern was given, be quiet for shared
953 libraries we have already loaded. */
954 if (pattern && (from_tty || info_verbose))
955 printf_unfiltered (_("Symbols already loaded for %s\n"),
958 else if (solib_read_symbols (gdb, flags))
959 loaded_any_symbols = 1;
963 if (loaded_any_symbols)
964 breakpoint_re_set ();
966 if (from_tty && pattern && ! any_matches)
968 ("No loaded shared libraries match the pattern `%s'.\n", pattern);
970 if (loaded_any_symbols)
972 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
974 /* Getting new symbols may change our opinion about what is
976 reinit_frame_cache ();
978 ops->special_symbol_handling ();
983 /* Implement the "info sharedlibrary" command. Walk through the
984 shared library list and print information about each attached
985 library matching PATTERN. If PATTERN is elided, print them
989 info_sharedlibrary_command (char *pattern, int from_tty)
991 struct so_list *so = NULL; /* link map state variable */
992 int so_missing_debug_info = 0;
995 struct cleanup *table_cleanup;
996 struct gdbarch *gdbarch = target_gdbarch ();
997 struct ui_out *uiout = current_uiout;
1001 char *re_err = re_comp (pattern);
1004 error (_("Invalid regexp: %s"), re_err);
1007 /* "0x", a little whitespace, and two hex digits per byte of pointers. */
1008 addr_width = 4 + (gdbarch_ptr_bit (gdbarch) / 4);
1010 update_solib_list (from_tty, 0);
1012 /* make_cleanup_ui_out_table_begin_end needs to know the number of
1013 rows, so we need to make two passes over the libs. */
1015 for (nr_libs = 0, so = so_list_head; so; so = so->next)
1019 if (pattern && ! re_exec (so->so_name))
1026 make_cleanup_ui_out_table_begin_end (uiout, 4, nr_libs,
1027 "SharedLibraryTable");
1029 /* The "- 1" is because ui_out adds one space between columns. */
1030 ui_out_table_header (uiout, addr_width - 1, ui_left, "from", "From");
1031 ui_out_table_header (uiout, addr_width - 1, ui_left, "to", "To");
1032 ui_out_table_header (uiout, 12 - 1, ui_left, "syms-read", "Syms Read");
1033 ui_out_table_header (uiout, 0, ui_noalign,
1034 "name", "Shared Object Library");
1036 ui_out_table_body (uiout);
1038 for (so = so_list_head; so; so = so->next)
1040 struct cleanup *lib_cleanup;
1042 if (! so->so_name[0])
1044 if (pattern && ! re_exec (so->so_name))
1047 lib_cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, "lib");
1049 if (so->addr_high != 0)
1051 ui_out_field_core_addr (uiout, "from", gdbarch, so->addr_low);
1052 ui_out_field_core_addr (uiout, "to", gdbarch, so->addr_high);
1056 ui_out_field_skip (uiout, "from");
1057 ui_out_field_skip (uiout, "to");
1060 if (! ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ()))
1061 && so->symbols_loaded
1062 && !objfile_has_symbols (so->objfile))
1064 so_missing_debug_info = 1;
1065 ui_out_field_string (uiout, "syms-read", "Yes (*)");
1068 ui_out_field_string (uiout, "syms-read",
1069 so->symbols_loaded ? "Yes" : "No");
1071 ui_out_field_string (uiout, "name", so->so_name);
1073 ui_out_text (uiout, "\n");
1075 do_cleanups (lib_cleanup);
1078 do_cleanups (table_cleanup);
1083 ui_out_message (uiout, 0,
1084 _("No shared libraries matched.\n"));
1086 ui_out_message (uiout, 0,
1087 _("No shared libraries loaded at this time.\n"));
1091 if (so_missing_debug_info)
1092 ui_out_message (uiout, 0,
1093 _("(*): Shared library is missing "
1094 "debugging information.\n"));
1098 /* Return 1 if ADDRESS lies within SOLIB. */
1101 solib_contains_address_p (const struct so_list *const solib,
1104 struct target_section *p;
1106 for (p = solib->sections; p < solib->sections_end; p++)
1107 if (p->addr <= address && address < p->endaddr)
1113 /* If ADDRESS is in a shared lib in program space PSPACE, return its
1116 Provides a hook for other gdb routines to discover whether or not a
1117 particular address is within the mapped address space of a shared
1120 For example, this routine is called at one point to disable
1121 breakpoints which are in shared libraries that are not currently
1125 solib_name_from_address (struct program_space *pspace, CORE_ADDR address)
1127 struct so_list *so = NULL;
1129 for (so = pspace->so_list; so; so = so->next)
1130 if (solib_contains_address_p (so, address))
1131 return (so->so_name);
1136 /* Return whether the data starting at VADDR, size SIZE, must be kept
1137 in a core file for shared libraries loaded before "gcore" is used
1138 to be handled correctly when the core file is loaded. This only
1139 applies when the section would otherwise not be kept in the core
1140 file (in particular, for readonly sections). */
1143 solib_keep_data_in_core (CORE_ADDR vaddr, unsigned long size)
1145 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1147 if (ops->keep_data_in_core)
1148 return ops->keep_data_in_core (vaddr, size);
1153 /* Called by free_all_symtabs */
1158 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1160 /* This function is expected to handle ELF shared libraries. It is
1161 also used on Solaris, which can run either ELF or a.out binaries
1162 (for compatibility with SunOS 4), both of which can use shared
1163 libraries. So we don't know whether we have an ELF executable or
1164 an a.out executable until the user chooses an executable file.
1166 ELF shared libraries don't get mapped into the address space
1167 until after the program starts, so we'd better not try to insert
1168 breakpoints in them immediately. We have to wait until the
1169 dynamic linker has loaded them; we'll hit a bp_shlib_event
1170 breakpoint (look for calls to create_solib_event_breakpoint) when
1173 SunOS shared libraries seem to be different --- they're present
1174 as soon as the process begins execution, so there's no need to
1175 put off inserting breakpoints. There's also nowhere to put a
1176 bp_shlib_event breakpoint, so if we put it off, we'll never get
1179 So: disable breakpoints only if we're using ELF shared libs. */
1180 if (exec_bfd != NULL
1181 && bfd_get_flavour (exec_bfd) != bfd_target_aout_flavour)
1182 disable_breakpoints_in_shlibs ();
1184 while (so_list_head)
1186 struct so_list *so = so_list_head;
1188 so_list_head = so->next;
1189 observer_notify_solib_unloaded (so);
1190 remove_target_sections (so);
1194 ops->clear_solib ();
1197 /* Shared library startup support. When GDB starts up the inferior,
1198 it nurses it along (through the shell) until it is ready to execute
1199 its first instruction. At this point, this function gets
1203 solib_create_inferior_hook (int from_tty)
1205 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1207 ops->solib_create_inferior_hook (from_tty);
1210 /* Check to see if an address is in the dynamic loader's dynamic
1211 symbol resolution code. Return 1 if so, 0 otherwise. */
1214 in_solib_dynsym_resolve_code (CORE_ADDR pc)
1216 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1218 return ops->in_dynsym_resolve_code (pc);
1221 /* Implements the "sharedlibrary" command. */
1224 sharedlibrary_command (char *args, int from_tty)
1227 solib_add (args, from_tty, (struct target_ops *) 0, 1);
1230 /* Implements the command "nosharedlibrary", which discards symbols
1231 that have been auto-loaded from shared libraries. Symbols from
1232 shared libraries that were added by explicit request of the user
1233 are not discarded. Also called from remote.c. */
1236 no_shared_libraries (char *ignored, int from_tty)
1238 /* The order of the two routines below is important: clear_solib notifies
1239 the solib_unloaded observers, and some of these observers might need
1240 access to their associated objfiles. Therefore, we can not purge the
1241 solibs' objfiles before clear_solib has been called. */
1244 objfile_purge_solibs ();
1250 update_solib_breakpoints (void)
1252 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1254 if (ops->update_breakpoints != NULL)
1255 ops->update_breakpoints ();
1261 handle_solib_event (void)
1263 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1265 if (ops->handle_event != NULL)
1266 ops->handle_event ();
1268 clear_program_space_solib_cache (current_inferior ()->pspace);
1270 /* Check for any newly added shared libraries if we're supposed to
1271 be adding them automatically. Switch terminal for any messages
1272 produced by breakpoint_re_set. */
1273 target_terminal_ours_for_output ();
1274 solib_add (NULL, 0, ¤t_target, auto_solib_add);
1275 target_terminal_inferior ();
1278 /* Reload shared libraries, but avoid reloading the same symbol file
1279 we already have loaded. */
1282 reload_shared_libraries_1 (int from_tty)
1285 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
1287 if (print_symbol_loading_p (from_tty, 0, 0))
1288 printf_unfiltered (_("Loading symbols for shared libraries.\n"));
1290 for (so = so_list_head; so != NULL; so = so->next)
1292 char *filename, *found_pathname = NULL;
1294 int was_loaded = so->symbols_loaded;
1296 SYMFILE_DEFER_BP_RESET | (from_tty ? SYMFILE_VERBOSE : 0);
1298 filename = tilde_expand (so->so_original_name);
1299 make_cleanup (xfree, filename);
1300 abfd = solib_bfd_open (filename);
1303 found_pathname = xstrdup (bfd_get_filename (abfd));
1304 make_cleanup (xfree, found_pathname);
1305 gdb_bfd_unref (abfd);
1308 /* If this shared library is no longer associated with its previous
1309 symbol file, close that. */
1310 if ((found_pathname == NULL && was_loaded)
1311 || (found_pathname != NULL
1312 && filename_cmp (found_pathname, so->so_name) != 0))
1314 if (so->objfile && ! (so->objfile->flags & OBJF_USERLOADED)
1315 && !solib_used (so))
1316 free_objfile (so->objfile);
1317 remove_target_sections (so);
1321 /* If this shared library is now associated with a new symbol
1323 if (found_pathname != NULL
1325 || filename_cmp (found_pathname, so->so_name) != 0))
1331 solib_map_sections (so);
1334 CATCH (e, RETURN_MASK_ERROR)
1336 exception_fprintf (gdb_stderr, e,
1337 _("Error while mapping "
1338 "shared library sections:\n"));
1344 && (auto_solib_add || was_loaded || libpthread_solib_p (so)))
1345 solib_read_symbols (so, flags);
1349 do_cleanups (old_chain);
1353 reload_shared_libraries (char *ignored, int from_tty,
1354 struct cmd_list_element *e)
1356 const struct target_so_ops *ops;
1358 reload_shared_libraries_1 (from_tty);
1360 ops = solib_ops (target_gdbarch ());
1362 /* Creating inferior hooks here has two purposes. First, if we reload
1363 shared libraries then the address of solib breakpoint we've computed
1364 previously might be no longer valid. For example, if we forgot to set
1365 solib-absolute-prefix and are setting it right now, then the previous
1366 breakpoint address is plain wrong. Second, installing solib hooks
1367 also implicitly figures were ld.so is and loads symbols for it.
1368 Absent this call, if we've just connected to a target and set
1369 solib-absolute-prefix or solib-search-path, we'll lose all information
1371 if (target_has_execution)
1373 /* Reset or free private data structures not associated with
1375 ops->clear_solib ();
1377 /* Remove any previous solib event breakpoint. This is usually
1378 done in common code, at breakpoint_init_inferior time, but
1379 we're not really starting up the inferior here. */
1380 remove_solib_event_breakpoints ();
1382 solib_create_inferior_hook (from_tty);
1385 /* Sometimes the platform-specific hook loads initial shared
1386 libraries, and sometimes it doesn't. If it doesn't FROM_TTY will be
1387 incorrectly 0 but such solib targets should be fixed anyway. If we
1388 made all the inferior hook methods consistent, this call could be
1389 removed. Call it only after the solib target has been initialized by
1390 solib_create_inferior_hook. */
1392 solib_add (NULL, 0, NULL, auto_solib_add);
1394 breakpoint_re_set ();
1396 /* We may have loaded or unloaded debug info for some (or all)
1397 shared libraries. However, frames may still reference them. For
1398 example, a frame's unwinder might still point at DWARF FDE
1399 structures that are now freed. Also, getting new symbols may
1400 change our opinion about what is frameless. */
1401 reinit_frame_cache ();
1403 ops->special_symbol_handling ();
1407 show_auto_solib_add (struct ui_file *file, int from_tty,
1408 struct cmd_list_element *c, const char *value)
1410 fprintf_filtered (file, _("Autoloading of shared library symbols is %s.\n"),
1415 /* Handler for library-specific lookup of global symbol NAME in OBJFILE. Call
1416 the library-specific handler if it is installed for the current target. */
1419 solib_global_lookup (struct objfile *objfile,
1421 const domain_enum domain)
1423 const struct target_so_ops *ops = solib_ops (get_objfile_arch (objfile));
1425 if (ops->lookup_lib_global_symbol != NULL)
1426 return ops->lookup_lib_global_symbol (objfile, name, domain);
1430 /* Lookup the value for a specific symbol from dynamic symbol table. Look
1431 up symbol from ABFD. MATCH_SYM is a callback function to determine
1432 whether to pick up a symbol. DATA is the input of this callback
1433 function. Return NULL if symbol is not found. */
1436 gdb_bfd_lookup_symbol_from_symtab (bfd *abfd,
1437 int (*match_sym) (asymbol *, void *),
1440 long storage_needed = bfd_get_symtab_upper_bound (abfd);
1441 CORE_ADDR symaddr = 0;
1443 if (storage_needed > 0)
1447 asymbol **symbol_table = (asymbol **) xmalloc (storage_needed);
1448 struct cleanup *back_to = make_cleanup (xfree, symbol_table);
1449 unsigned int number_of_symbols =
1450 bfd_canonicalize_symtab (abfd, symbol_table);
1452 for (i = 0; i < number_of_symbols; i++)
1454 asymbol *sym = *symbol_table++;
1456 if (match_sym (sym, data))
1458 struct gdbarch *gdbarch = target_gdbarch ();
1459 symaddr = sym->value;
1461 /* Some ELF targets fiddle with addresses of symbols they
1462 consider special. They use minimal symbols to do that
1463 and this is needed for correct breakpoint placement,
1464 but we do not have full data here to build a complete
1465 minimal symbol, so just set the address and let the
1466 targets cope with that. */
1467 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour
1468 && gdbarch_elf_make_msymbol_special_p (gdbarch))
1470 struct minimal_symbol msym;
1472 memset (&msym, 0, sizeof (msym));
1473 SET_MSYMBOL_VALUE_ADDRESS (&msym, symaddr);
1474 gdbarch_elf_make_msymbol_special (gdbarch, sym, &msym);
1475 symaddr = MSYMBOL_VALUE_RAW_ADDRESS (&msym);
1478 /* BFD symbols are section relative. */
1479 symaddr += sym->section->vma;
1483 do_cleanups (back_to);
1489 /* Lookup the value for a specific symbol from symbol table. Look up symbol
1490 from ABFD. MATCH_SYM is a callback function to determine whether to pick
1491 up a symbol. DATA is the input of this callback function. Return NULL
1492 if symbol is not found. */
1495 bfd_lookup_symbol_from_dyn_symtab (bfd *abfd,
1496 int (*match_sym) (asymbol *, void *),
1499 long storage_needed = bfd_get_dynamic_symtab_upper_bound (abfd);
1500 CORE_ADDR symaddr = 0;
1502 if (storage_needed > 0)
1505 asymbol **symbol_table = (asymbol **) xmalloc (storage_needed);
1506 struct cleanup *back_to = make_cleanup (xfree, symbol_table);
1507 unsigned int number_of_symbols =
1508 bfd_canonicalize_dynamic_symtab (abfd, symbol_table);
1510 for (i = 0; i < number_of_symbols; i++)
1512 asymbol *sym = *symbol_table++;
1514 if (match_sym (sym, data))
1516 /* BFD symbols are section relative. */
1517 symaddr = sym->value + sym->section->vma;
1521 do_cleanups (back_to);
1526 /* Lookup the value for a specific symbol from symbol table and dynamic
1527 symbol table. Look up symbol from ABFD. MATCH_SYM is a callback
1528 function to determine whether to pick up a symbol. DATA is the
1529 input of this callback function. Return NULL if symbol is not
1533 gdb_bfd_lookup_symbol (bfd *abfd,
1534 int (*match_sym) (asymbol *, void *),
1537 CORE_ADDR symaddr = gdb_bfd_lookup_symbol_from_symtab (abfd, match_sym, data);
1539 /* On FreeBSD, the dynamic linker is stripped by default. So we'll
1540 have to check the dynamic string table too. */
1542 symaddr = bfd_lookup_symbol_from_dyn_symtab (abfd, match_sym, data);
1547 /* SO_LIST_HEAD may contain user-loaded object files that can be removed
1548 out-of-band by the user. So upon notification of free_objfile remove
1549 all references to any user-loaded file that is about to be freed. */
1552 remove_user_added_objfile (struct objfile *objfile)
1556 if (objfile != 0 && objfile->flags & OBJF_USERLOADED)
1558 for (so = so_list_head; so != NULL; so = so->next)
1559 if (so->objfile == objfile)
1564 extern initialize_file_ftype _initialize_solib; /* -Wmissing-prototypes */
1567 _initialize_solib (void)
1569 solib_data = gdbarch_data_register_pre_init (solib_init);
1571 observer_attach_free_objfile (remove_user_added_objfile);
1573 add_com ("sharedlibrary", class_files, sharedlibrary_command,
1574 _("Load shared object library symbols for files matching REGEXP."));
1575 add_info ("sharedlibrary", info_sharedlibrary_command,
1576 _("Status of loaded shared object libraries."));
1577 add_com ("nosharedlibrary", class_files, no_shared_libraries,
1578 _("Unload all shared object library symbols."));
1580 add_setshow_boolean_cmd ("auto-solib-add", class_support,
1581 &auto_solib_add, _("\
1582 Set autoloading of shared library symbols."), _("\
1583 Show autoloading of shared library symbols."), _("\
1584 If \"on\", symbols from all shared object libraries will be loaded\n\
1585 automatically when the inferior begins execution, when the dynamic linker\n\
1586 informs gdb that a new library has been loaded, or when attaching to the\n\
1587 inferior. Otherwise, symbols must be loaded manually, using \
1590 show_auto_solib_add,
1591 &setlist, &showlist);
1593 add_setshow_optional_filename_cmd ("sysroot", class_support,
1595 Set an alternate system root."), _("\
1596 Show the current system root."), _("\
1597 The system root is used to load absolute shared library symbol files.\n\
1598 For other (relative) files, you can add directories using\n\
1599 `set solib-search-path'."),
1600 reload_shared_libraries,
1602 &setlist, &showlist);
1604 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1606 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1609 add_setshow_optional_filename_cmd ("solib-search-path", class_support,
1610 &solib_search_path, _("\
1611 Set the search path for loading non-absolute shared library symbol files."),
1613 Show the search path for loading non-absolute shared library symbol files."),
1615 This takes precedence over the environment variables \
1616 PATH and LD_LIBRARY_PATH."),
1617 reload_shared_libraries,
1618 show_solib_search_path,
1619 &setlist, &showlist);