1 /* Handle shared libraries for GDB, the GNU Debugger.
3 Copyright (C) 1990-2018 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 */
41 #include "observable.h"
42 #include "readline/readline.h"
46 #include "filesystem.h"
48 #include "filestuff.h"
51 /* Architecture-specific operations. */
53 /* Per-architecture data key. */
54 static struct gdbarch_data *solib_data;
57 solib_init (struct obstack *obstack)
59 struct target_so_ops **ops;
61 ops = OBSTACK_ZALLOC (obstack, struct target_so_ops *);
62 *ops = current_target_so_ops;
66 static const struct target_so_ops *
67 solib_ops (struct gdbarch *gdbarch)
69 const struct target_so_ops **ops
70 = (const struct target_so_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
81 = (const struct target_so_ops **) gdbarch_data (gdbarch, solib_data);
87 /* external data declarations */
89 /* FIXME: gdbarch needs to control this variable, or else every
90 configuration needs to call set_solib_ops. */
91 struct target_so_ops *current_target_so_ops;
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 /* Return the full pathname of a binary file (the main executable or a
116 shared library file), or NULL if not found. If FD is non-NULL, *FD
117 is set to either -1 or an open file handle for the binary file.
119 Global variable GDB_SYSROOT is used as a prefix directory
120 to search for binary files if they have an absolute path.
121 If GDB_SYSROOT starts with "target:" and target filesystem
122 is the local filesystem then the "target:" prefix will be
123 stripped before the search starts. This ensures that the
124 same search algorithm is used for local files regardless of
125 whether a "target:" prefix was used.
127 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
128 (or set of directories, as in LD_LIBRARY_PATH) to search for all
129 shared libraries if not found in either the sysroot (if set) or
130 the local filesystem. SOLIB_SEARCH_PATH is not used when searching
131 for the main executable.
134 * If a sysroot is set and path is absolute:
135 * Search for sysroot/path.
137 * Look for it literally (unmodified).
138 * If IS_SOLIB is non-zero:
139 * Look in SOLIB_SEARCH_PATH.
140 * If available, use target defined search function.
141 * If NO sysroot is set, perform the following two searches:
142 * Look in inferior's $PATH.
143 * If IS_SOLIB is non-zero:
144 * Look in inferior's $LD_LIBRARY_PATH.
146 * The last check avoids doing this search when targetting remote
147 * machines since a sysroot will almost always be set.
150 static gdb::unique_xmalloc_ptr<char>
151 solib_find_1 (const char *in_pathname, int *fd, int is_solib)
153 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
155 gdb::unique_xmalloc_ptr<char> temp_pathname;
156 const char *fskind = effective_target_file_system_kind ();
157 const char *sysroot = gdb_sysroot;
158 int prefix_len, orig_prefix_len;
160 /* If the absolute prefix starts with "target:" but the filesystem
161 accessed by the target_fileio_* methods is the local filesystem
162 then we strip the "target:" prefix now and work with the local
163 filesystem. This ensures that the same search algorithm is used
164 for all local files regardless of whether a "target:" prefix was
166 if (is_target_filename (sysroot) && target_filesystem_is_local ())
167 sysroot += strlen (TARGET_SYSROOT_PREFIX);
169 /* Strip any trailing slashes from the absolute prefix. */
170 prefix_len = orig_prefix_len = strlen (sysroot);
172 while (prefix_len > 0 && IS_DIR_SEPARATOR (sysroot[prefix_len - 1]))
175 std::string sysroot_holder;
178 else if (prefix_len != orig_prefix_len)
180 sysroot_holder = std::string (sysroot, prefix_len);
181 sysroot = sysroot_holder.c_str ();
184 /* If we're on a non-DOS-based system, backslashes won't be
185 understood as directory separator, so, convert them to forward
186 slashes, iff we're supposed to handle DOS-based file system
187 semantics for target paths. */
188 if (!DOS_BASED_FILE_SYSTEM && fskind == file_system_kind_dos_based)
192 /* Avoid clobbering our input. */
193 p = (char *) alloca (strlen (in_pathname) + 1);
194 strcpy (p, in_pathname);
204 /* Note, we're interested in IS_TARGET_ABSOLUTE_PATH, not
205 IS_ABSOLUTE_PATH. The latter is for host paths only, while
206 IN_PATHNAME is a target path. For example, if we're supposed to
207 be handling DOS-like semantics we want to consider a
208 'c:/foo/bar.dll' path as an absolute path, even on a Unix box.
209 With such a path, before giving up on the sysroot, we'll try:
211 1st attempt, c:/foo/bar.dll ==> /sysroot/c:/foo/bar.dll
212 2nd attempt, c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll
213 3rd attempt, c:/foo/bar.dll ==> /sysroot/foo/bar.dll
216 if (!IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname) || sysroot == NULL)
217 temp_pathname.reset (xstrdup (in_pathname));
220 int need_dir_separator;
222 /* Concatenate the sysroot and the target reported filename. We
223 may need to glue them with a directory separator. Cases to
226 | sysroot | separator | in_pathname |
227 |-----------------+-----------+----------------|
228 | /some/dir | / | c:/foo/bar.dll |
229 | /some/dir | | /foo/bar.dll |
230 | target: | | c:/foo/bar.dll |
231 | target: | | /foo/bar.dll |
232 | target:some/dir | / | c:/foo/bar.dll |
233 | target:some/dir | | /foo/bar.dll |
235 IOW, we don't need to add a separator if IN_PATHNAME already
236 has one, or when the the sysroot is exactly "target:".
237 There's no need to check for drive spec explicitly, as we only
238 get here if IN_PATHNAME is considered an absolute path. */
239 need_dir_separator = !(IS_DIR_SEPARATOR (in_pathname[0])
240 || strcmp (TARGET_SYSROOT_PREFIX, sysroot) == 0);
242 /* Cat the prefixed pathname together. */
243 temp_pathname.reset (concat (sysroot,
244 need_dir_separator ? SLASH_STRING : "",
245 in_pathname, (char *) NULL));
248 /* Handle files to be accessed via the target. */
249 if (is_target_filename (temp_pathname.get ()))
253 return temp_pathname;
256 /* Now see if we can open it. */
257 found_file = gdb_open_cloexec (temp_pathname.get (), O_RDONLY | O_BINARY, 0);
259 /* If the search in gdb_sysroot failed, and the path name has a
260 drive spec (e.g, c:/foo), try stripping ':' from the drive spec,
261 and retrying in the sysroot:
262 c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll. */
266 && HAS_TARGET_DRIVE_SPEC (fskind, in_pathname))
268 int need_dir_separator = !IS_DIR_SEPARATOR (in_pathname[2]);
269 char drive[2] = { in_pathname[0], '\0' };
271 temp_pathname.reset (concat (sysroot,
274 need_dir_separator ? SLASH_STRING : "",
275 in_pathname + 2, (char *) NULL));
277 found_file = gdb_open_cloexec (temp_pathname.get (),
278 O_RDONLY | O_BINARY, 0);
281 /* If the search in gdb_sysroot still failed, try fully
282 stripping the drive spec, and trying once more in the
283 sysroot before giving up.
285 c:/foo/bar.dll ==> /sysroot/foo/bar.dll. */
287 temp_pathname.reset (concat (sysroot,
288 need_dir_separator ? SLASH_STRING : "",
289 in_pathname + 2, (char *) NULL));
291 found_file = gdb_open_cloexec (temp_pathname.get (),
292 O_RDONLY | O_BINARY, 0);
296 /* We try to find the library in various ways. After each attempt,
297 either found_file >= 0 and temp_pathname is a malloc'd string, or
298 found_file < 0 and temp_pathname does not point to storage that
299 needs to be freed. */
302 temp_pathname.reset (NULL);
304 /* If the search in gdb_sysroot failed, and the path name is
305 absolute at this point, make it relative. (openp will try and open the
306 file according to its absolute path otherwise, which is not what we want.)
307 Affects subsequent searches for this solib. */
308 if (found_file < 0 && IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname))
310 /* First, get rid of any drive letters etc. */
311 while (!IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
314 /* Next, get rid of all leading dir separators. */
315 while (IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
319 /* If not found, and we're looking for a solib, search the
320 solib_search_path (if any). */
321 if (is_solib && found_file < 0 && solib_search_path != NULL)
322 found_file = openp (solib_search_path,
323 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
324 in_pathname, O_RDONLY | O_BINARY, &temp_pathname);
326 /* If not found, and we're looking for a solib, next search the
327 solib_search_path (if any) for the basename only (ignoring the
328 path). This is to allow reading solibs from a path that differs
329 from the opened path. */
330 if (is_solib && found_file < 0 && solib_search_path != NULL)
331 found_file = openp (solib_search_path,
332 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
333 target_lbasename (fskind, in_pathname),
334 O_RDONLY | O_BINARY, &temp_pathname);
336 /* If not found, and we're looking for a solib, try to use target
337 supplied solib search method. */
338 if (is_solib && found_file < 0 && ops->find_and_open_solib)
339 found_file = ops->find_and_open_solib (in_pathname, O_RDONLY | O_BINARY,
342 /* If not found, next search the inferior's $PATH environment variable. */
343 if (found_file < 0 && sysroot == NULL)
344 found_file = openp (current_inferior ()->environment.get ("PATH"),
345 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
346 O_RDONLY | O_BINARY, &temp_pathname);
348 /* If not found, and we're looking for a solib, next search the
349 inferior's $LD_LIBRARY_PATH environment variable. */
350 if (is_solib && found_file < 0 && sysroot == NULL)
351 found_file = openp (current_inferior ()->environment.get
353 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
354 O_RDONLY | O_BINARY, &temp_pathname);
364 return temp_pathname;
367 /* Return the full pathname of the main executable, or NULL if not
368 found. If FD is non-NULL, *FD is set to either -1 or an open file
369 handle for the main executable. */
371 gdb::unique_xmalloc_ptr<char>
372 exec_file_find (const char *in_pathname, int *fd)
374 gdb::unique_xmalloc_ptr<char> result;
375 const char *fskind = effective_target_file_system_kind ();
377 if (in_pathname == NULL)
380 if (*gdb_sysroot != '\0' && IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname))
382 result = solib_find_1 (in_pathname, fd, 0);
384 if (result == NULL && fskind == file_system_kind_dos_based)
388 new_pathname = (char *) alloca (strlen (in_pathname) + 5);
389 strcpy (new_pathname, in_pathname);
390 strcat (new_pathname, ".exe");
392 result = solib_find_1 (new_pathname, fd, 0);
397 /* It's possible we don't have a full path, but rather just a
398 filename. Some targets, such as HP-UX, don't provide the
401 Attempt to qualify the filename against the source path.
402 (If that fails, we'll just fall back on the original
403 filename. Not much more we can do...) */
405 if (!source_full_path_of (in_pathname, &result))
406 result.reset (xstrdup (in_pathname));
414 /* Return the full pathname of a shared library file, or NULL if not
415 found. If FD is non-NULL, *FD is set to either -1 or an open file
416 handle for the shared library.
418 The search algorithm used is described in solib_find_1's comment
421 gdb::unique_xmalloc_ptr<char>
422 solib_find (const char *in_pathname, int *fd)
424 const char *solib_symbols_extension
425 = gdbarch_solib_symbols_extension (target_gdbarch ());
427 /* If solib_symbols_extension is set, replace the file's
429 if (solib_symbols_extension != NULL)
431 const char *p = in_pathname + strlen (in_pathname);
433 while (p > in_pathname && *p != '.')
441 = (char *) alloca (p - in_pathname + 1
442 + strlen (solib_symbols_extension) + 1);
443 memcpy (new_pathname, in_pathname, p - in_pathname + 1);
444 strcpy (new_pathname + (p - in_pathname) + 1,
445 solib_symbols_extension);
447 in_pathname = new_pathname;
451 return solib_find_1 (in_pathname, fd, 1);
454 /* Open and return a BFD for the shared library PATHNAME. If FD is not -1,
455 it is used as file handle to open the file. Throws an error if the file
456 could not be opened. Handles both local and remote file access.
458 If unsuccessful, the FD will be closed (unless FD was -1). */
461 solib_bfd_fopen (const char *pathname, int fd)
463 gdb_bfd_ref_ptr abfd (gdb_bfd_open (pathname, gnutarget, fd));
465 if (abfd != NULL && !gdb_bfd_has_target_filename (abfd.get ()))
466 bfd_set_cacheable (abfd.get (), 1);
470 /* Arrange to free PATHNAME when the error is thrown. */
471 error (_("Could not open `%s' as an executable file: %s"),
472 pathname, bfd_errmsg (bfd_get_error ()));
478 /* Find shared library PATHNAME and open a BFD for it. */
481 solib_bfd_open (const char *pathname)
484 const struct bfd_arch_info *b;
486 /* Search for shared library file. */
487 gdb::unique_xmalloc_ptr<char> found_pathname
488 = solib_find (pathname, &found_file);
489 if (found_pathname == NULL)
491 /* Return failure if the file could not be found, so that we can
492 accumulate messages about missing libraries. */
496 perror_with_name (pathname);
499 /* Open bfd for shared library. */
500 gdb_bfd_ref_ptr abfd (solib_bfd_fopen (found_pathname.get (), found_file));
502 /* Check bfd format. */
503 if (!bfd_check_format (abfd.get (), bfd_object))
504 error (_("`%s': not in executable format: %s"),
505 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
507 /* Check bfd arch. */
508 b = gdbarch_bfd_arch_info (target_gdbarch ());
509 if (!b->compatible (b, bfd_get_arch_info (abfd.get ())))
510 warning (_("`%s': Shared library architecture %s is not compatible "
511 "with target architecture %s."), bfd_get_filename (abfd),
512 bfd_get_arch_info (abfd.get ())->printable_name,
518 /* Given a pointer to one of the shared objects in our list of mapped
519 objects, use the recorded name to open a bfd descriptor for the
520 object, build a section table, relocate all the section addresses
521 by the base address at which the shared object was mapped, and then
522 add the sections to the target's section table.
524 FIXME: In most (all?) cases the shared object file name recorded in
525 the dynamic linkage tables will be a fully qualified pathname. For
526 cases where it isn't, do we really mimic the systems search
527 mechanism correctly in the below code (particularly the tilde
528 expansion stuff?). */
531 solib_map_sections (struct so_list *so)
533 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
534 struct target_section *p;
536 gdb::unique_xmalloc_ptr<char> filename (tilde_expand (so->so_name));
537 gdb_bfd_ref_ptr abfd (ops->bfd_open (filename.get ()));
542 /* Leave bfd open, core_xfer_memory and "info files" need it. */
543 so->abfd = abfd.release ();
545 /* Copy the full path name into so_name, allowing symbol_file_add
546 to find it later. This also affects the =library-loaded GDB/MI
547 event, and in particular the part of that notification providing
548 the library's host-side path. If we let the target dictate
549 that objfile's path, and the target is different from the host,
550 GDB/MI will not provide the correct host-side path. */
551 if (strlen (bfd_get_filename (so->abfd)) >= SO_NAME_MAX_PATH_SIZE)
552 error (_("Shared library file name is too long."));
553 strcpy (so->so_name, bfd_get_filename (so->abfd));
555 if (build_section_table (so->abfd, &so->sections, &so->sections_end))
557 error (_("Can't find the file sections in `%s': %s"),
558 bfd_get_filename (so->abfd), bfd_errmsg (bfd_get_error ()));
561 for (p = so->sections; p < so->sections_end; p++)
563 /* Relocate the section binding addresses as recorded in the shared
564 object's file by the base address to which the object was actually
566 ops->relocate_section_addresses (so, p);
568 /* If the target didn't provide information about the address
569 range of the shared object, assume we want the location of
570 the .text section. */
571 if (so->addr_low == 0 && so->addr_high == 0
572 && strcmp (p->the_bfd_section->name, ".text") == 0)
574 so->addr_low = p->addr;
575 so->addr_high = p->endaddr;
579 /* Add the shared object's sections to the current set of file
580 section tables. Do this immediately after mapping the object so
581 that later nodes in the list can query this object, as is needed
583 add_target_sections (so, so->sections, so->sections_end);
588 /* Free symbol-file related contents of SO and reset for possible reloading
589 of SO. If we have opened a BFD for SO, close it. If we have placed SO's
590 sections in some target's section table, the caller is responsible for
593 This function doesn't mess with objfiles at all. If there is an
594 objfile associated with SO that needs to be removed, the caller is
595 responsible for taking care of that. */
598 clear_so (struct so_list *so)
600 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
604 xfree (so->sections);
605 so->sections = so->sections_end = NULL;
608 gdb_bfd_unref (so->abfd);
611 /* Our caller closed the objfile, possibly via objfile_purge_solibs. */
612 so->symbols_loaded = 0;
615 so->addr_low = so->addr_high = 0;
617 /* Restore the target-supplied file name. SO_NAME may be the path
618 of the symbol file. */
619 strcpy (so->so_name, so->so_original_name);
621 /* Do the same for target-specific data. */
622 if (ops->clear_so != NULL)
626 /* Free the storage associated with the `struct so_list' object SO.
627 If we have opened a BFD for SO, close it.
629 The caller is responsible for removing SO from whatever list it is
630 a member of. If we have placed SO's sections in some target's
631 section table, the caller is responsible for removing them.
633 This function doesn't mess with objfiles at all. If there is an
634 objfile associated with SO that needs to be removed, the caller is
635 responsible for taking care of that. */
638 free_so (struct so_list *so)
640 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
649 /* Return address of first so_list entry in master shared object list. */
651 master_so_list (void)
656 /* Read in symbols for shared object SO. If SYMFILE_VERBOSE is set in FLAGS,
657 be chatty about it. Return non-zero if any symbols were actually
661 solib_read_symbols (struct so_list *so, symfile_add_flags flags)
663 if (so->symbols_loaded)
665 /* If needed, we've already warned in our caller. */
667 else if (so->abfd == NULL)
669 /* We've already warned about this library, when trying to open
675 flags |= current_inferior ()->symfile_flags;
679 /* Have we already loaded this shared object? */
680 ALL_OBJFILES (so->objfile)
682 if (filename_cmp (objfile_name (so->objfile), so->so_name) == 0
683 && so->objfile->addr_low == so->addr_low)
686 if (so->objfile == NULL)
688 section_addr_info sap
689 = build_section_addr_info_from_section_table (so->sections,
691 so->objfile = symbol_file_add_from_bfd (so->abfd, so->so_name,
694 so->objfile->addr_low = so->addr_low;
697 so->symbols_loaded = 1;
699 CATCH (e, RETURN_MASK_ERROR)
701 exception_fprintf (gdb_stderr, e, _("Error while reading shared"
702 " library symbols for %s:\n"),
713 /* Return 1 if KNOWN->objfile is used by any other so_list object in the
714 SO_LIST_HEAD list. Return 0 otherwise. */
717 solib_used (const struct so_list *const known)
719 const struct so_list *pivot;
721 for (pivot = so_list_head; pivot != NULL; pivot = pivot->next)
722 if (pivot != known && pivot->objfile == known->objfile)
730 update_solib_list (int from_tty)
732 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
733 struct so_list *inferior = ops->current_sos();
734 struct so_list *gdb, **gdb_link;
736 /* We can reach here due to changing solib-search-path or the
737 sysroot, before having any inferior. */
738 if (target_has_execution && inferior_ptid != null_ptid)
740 struct inferior *inf = current_inferior ();
742 /* If we are attaching to a running process for which we
743 have not opened a symbol file, we may be able to get its
745 if (inf->attach_flag && symfile_objfile == NULL)
749 ops->open_symbol_file_object (from_tty);
751 CATCH (ex, RETURN_MASK_ALL)
753 exception_fprintf (gdb_stderr, ex,
754 "Error reading attached "
755 "process's symbol file.\n");
761 /* GDB and the inferior's dynamic linker each maintain their own
762 list of currently loaded shared objects; we want to bring the
763 former in sync with the latter. Scan both lists, seeing which
764 shared objects appear where. There are three cases:
766 - A shared object appears on both lists. This means that GDB
767 knows about it already, and it's still loaded in the inferior.
768 Nothing needs to happen.
770 - A shared object appears only on GDB's list. This means that
771 the inferior has unloaded it. We should remove the shared
772 object from GDB's tables.
774 - A shared object appears only on the inferior's list. This
775 means that it's just been loaded. We should add it to GDB's
778 So we walk GDB's list, checking each entry to see if it appears
779 in the inferior's list too. If it does, no action is needed, and
780 we remove it from the inferior's list. If it doesn't, the
781 inferior has unloaded it, and we remove it from GDB's list. By
782 the time we're done walking GDB's list, the inferior's list
783 contains only the new shared objects, which we then add. */
786 gdb_link = &so_list_head;
789 struct so_list *i = inferior;
790 struct so_list **i_link = &inferior;
792 /* Check to see whether the shared object *gdb also appears in
793 the inferior's current list. */
798 if (ops->same (gdb, i))
803 if (! filename_cmp (gdb->so_original_name, i->so_original_name))
811 /* If the shared object appears on the inferior's list too, then
812 it's still loaded, so we don't need to do anything. Delete
813 it from the inferior's list, and leave it on GDB's list. */
818 gdb_link = &gdb->next;
822 /* If it's not on the inferior's list, remove it from GDB's tables. */
825 /* Notify any observer that the shared object has been
826 unloaded before we remove it from GDB's tables. */
827 gdb::observers::solib_unloaded.notify (gdb);
829 current_program_space->deleted_solibs.push_back (gdb->so_name);
831 *gdb_link = gdb->next;
833 /* Unless the user loaded it explicitly, free SO's objfile. */
834 if (gdb->objfile && ! (gdb->objfile->flags & OBJF_USERLOADED)
835 && !solib_used (gdb))
838 /* Some targets' section tables might be referring to
839 sections from so->abfd; remove them. */
840 remove_target_sections (gdb);
847 /* Now the inferior's list contains only shared objects that don't
848 appear in GDB's list --- those that are newly loaded. Add them
849 to GDB's shared object list. */
853 const char *not_found_filename = NULL;
857 /* Add the new shared objects to GDB's list. */
858 *gdb_link = inferior;
860 /* Fill in the rest of each of the `struct so_list' nodes. */
861 for (i = inferior; i; i = i->next)
864 i->pspace = current_program_space;
865 current_program_space->added_solibs.push_back (i);
869 /* Fill in the rest of the `struct so_list' node. */
870 if (!solib_map_sections (i))
873 if (not_found_filename == NULL)
874 not_found_filename = i->so_original_name;
878 CATCH (e, RETURN_MASK_ERROR)
880 exception_fprintf (gdb_stderr, e,
881 _("Error while mapping shared "
882 "library sections:\n"));
886 /* Notify any observer that the shared object has been
887 loaded now that we've added it to GDB's tables. */
888 gdb::observers::solib_loaded.notify (i);
891 /* If a library was not found, issue an appropriate warning
892 message. We have to use a single call to warning in case the
893 front end does something special with warnings, e.g., pop up
894 a dialog box. It Would Be Nice if we could get a "warning: "
895 prefix on each line in the CLI front end, though - it doesn't
899 warning (_("Could not load shared library symbols for %s.\n"
900 "Do you need \"set solib-search-path\" "
901 "or \"set sysroot\"?"),
903 else if (not_found > 1)
905 Could not load shared library symbols for %d libraries, e.g. %s.\n\
906 Use the \"info sharedlibrary\" command to see the complete listing.\n\
907 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
908 not_found, not_found_filename);
913 /* Return non-zero if NAME is the libpthread shared library.
915 Uses a fairly simplistic heuristic approach where we check
916 the file name against "/libpthread". This can lead to false
917 positives, but this should be good enough in practice. */
920 libpthread_name_p (const char *name)
922 return (strstr (name, "/libpthread") != NULL);
925 /* Return non-zero if SO is the libpthread shared library. */
928 libpthread_solib_p (struct so_list *so)
930 return libpthread_name_p (so->so_name);
933 /* Read in symbolic information for any shared objects whose names
934 match PATTERN. (If we've already read a shared object's symbol
935 info, leave it alone.) If PATTERN is zero, read them all.
937 If READSYMS is 0, defer reading symbolic information until later
938 but still do any needed low level processing.
940 FROM_TTY is described for update_solib_list, above. */
943 solib_add (const char *pattern, int from_tty, int readsyms)
947 if (print_symbol_loading_p (from_tty, 0, 0))
951 printf_unfiltered (_("Loading symbols for shared libraries: %s\n"),
955 printf_unfiltered (_("Loading symbols for shared libraries.\n"));
958 current_program_space->solib_add_generation++;
962 char *re_err = re_comp (pattern);
965 error (_("Invalid regexp: %s"), re_err);
968 update_solib_list (from_tty);
970 /* Walk the list of currently loaded shared libraries, and read
971 symbols for any that match the pattern --- or any whose symbols
972 aren't already loaded, if no pattern was given. */
975 int loaded_any_symbols = 0;
976 symfile_add_flags add_flags = SYMFILE_DEFER_BP_RESET;
979 add_flags |= SYMFILE_VERBOSE;
981 for (gdb = so_list_head; gdb; gdb = gdb->next)
982 if (! pattern || re_exec (gdb->so_name))
984 /* Normally, we would read the symbols from that library
985 only if READSYMS is set. However, we're making a small
986 exception for the pthread library, because we sometimes
987 need the library symbols to be loaded in order to provide
988 thread support (x86-linux for instance). */
989 const int add_this_solib =
990 (readsyms || libpthread_solib_p (gdb));
995 if (gdb->symbols_loaded)
997 /* If no pattern was given, be quiet for shared
998 libraries we have already loaded. */
999 if (pattern && (from_tty || info_verbose))
1000 printf_unfiltered (_("Symbols already loaded for %s\n"),
1003 else if (solib_read_symbols (gdb, add_flags))
1004 loaded_any_symbols = 1;
1008 if (loaded_any_symbols)
1009 breakpoint_re_set ();
1011 if (from_tty && pattern && ! any_matches)
1013 ("No loaded shared libraries match the pattern `%s'.\n", pattern);
1015 if (loaded_any_symbols)
1017 /* Getting new symbols may change our opinion about what is
1019 reinit_frame_cache ();
1024 /* Implement the "info sharedlibrary" command. Walk through the
1025 shared library list and print information about each attached
1026 library matching PATTERN. If PATTERN is elided, print them
1030 info_sharedlibrary_command (const char *pattern, int from_tty)
1032 struct so_list *so = NULL; /* link map state variable */
1033 int so_missing_debug_info = 0;
1036 struct gdbarch *gdbarch = target_gdbarch ();
1037 struct ui_out *uiout = current_uiout;
1041 char *re_err = re_comp (pattern);
1044 error (_("Invalid regexp: %s"), re_err);
1047 /* "0x", a little whitespace, and two hex digits per byte of pointers. */
1048 addr_width = 4 + (gdbarch_ptr_bit (gdbarch) / 4);
1050 update_solib_list (from_tty);
1052 /* ui_out_emit_table table_emitter needs to know the number of rows,
1053 so we need to make two passes over the libs. */
1055 for (nr_libs = 0, so = so_list_head; so; so = so->next)
1059 if (pattern && ! re_exec (so->so_name))
1066 ui_out_emit_table table_emitter (uiout, 4, nr_libs, "SharedLibraryTable");
1068 /* The "- 1" is because ui_out adds one space between columns. */
1069 uiout->table_header (addr_width - 1, ui_left, "from", "From");
1070 uiout->table_header (addr_width - 1, ui_left, "to", "To");
1071 uiout->table_header (12 - 1, ui_left, "syms-read", "Syms Read");
1072 uiout->table_header (0, ui_noalign, "name", "Shared Object Library");
1074 uiout->table_body ();
1078 if (! so->so_name[0])
1080 if (pattern && ! re_exec (so->so_name))
1083 ui_out_emit_tuple tuple_emitter (uiout, "lib");
1085 if (so->addr_high != 0)
1087 uiout->field_core_addr ("from", gdbarch, so->addr_low);
1088 uiout->field_core_addr ("to", gdbarch, so->addr_high);
1092 uiout->field_skip ("from");
1093 uiout->field_skip ("to");
1096 if (! top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ()
1097 && so->symbols_loaded
1098 && !objfile_has_symbols (so->objfile))
1100 so_missing_debug_info = 1;
1101 uiout->field_string ("syms-read", "Yes (*)");
1104 uiout->field_string ("syms-read", so->symbols_loaded ? "Yes" : "No");
1106 uiout->field_string ("name", so->so_name);
1115 uiout->message (_("No shared libraries matched.\n"));
1117 uiout->message (_("No shared libraries loaded at this time.\n"));
1121 if (so_missing_debug_info)
1122 uiout->message (_("(*): Shared library is missing "
1123 "debugging information.\n"));
1127 /* Return 1 if ADDRESS lies within SOLIB. */
1130 solib_contains_address_p (const struct so_list *const solib,
1133 struct target_section *p;
1135 for (p = solib->sections; p < solib->sections_end; p++)
1136 if (p->addr <= address && address < p->endaddr)
1142 /* If ADDRESS is in a shared lib in program space PSPACE, return its
1145 Provides a hook for other gdb routines to discover whether or not a
1146 particular address is within the mapped address space of a shared
1149 For example, this routine is called at one point to disable
1150 breakpoints which are in shared libraries that are not currently
1154 solib_name_from_address (struct program_space *pspace, CORE_ADDR address)
1156 struct so_list *so = NULL;
1158 for (so = pspace->so_list; so; so = so->next)
1159 if (solib_contains_address_p (so, address))
1160 return (so->so_name);
1165 /* Return whether the data starting at VADDR, size SIZE, must be kept
1166 in a core file for shared libraries loaded before "gcore" is used
1167 to be handled correctly when the core file is loaded. This only
1168 applies when the section would otherwise not be kept in the core
1169 file (in particular, for readonly sections). */
1172 solib_keep_data_in_core (CORE_ADDR vaddr, unsigned long size)
1174 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1176 if (ops->keep_data_in_core)
1177 return ops->keep_data_in_core (vaddr, size);
1182 /* Called by free_all_symtabs */
1187 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1189 disable_breakpoints_in_shlibs ();
1191 while (so_list_head)
1193 struct so_list *so = so_list_head;
1195 so_list_head = so->next;
1196 gdb::observers::solib_unloaded.notify (so);
1197 remove_target_sections (so);
1201 ops->clear_solib ();
1204 /* Shared library startup support. When GDB starts up the inferior,
1205 it nurses it along (through the shell) until it is ready to execute
1206 its first instruction. At this point, this function gets
1210 solib_create_inferior_hook (int from_tty)
1212 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1214 ops->solib_create_inferior_hook (from_tty);
1217 /* Check to see if an address is in the dynamic loader's dynamic
1218 symbol resolution code. Return 1 if so, 0 otherwise. */
1221 in_solib_dynsym_resolve_code (CORE_ADDR pc)
1223 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1225 return ops->in_dynsym_resolve_code (pc);
1228 /* Implements the "sharedlibrary" command. */
1231 sharedlibrary_command (const char *args, int from_tty)
1234 solib_add (args, from_tty, 1);
1237 /* Implements the command "nosharedlibrary", which discards symbols
1238 that have been auto-loaded from shared libraries. Symbols from
1239 shared libraries that were added by explicit request of the user
1240 are not discarded. Also called from remote.c. */
1243 no_shared_libraries (const char *ignored, int from_tty)
1245 /* The order of the two routines below is important: clear_solib notifies
1246 the solib_unloaded observers, and some of these observers might need
1247 access to their associated objfiles. Therefore, we can not purge the
1248 solibs' objfiles before clear_solib has been called. */
1251 objfile_purge_solibs ();
1257 update_solib_breakpoints (void)
1259 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1261 if (ops->update_breakpoints != NULL)
1262 ops->update_breakpoints ();
1268 handle_solib_event (void)
1270 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1272 if (ops->handle_event != NULL)
1273 ops->handle_event ();
1275 clear_program_space_solib_cache (current_inferior ()->pspace);
1277 /* Check for any newly added shared libraries if we're supposed to
1278 be adding them automatically. Switch terminal for any messages
1279 produced by breakpoint_re_set. */
1280 target_terminal::ours_for_output ();
1281 solib_add (NULL, 0, auto_solib_add);
1282 target_terminal::inferior ();
1285 /* Reload shared libraries, but avoid reloading the same symbol file
1286 we already have loaded. */
1289 reload_shared_libraries_1 (int from_tty)
1293 if (print_symbol_loading_p (from_tty, 0, 0))
1294 printf_unfiltered (_("Loading symbols for shared libraries.\n"));
1296 for (so = so_list_head; so != NULL; so = so->next)
1298 char *found_pathname = NULL;
1299 int was_loaded = so->symbols_loaded;
1300 symfile_add_flags add_flags = SYMFILE_DEFER_BP_RESET;
1303 add_flags |= SYMFILE_VERBOSE;
1305 gdb::unique_xmalloc_ptr<char> filename
1306 (tilde_expand (so->so_original_name));
1307 gdb_bfd_ref_ptr abfd (solib_bfd_open (filename.get ()));
1309 found_pathname = bfd_get_filename (abfd.get ());
1311 /* If this shared library is no longer associated with its previous
1312 symbol file, close that. */
1313 if ((found_pathname == NULL && was_loaded)
1314 || (found_pathname != NULL
1315 && filename_cmp (found_pathname, so->so_name) != 0))
1317 if (so->objfile && ! (so->objfile->flags & OBJF_USERLOADED)
1318 && !solib_used (so))
1320 remove_target_sections (so);
1324 /* If this shared library is now associated with a new symbol
1326 if (found_pathname != NULL
1328 || filename_cmp (found_pathname, so->so_name) != 0))
1334 solib_map_sections (so);
1337 CATCH (e, RETURN_MASK_ERROR)
1339 exception_fprintf (gdb_stderr, e,
1340 _("Error while mapping "
1341 "shared library sections:\n"));
1347 && (auto_solib_add || was_loaded || libpthread_solib_p (so)))
1348 solib_read_symbols (so, add_flags);
1354 reload_shared_libraries (const char *ignored, int from_tty,
1355 struct cmd_list_element *e)
1357 const struct target_so_ops *ops;
1359 reload_shared_libraries_1 (from_tty);
1361 ops = solib_ops (target_gdbarch ());
1363 /* Creating inferior hooks here has two purposes. First, if we reload
1364 shared libraries then the address of solib breakpoint we've computed
1365 previously might be no longer valid. For example, if we forgot to set
1366 solib-absolute-prefix and are setting it right now, then the previous
1367 breakpoint address is plain wrong. Second, installing solib hooks
1368 also implicitly figures were ld.so is and loads symbols for it.
1369 Absent this call, if we've just connected to a target and set
1370 solib-absolute-prefix or solib-search-path, we'll lose all information
1372 if (target_has_execution)
1374 /* Reset or free private data structures not associated with
1376 ops->clear_solib ();
1378 /* Remove any previous solib event breakpoint. This is usually
1379 done in common code, at breakpoint_init_inferior time, but
1380 we're not really starting up the inferior here. */
1381 remove_solib_event_breakpoints ();
1383 solib_create_inferior_hook (from_tty);
1386 /* Sometimes the platform-specific hook loads initial shared
1387 libraries, and sometimes it doesn't. If it doesn't FROM_TTY will be
1388 incorrectly 0 but such solib targets should be fixed anyway. If we
1389 made all the inferior hook methods consistent, this call could be
1390 removed. Call it only after the solib target has been initialized by
1391 solib_create_inferior_hook. */
1393 solib_add (NULL, 0, auto_solib_add);
1395 breakpoint_re_set ();
1397 /* We may have loaded or unloaded debug info for some (or all)
1398 shared libraries. However, frames may still reference them. For
1399 example, a frame's unwinder might still point at DWARF FDE
1400 structures that are now freed. Also, getting new symbols may
1401 change our opinion about what is frameless. */
1402 reinit_frame_cache ();
1405 /* Wrapper for reload_shared_libraries that replaces "remote:"
1406 at the start of gdb_sysroot with "target:". */
1409 gdb_sysroot_changed (const char *ignored, int from_tty,
1410 struct cmd_list_element *e)
1412 const char *old_prefix = "remote:";
1413 const char *new_prefix = TARGET_SYSROOT_PREFIX;
1415 if (startswith (gdb_sysroot, old_prefix))
1417 static int warning_issued = 0;
1419 gdb_assert (strlen (old_prefix) == strlen (new_prefix));
1420 memcpy (gdb_sysroot, new_prefix, strlen (new_prefix));
1422 if (!warning_issued)
1424 warning (_("\"%s\" is deprecated, use \"%s\" instead."),
1425 old_prefix, new_prefix);
1426 warning (_("sysroot set to \"%s\"."), gdb_sysroot);
1432 reload_shared_libraries (ignored, from_tty, e);
1436 show_auto_solib_add (struct ui_file *file, int from_tty,
1437 struct cmd_list_element *c, const char *value)
1439 fprintf_filtered (file, _("Autoloading of shared library symbols is %s.\n"),
1444 /* Handler for library-specific lookup of global symbol NAME in OBJFILE. Call
1445 the library-specific handler if it is installed for the current target. */
1448 solib_global_lookup (struct objfile *objfile,
1450 const domain_enum domain)
1452 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1454 if (ops->lookup_lib_global_symbol != NULL)
1455 return ops->lookup_lib_global_symbol (objfile, name, domain);
1456 return (struct block_symbol) {NULL, NULL};
1459 /* Lookup the value for a specific symbol from dynamic symbol table. Look
1460 up symbol from ABFD. MATCH_SYM is a callback function to determine
1461 whether to pick up a symbol. DATA is the input of this callback
1462 function. Return NULL if symbol is not found. */
1465 gdb_bfd_lookup_symbol_from_symtab (bfd *abfd,
1466 int (*match_sym) (const asymbol *,
1470 long storage_needed = bfd_get_symtab_upper_bound (abfd);
1471 CORE_ADDR symaddr = 0;
1473 if (storage_needed > 0)
1477 gdb::def_vector<asymbol *> storage (storage_needed / sizeof (asymbol *));
1478 asymbol **symbol_table = storage.data ();
1479 unsigned int number_of_symbols =
1480 bfd_canonicalize_symtab (abfd, symbol_table);
1482 for (i = 0; i < number_of_symbols; i++)
1484 asymbol *sym = *symbol_table++;
1486 if (match_sym (sym, data))
1488 struct gdbarch *gdbarch = target_gdbarch ();
1489 symaddr = sym->value;
1491 /* Some ELF targets fiddle with addresses of symbols they
1492 consider special. They use minimal symbols to do that
1493 and this is needed for correct breakpoint placement,
1494 but we do not have full data here to build a complete
1495 minimal symbol, so just set the address and let the
1496 targets cope with that. */
1497 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour
1498 && gdbarch_elf_make_msymbol_special_p (gdbarch))
1500 struct minimal_symbol msym;
1502 memset (&msym, 0, sizeof (msym));
1503 SET_MSYMBOL_VALUE_ADDRESS (&msym, symaddr);
1504 gdbarch_elf_make_msymbol_special (gdbarch, sym, &msym);
1505 symaddr = MSYMBOL_VALUE_RAW_ADDRESS (&msym);
1508 /* BFD symbols are section relative. */
1509 symaddr += sym->section->vma;
1518 /* Lookup the value for a specific symbol from symbol table. Look up symbol
1519 from ABFD. MATCH_SYM is a callback function to determine whether to pick
1520 up a symbol. DATA is the input of this callback function. Return NULL
1521 if symbol is not found. */
1524 bfd_lookup_symbol_from_dyn_symtab (bfd *abfd,
1525 int (*match_sym) (const asymbol *,
1529 long storage_needed = bfd_get_dynamic_symtab_upper_bound (abfd);
1530 CORE_ADDR symaddr = 0;
1532 if (storage_needed > 0)
1535 gdb::def_vector<asymbol *> storage (storage_needed / sizeof (asymbol *));
1536 asymbol **symbol_table = storage.data ();
1537 unsigned int number_of_symbols =
1538 bfd_canonicalize_dynamic_symtab (abfd, symbol_table);
1540 for (i = 0; i < number_of_symbols; i++)
1542 asymbol *sym = *symbol_table++;
1544 if (match_sym (sym, data))
1546 /* BFD symbols are section relative. */
1547 symaddr = sym->value + sym->section->vma;
1555 /* Lookup the value for a specific symbol from symbol table and dynamic
1556 symbol table. Look up symbol from ABFD. MATCH_SYM is a callback
1557 function to determine whether to pick up a symbol. DATA is the
1558 input of this callback function. Return NULL if symbol is not
1562 gdb_bfd_lookup_symbol (bfd *abfd,
1563 int (*match_sym) (const asymbol *, const void *),
1566 CORE_ADDR symaddr = gdb_bfd_lookup_symbol_from_symtab (abfd, match_sym, data);
1568 /* On FreeBSD, the dynamic linker is stripped by default. So we'll
1569 have to check the dynamic string table too. */
1571 symaddr = bfd_lookup_symbol_from_dyn_symtab (abfd, match_sym, data);
1576 /* SO_LIST_HEAD may contain user-loaded object files that can be removed
1577 out-of-band by the user. So upon notification of free_objfile remove
1578 all references to any user-loaded file that is about to be freed. */
1581 remove_user_added_objfile (struct objfile *objfile)
1585 if (objfile != 0 && objfile->flags & OBJF_USERLOADED)
1587 for (so = so_list_head; so != NULL; so = so->next)
1588 if (so->objfile == objfile)
1594 _initialize_solib (void)
1596 solib_data = gdbarch_data_register_pre_init (solib_init);
1598 gdb::observers::free_objfile.attach (remove_user_added_objfile);
1600 add_com ("sharedlibrary", class_files, sharedlibrary_command,
1601 _("Load shared object library symbols for files matching REGEXP."));
1602 add_info ("sharedlibrary", info_sharedlibrary_command,
1603 _("Status of loaded shared object libraries."));
1604 add_info_alias ("dll", "sharedlibrary", 1);
1605 add_com ("nosharedlibrary", class_files, no_shared_libraries,
1606 _("Unload all shared object library symbols."));
1608 add_setshow_boolean_cmd ("auto-solib-add", class_support,
1609 &auto_solib_add, _("\
1610 Set autoloading of shared library symbols."), _("\
1611 Show autoloading of shared library symbols."), _("\
1612 If \"on\", symbols from all shared object libraries will be loaded\n\
1613 automatically when the inferior begins execution, when the dynamic linker\n\
1614 informs gdb that a new library has been loaded, or when attaching to the\n\
1615 inferior. Otherwise, symbols must be loaded manually, using \
1618 show_auto_solib_add,
1619 &setlist, &showlist);
1621 add_setshow_optional_filename_cmd ("sysroot", class_support,
1623 Set an alternate system root."), _("\
1624 Show the current system root."), _("\
1625 The system root is used to load absolute shared library symbol files.\n\
1626 For other (relative) files, you can add directories using\n\
1627 `set solib-search-path'."),
1628 gdb_sysroot_changed,
1630 &setlist, &showlist);
1632 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1634 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1637 add_setshow_optional_filename_cmd ("solib-search-path", class_support,
1638 &solib_search_path, _("\
1639 Set the search path for loading non-absolute shared library symbol files."),
1641 Show the search path for loading non-absolute shared library symbol files."),
1643 This takes precedence over the environment variables \
1644 PATH and LD_LIBRARY_PATH."),
1645 reload_shared_libraries,
1646 show_solib_search_path,
1647 &setlist, &showlist);