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 */
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
69 = (const struct target_so_ops **) gdbarch_data (gdbarch, solib_data);
74 /* Set the solib operations for GDBARCH to NEW_OPS. */
77 set_solib_ops (struct gdbarch *gdbarch, const struct target_so_ops *new_ops)
79 const struct target_so_ops **ops
80 = (const struct target_so_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 /* Local function prototypes */
94 /* If non-empty, this is a search path for loading non-absolute shared library
95 symbol files. This takes precedence over the environment variables PATH
96 and LD_LIBRARY_PATH. */
97 static char *solib_search_path = NULL;
99 show_solib_search_path (struct ui_file *file, int from_tty,
100 struct cmd_list_element *c, const char *value)
102 fprintf_filtered (file, _("The search path for loading non-absolute "
103 "shared library symbol files is %s.\n"),
107 /* Same as HAVE_DOS_BASED_FILE_SYSTEM, but useable as an rvalue. */
108 #if (HAVE_DOS_BASED_FILE_SYSTEM)
109 # define DOS_BASED_FILE_SYSTEM 1
111 # define DOS_BASED_FILE_SYSTEM 0
114 /* Return the full pathname of a binary file (the main executable
115 or a shared library file), or NULL if not found. The returned
116 pathname is malloc'ed and must be freed by the caller. If FD
117 is non-NULL, *FD is set to either -1 or an open file handle for
120 Global variable GDB_SYSROOT is used as a prefix directory
121 to search for binary files if they have an absolute path.
122 If GDB_SYSROOT starts with "target:" and target filesystem
123 is the local filesystem then the "target:" prefix will be
124 stripped before the search starts. This ensures that the
125 same search algorithm is used for local files regardless of
126 whether a "target:" prefix was used.
128 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
129 (or set of directories, as in LD_LIBRARY_PATH) to search for all
130 shared libraries if not found in either the sysroot (if set) or
131 the local filesystem. SOLIB_SEARCH_PATH is not used when searching
132 for the main executable.
135 * If a sysroot is set and path is absolute:
136 * Search for sysroot/path.
138 * Look for it literally (unmodified).
139 * If IS_SOLIB is non-zero:
140 * Look in SOLIB_SEARCH_PATH.
141 * If available, use target defined search function.
142 * If NO sysroot is set, perform the following two searches:
143 * Look in inferior's $PATH.
144 * If IS_SOLIB is non-zero:
145 * Look in inferior's $LD_LIBRARY_PATH.
147 * The last check avoids doing this search when targetting remote
148 * machines since a sysroot will almost always be set.
152 solib_find_1 (const char *in_pathname, int *fd, int is_solib)
154 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
156 char *temp_pathname = NULL;
157 const char *fskind = effective_target_file_system_kind ();
158 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
159 char *sysroot = gdb_sysroot;
160 int prefix_len, orig_prefix_len;
162 /* If the absolute prefix starts with "target:" but the filesystem
163 accessed by the target_fileio_* methods is the local filesystem
164 then we strip the "target:" prefix now and work with the local
165 filesystem. This ensures that the same search algorithm is used
166 for all local files regardless of whether a "target:" prefix was
168 if (is_target_filename (sysroot) && target_filesystem_is_local ())
169 sysroot += strlen (TARGET_SYSROOT_PREFIX);
171 /* Strip any trailing slashes from the absolute prefix. */
172 prefix_len = orig_prefix_len = strlen (sysroot);
174 while (prefix_len > 0 && IS_DIR_SEPARATOR (sysroot[prefix_len - 1]))
179 else if (prefix_len != orig_prefix_len)
181 sysroot = savestring (sysroot, prefix_len);
182 make_cleanup (xfree, sysroot);
185 /* If we're on a non-DOS-based system, backslashes won't be
186 understood as directory separator, so, convert them to forward
187 slashes, iff we're supposed to handle DOS-based file system
188 semantics for target paths. */
189 if (!DOS_BASED_FILE_SYSTEM && fskind == file_system_kind_dos_based)
193 /* Avoid clobbering our input. */
194 p = (char *) alloca (strlen (in_pathname) + 1);
195 strcpy (p, in_pathname);
205 /* Note, we're interested in IS_TARGET_ABSOLUTE_PATH, not
206 IS_ABSOLUTE_PATH. The latter is for host paths only, while
207 IN_PATHNAME is a target path. For example, if we're supposed to
208 be handling DOS-like semantics we want to consider a
209 'c:/foo/bar.dll' path as an absolute path, even on a Unix box.
210 With such a path, before giving up on the sysroot, we'll try:
212 1st attempt, c:/foo/bar.dll ==> /sysroot/c:/foo/bar.dll
213 2nd attempt, c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll
214 3rd attempt, c:/foo/bar.dll ==> /sysroot/foo/bar.dll
217 if (!IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname) || sysroot == NULL)
218 temp_pathname = xstrdup (in_pathname);
221 int need_dir_separator;
223 /* Concatenate the sysroot and the target reported filename. We
224 may need to glue them with a directory separator. Cases to
227 | sysroot | separator | in_pathname |
228 |-----------------+-----------+----------------|
229 | /some/dir | / | c:/foo/bar.dll |
230 | /some/dir | | /foo/bar.dll |
231 | target: | | c:/foo/bar.dll |
232 | target: | | /foo/bar.dll |
233 | target:some/dir | / | c:/foo/bar.dll |
234 | target:some/dir | | /foo/bar.dll |
236 IOW, we don't need to add a separator if IN_PATHNAME already
237 has one, or when the the sysroot is exactly "target:".
238 There's no need to check for drive spec explicitly, as we only
239 get here if IN_PATHNAME is considered an absolute path. */
240 need_dir_separator = !(IS_DIR_SEPARATOR (in_pathname[0])
241 || strcmp (TARGET_SYSROOT_PREFIX, sysroot) == 0);
243 /* Cat the prefixed pathname together. */
244 temp_pathname = concat (sysroot,
245 need_dir_separator ? SLASH_STRING : "",
246 in_pathname, (char *) NULL);
249 /* Handle files to be accessed via the target. */
250 if (is_target_filename (temp_pathname))
254 do_cleanups (old_chain);
255 return temp_pathname;
258 /* Now see if we can open it. */
259 found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
261 xfree (temp_pathname);
263 /* If the search in gdb_sysroot failed, and the path name has a
264 drive spec (e.g, c:/foo), try stripping ':' from the drive spec,
265 and retrying in the sysroot:
266 c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll. */
270 && HAS_TARGET_DRIVE_SPEC (fskind, in_pathname))
272 int need_dir_separator = !IS_DIR_SEPARATOR (in_pathname[2]);
273 char *drive = savestring (in_pathname, 1);
275 temp_pathname = concat (sysroot,
278 need_dir_separator ? SLASH_STRING : "",
279 in_pathname + 2, (char *) NULL);
282 found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
285 xfree (temp_pathname);
287 /* If the search in gdb_sysroot still failed, try fully
288 stripping the drive spec, and trying once more in the
289 sysroot before giving up.
291 c:/foo/bar.dll ==> /sysroot/foo/bar.dll. */
293 temp_pathname = concat (sysroot,
294 need_dir_separator ? SLASH_STRING : "",
295 in_pathname + 2, (char *) NULL);
297 found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
299 xfree (temp_pathname);
303 do_cleanups (old_chain);
305 /* We try to find the library in various ways. After each attempt,
306 either found_file >= 0 and temp_pathname is a malloc'd string, or
307 found_file < 0 and temp_pathname does not point to storage that
308 needs to be freed. */
311 temp_pathname = NULL;
313 /* If the search in gdb_sysroot failed, and the path name is
314 absolute at this point, make it relative. (openp will try and open the
315 file according to its absolute path otherwise, which is not what we want.)
316 Affects subsequent searches for this solib. */
317 if (found_file < 0 && IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname))
319 /* First, get rid of any drive letters etc. */
320 while (!IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
323 /* Next, get rid of all leading dir separators. */
324 while (IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
328 /* If not found, and we're looking for a solib, search the
329 solib_search_path (if any). */
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 in_pathname, O_RDONLY | O_BINARY, &temp_pathname);
335 /* If not found, and we're looking for a solib, next search the
336 solib_search_path (if any) for the basename only (ignoring the
337 path). This is to allow reading solibs from a path that differs
338 from the opened path. */
339 if (is_solib && found_file < 0 && solib_search_path != NULL)
340 found_file = openp (solib_search_path,
341 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
342 target_lbasename (fskind, in_pathname),
343 O_RDONLY | O_BINARY, &temp_pathname);
345 /* If not found, and we're looking for a solib, try to use target
346 supplied solib search method. */
347 if (is_solib && found_file < 0 && ops->find_and_open_solib)
348 found_file = ops->find_and_open_solib (in_pathname, O_RDONLY | O_BINARY,
351 /* If not found, next search the inferior's $PATH environment variable. */
352 if (found_file < 0 && sysroot == NULL)
353 found_file = openp (current_inferior ()->environment.get ("PATH"),
354 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
355 O_RDONLY | O_BINARY, &temp_pathname);
357 /* If not found, and we're looking for a solib, next search the
358 inferior's $LD_LIBRARY_PATH environment variable. */
359 if (is_solib && found_file < 0 && sysroot == NULL)
360 found_file = openp (current_inferior ()->environment.get
362 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
363 O_RDONLY | O_BINARY, &temp_pathname);
373 return temp_pathname;
376 /* Return the full pathname of the main executable, or NULL if not
377 found. The returned pathname is malloc'ed and must be freed by
378 the caller. If FD is non-NULL, *FD is set to either -1 or an open
379 file handle for the main executable. */
382 exec_file_find (const char *in_pathname, int *fd)
385 const char *fskind = effective_target_file_system_kind ();
387 if (in_pathname == NULL)
390 if (*gdb_sysroot != '\0' && IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname))
392 result = solib_find_1 (in_pathname, fd, 0);
394 if (result == NULL && fskind == file_system_kind_dos_based)
398 new_pathname = (char *) alloca (strlen (in_pathname) + 5);
399 strcpy (new_pathname, in_pathname);
400 strcat (new_pathname, ".exe");
402 result = solib_find_1 (new_pathname, fd, 0);
407 /* It's possible we don't have a full path, but rather just a
408 filename. Some targets, such as HP-UX, don't provide the
411 Attempt to qualify the filename against the source path.
412 (If that fails, we'll just fall back on the original
413 filename. Not much more we can do...) */
415 if (!source_full_path_of (in_pathname, &result))
416 result = xstrdup (in_pathname);
424 /* Return the full pathname of a shared library file, or NULL if not
425 found. The returned pathname is malloc'ed and must be freed by
426 the caller. If FD is non-NULL, *FD is set to either -1 or an open
427 file handle for the shared library.
429 The search algorithm used is described in solib_find_1's comment
433 solib_find (const char *in_pathname, int *fd)
435 const char *solib_symbols_extension
436 = gdbarch_solib_symbols_extension (target_gdbarch ());
438 /* If solib_symbols_extension is set, replace the file's
440 if (solib_symbols_extension != NULL)
442 const char *p = in_pathname + strlen (in_pathname);
444 while (p > in_pathname && *p != '.')
452 = (char *) alloca (p - in_pathname + 1
453 + strlen (solib_symbols_extension) + 1);
454 memcpy (new_pathname, in_pathname, p - in_pathname + 1);
455 strcpy (new_pathname + (p - in_pathname) + 1,
456 solib_symbols_extension);
458 in_pathname = new_pathname;
462 return solib_find_1 (in_pathname, fd, 1);
465 /* Open and return a BFD for the shared library PATHNAME. If FD is not -1,
466 it is used as file handle to open the file. Throws an error if the file
467 could not be opened. Handles both local and remote file access.
469 PATHNAME must be malloc'ed by the caller. It will be freed by this
470 function. If unsuccessful, the FD will be closed (unless FD was
474 solib_bfd_fopen (char *pathname, int fd)
476 gdb_bfd_ref_ptr abfd (gdb_bfd_open (pathname, gnutarget, fd));
478 if (abfd != NULL && !gdb_bfd_has_target_filename (abfd.get ()))
479 bfd_set_cacheable (abfd.get (), 1);
483 make_cleanup (xfree, pathname);
484 error (_("Could not open `%s' as an executable file: %s"),
485 pathname, bfd_errmsg (bfd_get_error ()));
493 /* Find shared library PATHNAME and open a BFD for it. */
496 solib_bfd_open (char *pathname)
498 char *found_pathname;
500 const struct bfd_arch_info *b;
502 /* Search for shared library file. */
503 found_pathname = solib_find (pathname, &found_file);
504 if (found_pathname == NULL)
506 /* Return failure if the file could not be found, so that we can
507 accumulate messages about missing libraries. */
511 perror_with_name (pathname);
514 /* Open bfd for shared library. */
515 gdb_bfd_ref_ptr abfd (solib_bfd_fopen (found_pathname, found_file));
517 /* Check bfd format. */
518 if (!bfd_check_format (abfd.get (), bfd_object))
519 error (_("`%s': not in executable format: %s"),
520 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
522 /* Check bfd arch. */
523 b = gdbarch_bfd_arch_info (target_gdbarch ());
524 if (!b->compatible (b, bfd_get_arch_info (abfd.get ())))
525 warning (_("`%s': Shared library architecture %s is not compatible "
526 "with target architecture %s."), bfd_get_filename (abfd),
527 bfd_get_arch_info (abfd.get ())->printable_name,
533 /* Given a pointer to one of the shared objects in our list of mapped
534 objects, use the recorded name to open a bfd descriptor for the
535 object, build a section table, relocate all the section addresses
536 by the base address at which the shared object was mapped, and then
537 add the sections to the target's section table.
539 FIXME: In most (all?) cases the shared object file name recorded in
540 the dynamic linkage tables will be a fully qualified pathname. For
541 cases where it isn't, do we really mimic the systems search
542 mechanism correctly in the below code (particularly the tilde
543 expansion stuff?). */
546 solib_map_sections (struct so_list *so)
548 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
549 struct target_section *p;
551 gdb::unique_xmalloc_ptr<char> filename (tilde_expand (so->so_name));
552 gdb_bfd_ref_ptr abfd (ops->bfd_open (filename.get ()));
557 /* Leave bfd open, core_xfer_memory and "info files" need it. */
558 so->abfd = abfd.release ();
560 /* Copy the full path name into so_name, allowing symbol_file_add
561 to find it later. This also affects the =library-loaded GDB/MI
562 event, and in particular the part of that notification providing
563 the library's host-side path. If we let the target dictate
564 that objfile's path, and the target is different from the host,
565 GDB/MI will not provide the correct host-side path. */
566 if (strlen (bfd_get_filename (so->abfd)) >= SO_NAME_MAX_PATH_SIZE)
567 error (_("Shared library file name is too long."));
568 strcpy (so->so_name, bfd_get_filename (so->abfd));
570 if (build_section_table (so->abfd, &so->sections, &so->sections_end))
572 error (_("Can't find the file sections in `%s': %s"),
573 bfd_get_filename (so->abfd), bfd_errmsg (bfd_get_error ()));
576 for (p = so->sections; p < so->sections_end; p++)
578 /* Relocate the section binding addresses as recorded in the shared
579 object's file by the base address to which the object was actually
581 ops->relocate_section_addresses (so, p);
583 /* If the target didn't provide information about the address
584 range of the shared object, assume we want the location of
585 the .text section. */
586 if (so->addr_low == 0 && so->addr_high == 0
587 && strcmp (p->the_bfd_section->name, ".text") == 0)
589 so->addr_low = p->addr;
590 so->addr_high = p->endaddr;
594 /* Add the shared object's sections to the current set of file
595 section tables. Do this immediately after mapping the object so
596 that later nodes in the list can query this object, as is needed
598 add_target_sections (so, so->sections, so->sections_end);
603 /* Free symbol-file related contents of SO and reset for possible reloading
604 of SO. If we have opened a BFD for SO, close it. If we have placed SO's
605 sections in some target's section table, the caller is responsible for
608 This function doesn't mess with objfiles at all. If there is an
609 objfile associated with SO that needs to be removed, the caller is
610 responsible for taking care of that. */
613 clear_so (struct so_list *so)
615 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
619 xfree (so->sections);
620 so->sections = so->sections_end = NULL;
623 gdb_bfd_unref (so->abfd);
626 /* Our caller closed the objfile, possibly via objfile_purge_solibs. */
627 so->symbols_loaded = 0;
630 so->addr_low = so->addr_high = 0;
632 /* Restore the target-supplied file name. SO_NAME may be the path
633 of the symbol file. */
634 strcpy (so->so_name, so->so_original_name);
636 /* Do the same for target-specific data. */
637 if (ops->clear_so != NULL)
641 /* Free the storage associated with the `struct so_list' object SO.
642 If we have opened a BFD for SO, close it.
644 The caller is responsible for removing SO from whatever list it is
645 a member of. If we have placed SO's sections in some target's
646 section table, the caller is responsible for removing them.
648 This function doesn't mess with objfiles at all. If there is an
649 objfile associated with SO that needs to be removed, the caller is
650 responsible for taking care of that. */
653 free_so (struct so_list *so)
655 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
664 /* Return address of first so_list entry in master shared object list. */
666 master_so_list (void)
671 /* Read in symbols for shared object SO. If SYMFILE_VERBOSE is set in FLAGS,
672 be chatty about it. Return non-zero if any symbols were actually
676 solib_read_symbols (struct so_list *so, symfile_add_flags flags)
678 if (so->symbols_loaded)
680 /* If needed, we've already warned in our caller. */
682 else if (so->abfd == NULL)
684 /* We've already warned about this library, when trying to open
690 flags |= current_inferior ()->symfile_flags;
694 struct section_addr_info *sap;
696 /* Have we already loaded this shared object? */
697 ALL_OBJFILES (so->objfile)
699 if (filename_cmp (objfile_name (so->objfile), so->so_name) == 0
700 && so->objfile->addr_low == so->addr_low)
703 if (so->objfile == NULL)
705 sap = build_section_addr_info_from_section_table (so->sections,
707 so->objfile = symbol_file_add_from_bfd (so->abfd, so->so_name,
708 flags, sap, OBJF_SHARED,
710 so->objfile->addr_low = so->addr_low;
711 free_section_addr_info (sap);
714 so->symbols_loaded = 1;
716 CATCH (e, RETURN_MASK_ERROR)
718 exception_fprintf (gdb_stderr, e, _("Error while reading shared"
719 " library symbols for %s:\n"),
730 /* Return 1 if KNOWN->objfile is used by any other so_list object in the
731 SO_LIST_HEAD list. Return 0 otherwise. */
734 solib_used (const struct so_list *const known)
736 const struct so_list *pivot;
738 for (pivot = so_list_head; pivot != NULL; pivot = pivot->next)
739 if (pivot != known && pivot->objfile == known->objfile)
747 update_solib_list (int from_tty)
749 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
750 struct so_list *inferior = ops->current_sos();
751 struct so_list *gdb, **gdb_link;
753 /* We can reach here due to changing solib-search-path or the
754 sysroot, before having any inferior. */
755 if (target_has_execution && !ptid_equal (inferior_ptid, null_ptid))
757 struct inferior *inf = current_inferior ();
759 /* If we are attaching to a running process for which we
760 have not opened a symbol file, we may be able to get its
762 if (inf->attach_flag && symfile_objfile == NULL)
766 ops->open_symbol_file_object (from_tty);
768 CATCH (ex, RETURN_MASK_ALL)
770 exception_fprintf (gdb_stderr, ex,
771 "Error reading attached "
772 "process's symbol file.\n");
778 /* GDB and the inferior's dynamic linker each maintain their own
779 list of currently loaded shared objects; we want to bring the
780 former in sync with the latter. Scan both lists, seeing which
781 shared objects appear where. There are three cases:
783 - A shared object appears on both lists. This means that GDB
784 knows about it already, and it's still loaded in the inferior.
785 Nothing needs to happen.
787 - A shared object appears only on GDB's list. This means that
788 the inferior has unloaded it. We should remove the shared
789 object from GDB's tables.
791 - A shared object appears only on the inferior's list. This
792 means that it's just been loaded. We should add it to GDB's
795 So we walk GDB's list, checking each entry to see if it appears
796 in the inferior's list too. If it does, no action is needed, and
797 we remove it from the inferior's list. If it doesn't, the
798 inferior has unloaded it, and we remove it from GDB's list. By
799 the time we're done walking GDB's list, the inferior's list
800 contains only the new shared objects, which we then add. */
803 gdb_link = &so_list_head;
806 struct so_list *i = inferior;
807 struct so_list **i_link = &inferior;
809 /* Check to see whether the shared object *gdb also appears in
810 the inferior's current list. */
815 if (ops->same (gdb, i))
820 if (! filename_cmp (gdb->so_original_name, i->so_original_name))
828 /* If the shared object appears on the inferior's list too, then
829 it's still loaded, so we don't need to do anything. Delete
830 it from the inferior's list, and leave it on GDB's list. */
835 gdb_link = &gdb->next;
839 /* If it's not on the inferior's list, remove it from GDB's tables. */
842 /* Notify any observer that the shared object has been
843 unloaded before we remove it from GDB's tables. */
844 observer_notify_solib_unloaded (gdb);
846 VEC_safe_push (char_ptr, current_program_space->deleted_solibs,
847 xstrdup (gdb->so_name));
849 *gdb_link = gdb->next;
851 /* Unless the user loaded it explicitly, free SO's objfile. */
852 if (gdb->objfile && ! (gdb->objfile->flags & OBJF_USERLOADED)
853 && !solib_used (gdb))
856 /* Some targets' section tables might be referring to
857 sections from so->abfd; remove them. */
858 remove_target_sections (gdb);
865 /* Now the inferior's list contains only shared objects that don't
866 appear in GDB's list --- those that are newly loaded. Add them
867 to GDB's shared object list. */
871 const char *not_found_filename = NULL;
875 /* Add the new shared objects to GDB's list. */
876 *gdb_link = inferior;
878 /* Fill in the rest of each of the `struct so_list' nodes. */
879 for (i = inferior; i; i = i->next)
882 i->pspace = current_program_space;
883 VEC_safe_push (so_list_ptr, current_program_space->added_solibs, i);
887 /* Fill in the rest of the `struct so_list' node. */
888 if (!solib_map_sections (i))
891 if (not_found_filename == NULL)
892 not_found_filename = i->so_original_name;
896 CATCH (e, RETURN_MASK_ERROR)
898 exception_fprintf (gdb_stderr, e,
899 _("Error while mapping shared "
900 "library sections:\n"));
904 /* Notify any observer that the shared object has been
905 loaded now that we've added it to GDB's tables. */
906 observer_notify_solib_loaded (i);
909 /* If a library was not found, issue an appropriate warning
910 message. We have to use a single call to warning in case the
911 front end does something special with warnings, e.g., pop up
912 a dialog box. It Would Be Nice if we could get a "warning: "
913 prefix on each line in the CLI front end, though - it doesn't
917 warning (_("Could not load shared library symbols for %s.\n"
918 "Do you need \"set solib-search-path\" "
919 "or \"set sysroot\"?"),
921 else if (not_found > 1)
923 Could not load shared library symbols for %d libraries, e.g. %s.\n\
924 Use the \"info sharedlibrary\" command to see the complete listing.\n\
925 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
926 not_found, not_found_filename);
931 /* Return non-zero if NAME is the libpthread shared library.
933 Uses a fairly simplistic heuristic approach where we check
934 the file name against "/libpthread". This can lead to false
935 positives, but this should be good enough in practice. */
938 libpthread_name_p (const char *name)
940 return (strstr (name, "/libpthread") != NULL);
943 /* Return non-zero if SO is the libpthread shared library. */
946 libpthread_solib_p (struct so_list *so)
948 return libpthread_name_p (so->so_name);
951 /* Read in symbolic information for any shared objects whose names
952 match PATTERN. (If we've already read a shared object's symbol
953 info, leave it alone.) If PATTERN is zero, read them all.
955 If READSYMS is 0, defer reading symbolic information until later
956 but still do any needed low level processing.
958 FROM_TTY is described for update_solib_list, above. */
961 solib_add (const char *pattern, int from_tty, int readsyms)
965 if (print_symbol_loading_p (from_tty, 0, 0))
969 printf_unfiltered (_("Loading symbols for shared libraries: %s\n"),
973 printf_unfiltered (_("Loading symbols for shared libraries.\n"));
976 current_program_space->solib_add_generation++;
980 char *re_err = re_comp (pattern);
983 error (_("Invalid regexp: %s"), re_err);
986 update_solib_list (from_tty);
988 /* Walk the list of currently loaded shared libraries, and read
989 symbols for any that match the pattern --- or any whose symbols
990 aren't already loaded, if no pattern was given. */
993 int loaded_any_symbols = 0;
994 symfile_add_flags add_flags = SYMFILE_DEFER_BP_RESET;
997 add_flags |= SYMFILE_VERBOSE;
999 for (gdb = so_list_head; gdb; gdb = gdb->next)
1000 if (! pattern || re_exec (gdb->so_name))
1002 /* Normally, we would read the symbols from that library
1003 only if READSYMS is set. However, we're making a small
1004 exception for the pthread library, because we sometimes
1005 need the library symbols to be loaded in order to provide
1006 thread support (x86-linux for instance). */
1007 const int add_this_solib =
1008 (readsyms || libpthread_solib_p (gdb));
1013 if (gdb->symbols_loaded)
1015 /* If no pattern was given, be quiet for shared
1016 libraries we have already loaded. */
1017 if (pattern && (from_tty || info_verbose))
1018 printf_unfiltered (_("Symbols already loaded for %s\n"),
1021 else if (solib_read_symbols (gdb, add_flags))
1022 loaded_any_symbols = 1;
1026 if (loaded_any_symbols)
1027 breakpoint_re_set ();
1029 if (from_tty && pattern && ! any_matches)
1031 ("No loaded shared libraries match the pattern `%s'.\n", pattern);
1033 if (loaded_any_symbols)
1035 /* Getting new symbols may change our opinion about what is
1037 reinit_frame_cache ();
1042 /* Implement the "info sharedlibrary" command. Walk through the
1043 shared library list and print information about each attached
1044 library matching PATTERN. If PATTERN is elided, print them
1048 info_sharedlibrary_command (const char *pattern, int from_tty)
1050 struct so_list *so = NULL; /* link map state variable */
1051 int so_missing_debug_info = 0;
1054 struct gdbarch *gdbarch = target_gdbarch ();
1055 struct ui_out *uiout = current_uiout;
1059 char *re_err = re_comp (pattern);
1062 error (_("Invalid regexp: %s"), re_err);
1065 /* "0x", a little whitespace, and two hex digits per byte of pointers. */
1066 addr_width = 4 + (gdbarch_ptr_bit (gdbarch) / 4);
1068 update_solib_list (from_tty);
1070 /* ui_out_emit_table table_emitter needs to know the number of rows,
1071 so we need to make two passes over the libs. */
1073 for (nr_libs = 0, so = so_list_head; so; so = so->next)
1077 if (pattern && ! re_exec (so->so_name))
1084 ui_out_emit_table table_emitter (uiout, 4, nr_libs, "SharedLibraryTable");
1086 /* The "- 1" is because ui_out adds one space between columns. */
1087 uiout->table_header (addr_width - 1, ui_left, "from", "From");
1088 uiout->table_header (addr_width - 1, ui_left, "to", "To");
1089 uiout->table_header (12 - 1, ui_left, "syms-read", "Syms Read");
1090 uiout->table_header (0, ui_noalign, "name", "Shared Object Library");
1092 uiout->table_body ();
1096 if (! so->so_name[0])
1098 if (pattern && ! re_exec (so->so_name))
1101 ui_out_emit_tuple tuple_emitter (uiout, "lib");
1103 if (so->addr_high != 0)
1105 uiout->field_core_addr ("from", gdbarch, so->addr_low);
1106 uiout->field_core_addr ("to", gdbarch, so->addr_high);
1110 uiout->field_skip ("from");
1111 uiout->field_skip ("to");
1114 if (! interp_ui_out (top_level_interpreter ())->is_mi_like_p ()
1115 && so->symbols_loaded
1116 && !objfile_has_symbols (so->objfile))
1118 so_missing_debug_info = 1;
1119 uiout->field_string ("syms-read", "Yes (*)");
1122 uiout->field_string ("syms-read", so->symbols_loaded ? "Yes" : "No");
1124 uiout->field_string ("name", so->so_name);
1133 uiout->message (_("No shared libraries matched.\n"));
1135 uiout->message (_("No shared libraries loaded at this time.\n"));
1139 if (so_missing_debug_info)
1140 uiout->message (_("(*): Shared library is missing "
1141 "debugging information.\n"));
1145 /* Return 1 if ADDRESS lies within SOLIB. */
1148 solib_contains_address_p (const struct so_list *const solib,
1151 struct target_section *p;
1153 for (p = solib->sections; p < solib->sections_end; p++)
1154 if (p->addr <= address && address < p->endaddr)
1160 /* If ADDRESS is in a shared lib in program space PSPACE, return its
1163 Provides a hook for other gdb routines to discover whether or not a
1164 particular address is within the mapped address space of a shared
1167 For example, this routine is called at one point to disable
1168 breakpoints which are in shared libraries that are not currently
1172 solib_name_from_address (struct program_space *pspace, CORE_ADDR address)
1174 struct so_list *so = NULL;
1176 for (so = pspace->so_list; so; so = so->next)
1177 if (solib_contains_address_p (so, address))
1178 return (so->so_name);
1183 /* Return whether the data starting at VADDR, size SIZE, must be kept
1184 in a core file for shared libraries loaded before "gcore" is used
1185 to be handled correctly when the core file is loaded. This only
1186 applies when the section would otherwise not be kept in the core
1187 file (in particular, for readonly sections). */
1190 solib_keep_data_in_core (CORE_ADDR vaddr, unsigned long size)
1192 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1194 if (ops->keep_data_in_core)
1195 return ops->keep_data_in_core (vaddr, size);
1200 /* Called by free_all_symtabs */
1205 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1207 disable_breakpoints_in_shlibs ();
1209 while (so_list_head)
1211 struct so_list *so = so_list_head;
1213 so_list_head = so->next;
1214 observer_notify_solib_unloaded (so);
1215 remove_target_sections (so);
1219 ops->clear_solib ();
1222 /* Shared library startup support. When GDB starts up the inferior,
1223 it nurses it along (through the shell) until it is ready to execute
1224 its first instruction. At this point, this function gets
1228 solib_create_inferior_hook (int from_tty)
1230 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1232 ops->solib_create_inferior_hook (from_tty);
1235 /* Check to see if an address is in the dynamic loader's dynamic
1236 symbol resolution code. Return 1 if so, 0 otherwise. */
1239 in_solib_dynsym_resolve_code (CORE_ADDR pc)
1241 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1243 return ops->in_dynsym_resolve_code (pc);
1246 /* Implements the "sharedlibrary" command. */
1249 sharedlibrary_command (const char *args, int from_tty)
1252 solib_add (args, from_tty, 1);
1255 /* Implements the command "nosharedlibrary", which discards symbols
1256 that have been auto-loaded from shared libraries. Symbols from
1257 shared libraries that were added by explicit request of the user
1258 are not discarded. Also called from remote.c. */
1261 no_shared_libraries (const char *ignored, int from_tty)
1263 /* The order of the two routines below is important: clear_solib notifies
1264 the solib_unloaded observers, and some of these observers might need
1265 access to their associated objfiles. Therefore, we can not purge the
1266 solibs' objfiles before clear_solib has been called. */
1269 objfile_purge_solibs ();
1275 update_solib_breakpoints (void)
1277 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1279 if (ops->update_breakpoints != NULL)
1280 ops->update_breakpoints ();
1286 handle_solib_event (void)
1288 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1290 if (ops->handle_event != NULL)
1291 ops->handle_event ();
1293 clear_program_space_solib_cache (current_inferior ()->pspace);
1295 /* Check for any newly added shared libraries if we're supposed to
1296 be adding them automatically. Switch terminal for any messages
1297 produced by breakpoint_re_set. */
1298 target_terminal::ours_for_output ();
1299 solib_add (NULL, 0, auto_solib_add);
1300 target_terminal::inferior ();
1303 /* Reload shared libraries, but avoid reloading the same symbol file
1304 we already have loaded. */
1307 reload_shared_libraries_1 (int from_tty)
1311 if (print_symbol_loading_p (from_tty, 0, 0))
1312 printf_unfiltered (_("Loading symbols for shared libraries.\n"));
1314 for (so = so_list_head; so != NULL; so = so->next)
1316 char *found_pathname = NULL;
1317 int was_loaded = so->symbols_loaded;
1318 symfile_add_flags add_flags = SYMFILE_DEFER_BP_RESET;
1321 add_flags |= SYMFILE_VERBOSE;
1323 gdb::unique_xmalloc_ptr<char> filename
1324 (tilde_expand (so->so_original_name));
1325 gdb_bfd_ref_ptr abfd (solib_bfd_open (filename.get ()));
1327 found_pathname = bfd_get_filename (abfd.get ());
1329 /* If this shared library is no longer associated with its previous
1330 symbol file, close that. */
1331 if ((found_pathname == NULL && was_loaded)
1332 || (found_pathname != NULL
1333 && filename_cmp (found_pathname, so->so_name) != 0))
1335 if (so->objfile && ! (so->objfile->flags & OBJF_USERLOADED)
1336 && !solib_used (so))
1338 remove_target_sections (so);
1342 /* If this shared library is now associated with a new symbol
1344 if (found_pathname != NULL
1346 || filename_cmp (found_pathname, so->so_name) != 0))
1352 solib_map_sections (so);
1355 CATCH (e, RETURN_MASK_ERROR)
1357 exception_fprintf (gdb_stderr, e,
1358 _("Error while mapping "
1359 "shared library sections:\n"));
1365 && (auto_solib_add || was_loaded || libpthread_solib_p (so)))
1366 solib_read_symbols (so, add_flags);
1372 reload_shared_libraries (const char *ignored, int from_tty,
1373 struct cmd_list_element *e)
1375 const struct target_so_ops *ops;
1377 reload_shared_libraries_1 (from_tty);
1379 ops = solib_ops (target_gdbarch ());
1381 /* Creating inferior hooks here has two purposes. First, if we reload
1382 shared libraries then the address of solib breakpoint we've computed
1383 previously might be no longer valid. For example, if we forgot to set
1384 solib-absolute-prefix and are setting it right now, then the previous
1385 breakpoint address is plain wrong. Second, installing solib hooks
1386 also implicitly figures were ld.so is and loads symbols for it.
1387 Absent this call, if we've just connected to a target and set
1388 solib-absolute-prefix or solib-search-path, we'll lose all information
1390 if (target_has_execution)
1392 /* Reset or free private data structures not associated with
1394 ops->clear_solib ();
1396 /* Remove any previous solib event breakpoint. This is usually
1397 done in common code, at breakpoint_init_inferior time, but
1398 we're not really starting up the inferior here. */
1399 remove_solib_event_breakpoints ();
1401 solib_create_inferior_hook (from_tty);
1404 /* Sometimes the platform-specific hook loads initial shared
1405 libraries, and sometimes it doesn't. If it doesn't FROM_TTY will be
1406 incorrectly 0 but such solib targets should be fixed anyway. If we
1407 made all the inferior hook methods consistent, this call could be
1408 removed. Call it only after the solib target has been initialized by
1409 solib_create_inferior_hook. */
1411 solib_add (NULL, 0, auto_solib_add);
1413 breakpoint_re_set ();
1415 /* We may have loaded or unloaded debug info for some (or all)
1416 shared libraries. However, frames may still reference them. For
1417 example, a frame's unwinder might still point at DWARF FDE
1418 structures that are now freed. Also, getting new symbols may
1419 change our opinion about what is frameless. */
1420 reinit_frame_cache ();
1423 /* Wrapper for reload_shared_libraries that replaces "remote:"
1424 at the start of gdb_sysroot with "target:". */
1427 gdb_sysroot_changed (const char *ignored, int from_tty,
1428 struct cmd_list_element *e)
1430 const char *old_prefix = "remote:";
1431 const char *new_prefix = TARGET_SYSROOT_PREFIX;
1433 if (startswith (gdb_sysroot, old_prefix))
1435 static int warning_issued = 0;
1437 gdb_assert (strlen (old_prefix) == strlen (new_prefix));
1438 memcpy (gdb_sysroot, new_prefix, strlen (new_prefix));
1440 if (!warning_issued)
1442 warning (_("\"%s\" is deprecated, use \"%s\" instead."),
1443 old_prefix, new_prefix);
1444 warning (_("sysroot set to \"%s\"."), gdb_sysroot);
1450 reload_shared_libraries (ignored, from_tty, e);
1454 show_auto_solib_add (struct ui_file *file, int from_tty,
1455 struct cmd_list_element *c, const char *value)
1457 fprintf_filtered (file, _("Autoloading of shared library symbols is %s.\n"),
1462 /* Handler for library-specific lookup of global symbol NAME in OBJFILE. Call
1463 the library-specific handler if it is installed for the current target. */
1466 solib_global_lookup (struct objfile *objfile,
1468 const domain_enum domain)
1470 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1472 if (ops->lookup_lib_global_symbol != NULL)
1473 return ops->lookup_lib_global_symbol (objfile, name, domain);
1474 return (struct block_symbol) {NULL, NULL};
1477 /* Lookup the value for a specific symbol from dynamic symbol table. Look
1478 up symbol from ABFD. MATCH_SYM is a callback function to determine
1479 whether to pick up a symbol. DATA is the input of this callback
1480 function. Return NULL if symbol is not found. */
1483 gdb_bfd_lookup_symbol_from_symtab (bfd *abfd,
1484 int (*match_sym) (const asymbol *,
1488 long storage_needed = bfd_get_symtab_upper_bound (abfd);
1489 CORE_ADDR symaddr = 0;
1491 if (storage_needed > 0)
1495 asymbol **symbol_table = (asymbol **) xmalloc (storage_needed);
1496 struct cleanup *back_to = make_cleanup (xfree, symbol_table);
1497 unsigned int number_of_symbols =
1498 bfd_canonicalize_symtab (abfd, symbol_table);
1500 for (i = 0; i < number_of_symbols; i++)
1502 asymbol *sym = *symbol_table++;
1504 if (match_sym (sym, data))
1506 struct gdbarch *gdbarch = target_gdbarch ();
1507 symaddr = sym->value;
1509 /* Some ELF targets fiddle with addresses of symbols they
1510 consider special. They use minimal symbols to do that
1511 and this is needed for correct breakpoint placement,
1512 but we do not have full data here to build a complete
1513 minimal symbol, so just set the address and let the
1514 targets cope with that. */
1515 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour
1516 && gdbarch_elf_make_msymbol_special_p (gdbarch))
1518 struct minimal_symbol msym;
1520 memset (&msym, 0, sizeof (msym));
1521 SET_MSYMBOL_VALUE_ADDRESS (&msym, symaddr);
1522 gdbarch_elf_make_msymbol_special (gdbarch, sym, &msym);
1523 symaddr = MSYMBOL_VALUE_RAW_ADDRESS (&msym);
1526 /* BFD symbols are section relative. */
1527 symaddr += sym->section->vma;
1531 do_cleanups (back_to);
1537 /* Lookup the value for a specific symbol from symbol table. Look up symbol
1538 from ABFD. MATCH_SYM is a callback function to determine whether to pick
1539 up a symbol. DATA is the input of this callback function. Return NULL
1540 if symbol is not found. */
1543 bfd_lookup_symbol_from_dyn_symtab (bfd *abfd,
1544 int (*match_sym) (const asymbol *,
1548 long storage_needed = bfd_get_dynamic_symtab_upper_bound (abfd);
1549 CORE_ADDR symaddr = 0;
1551 if (storage_needed > 0)
1554 asymbol **symbol_table = (asymbol **) xmalloc (storage_needed);
1555 struct cleanup *back_to = make_cleanup (xfree, symbol_table);
1556 unsigned int number_of_symbols =
1557 bfd_canonicalize_dynamic_symtab (abfd, symbol_table);
1559 for (i = 0; i < number_of_symbols; i++)
1561 asymbol *sym = *symbol_table++;
1563 if (match_sym (sym, data))
1565 /* BFD symbols are section relative. */
1566 symaddr = sym->value + sym->section->vma;
1570 do_cleanups (back_to);
1575 /* Lookup the value for a specific symbol from symbol table and dynamic
1576 symbol table. Look up symbol from ABFD. MATCH_SYM is a callback
1577 function to determine whether to pick up a symbol. DATA is the
1578 input of this callback function. Return NULL if symbol is not
1582 gdb_bfd_lookup_symbol (bfd *abfd,
1583 int (*match_sym) (const asymbol *, const void *),
1586 CORE_ADDR symaddr = gdb_bfd_lookup_symbol_from_symtab (abfd, match_sym, data);
1588 /* On FreeBSD, the dynamic linker is stripped by default. So we'll
1589 have to check the dynamic string table too. */
1591 symaddr = bfd_lookup_symbol_from_dyn_symtab (abfd, match_sym, data);
1596 /* SO_LIST_HEAD may contain user-loaded object files that can be removed
1597 out-of-band by the user. So upon notification of free_objfile remove
1598 all references to any user-loaded file that is about to be freed. */
1601 remove_user_added_objfile (struct objfile *objfile)
1605 if (objfile != 0 && objfile->flags & OBJF_USERLOADED)
1607 for (so = so_list_head; so != NULL; so = so->next)
1608 if (so->objfile == objfile)
1614 _initialize_solib (void)
1616 solib_data = gdbarch_data_register_pre_init (solib_init);
1618 observer_attach_free_objfile (remove_user_added_objfile);
1620 add_com ("sharedlibrary", class_files, sharedlibrary_command,
1621 _("Load shared object library symbols for files matching REGEXP."));
1622 add_info ("sharedlibrary", info_sharedlibrary_command,
1623 _("Status of loaded shared object libraries."));
1624 add_info_alias ("dll", "sharedlibrary", 1);
1625 add_com ("nosharedlibrary", class_files, no_shared_libraries,
1626 _("Unload all shared object library symbols."));
1628 add_setshow_boolean_cmd ("auto-solib-add", class_support,
1629 &auto_solib_add, _("\
1630 Set autoloading of shared library symbols."), _("\
1631 Show autoloading of shared library symbols."), _("\
1632 If \"on\", symbols from all shared object libraries will be loaded\n\
1633 automatically when the inferior begins execution, when the dynamic linker\n\
1634 informs gdb that a new library has been loaded, or when attaching to the\n\
1635 inferior. Otherwise, symbols must be loaded manually, using \
1638 show_auto_solib_add,
1639 &setlist, &showlist);
1641 add_setshow_optional_filename_cmd ("sysroot", class_support,
1643 Set an alternate system root."), _("\
1644 Show the current system root."), _("\
1645 The system root is used to load absolute shared library symbol files.\n\
1646 For other (relative) files, you can add directories using\n\
1647 `set solib-search-path'."),
1648 gdb_sysroot_changed,
1650 &setlist, &showlist);
1652 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1654 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1657 add_setshow_optional_filename_cmd ("solib-search-path", class_support,
1658 &solib_search_path, _("\
1659 Set the search path for loading non-absolute shared library symbol files."),
1661 Show the search path for loading non-absolute shared library symbol files."),
1663 This takes precedence over the environment variables \
1664 PATH and LD_LIBRARY_PATH."),
1665 reload_shared_libraries,
1666 show_solib_search_path,
1667 &setlist, &showlist);