1 /* Handle shared libraries for GDB, the GNU Debugger.
3 Copyright (C) 1990-2017 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 (get_in_environ (current_inferior ()->environment,
355 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
356 O_RDONLY | O_BINARY, &temp_pathname);
358 /* If not found, and we're looking for a solib, next search the
359 inferior's $LD_LIBRARY_PATH environment variable. */
360 if (is_solib && found_file < 0 && sysroot == NULL)
361 found_file = openp (get_in_environ (current_inferior ()->environment,
363 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
364 O_RDONLY | O_BINARY, &temp_pathname);
374 return temp_pathname;
377 /* Return the full pathname of the main executable, or NULL if not
378 found. The returned pathname is malloc'ed and must be freed by
379 the caller. If FD is non-NULL, *FD is set to either -1 or an open
380 file handle for the main executable. */
383 exec_file_find (const char *in_pathname, int *fd)
386 const char *fskind = effective_target_file_system_kind ();
388 if (in_pathname == NULL)
391 if (*gdb_sysroot != '\0' && IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname))
393 result = solib_find_1 (in_pathname, fd, 0);
395 if (result == NULL && fskind == file_system_kind_dos_based)
399 new_pathname = (char *) alloca (strlen (in_pathname) + 5);
400 strcpy (new_pathname, in_pathname);
401 strcat (new_pathname, ".exe");
403 result = solib_find_1 (new_pathname, fd, 0);
408 /* It's possible we don't have a full path, but rather just a
409 filename. Some targets, such as HP-UX, don't provide the
412 Attempt to qualify the filename against the source path.
413 (If that fails, we'll just fall back on the original
414 filename. Not much more we can do...) */
416 if (!source_full_path_of (in_pathname, &result))
417 result = xstrdup (in_pathname);
425 /* Return the full pathname of a shared library file, or NULL if not
426 found. The returned pathname is malloc'ed and must be freed by
427 the caller. If FD is non-NULL, *FD is set to either -1 or an open
428 file handle for the shared library.
430 The search algorithm used is described in solib_find_1's comment
434 solib_find (const char *in_pathname, int *fd)
436 const char *solib_symbols_extension
437 = gdbarch_solib_symbols_extension (target_gdbarch ());
439 /* If solib_symbols_extension is set, replace the file's
441 if (solib_symbols_extension != NULL)
443 const char *p = in_pathname + strlen (in_pathname);
445 while (p > in_pathname && *p != '.')
453 = (char *) alloca (p - in_pathname + 1
454 + strlen (solib_symbols_extension) + 1);
455 memcpy (new_pathname, in_pathname, p - in_pathname + 1);
456 strcpy (new_pathname + (p - in_pathname) + 1,
457 solib_symbols_extension);
459 in_pathname = new_pathname;
463 return solib_find_1 (in_pathname, fd, 1);
466 /* Open and return a BFD for the shared library PATHNAME. If FD is not -1,
467 it is used as file handle to open the file. Throws an error if the file
468 could not be opened. Handles both local and remote file access.
470 PATHNAME must be malloc'ed by the caller. It will be freed by this
471 function. If unsuccessful, the FD will be closed (unless FD was
475 solib_bfd_fopen (char *pathname, int fd)
477 gdb_bfd_ref_ptr abfd (gdb_bfd_open (pathname, gnutarget, fd));
479 if (abfd != NULL && !gdb_bfd_has_target_filename (abfd.get ()))
480 bfd_set_cacheable (abfd.get (), 1);
484 make_cleanup (xfree, pathname);
485 error (_("Could not open `%s' as an executable file: %s"),
486 pathname, bfd_errmsg (bfd_get_error ()));
494 /* Find shared library PATHNAME and open a BFD for it. */
497 solib_bfd_open (char *pathname)
499 char *found_pathname;
501 const struct bfd_arch_info *b;
503 /* Search for shared library file. */
504 found_pathname = solib_find (pathname, &found_file);
505 if (found_pathname == NULL)
507 /* Return failure if the file could not be found, so that we can
508 accumulate messages about missing libraries. */
512 perror_with_name (pathname);
515 /* Open bfd for shared library. */
516 gdb_bfd_ref_ptr abfd (solib_bfd_fopen (found_pathname, found_file));
518 /* Check bfd format. */
519 if (!bfd_check_format (abfd.get (), bfd_object))
520 error (_("`%s': not in executable format: %s"),
521 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
523 /* Check bfd arch. */
524 b = gdbarch_bfd_arch_info (target_gdbarch ());
525 if (!b->compatible (b, bfd_get_arch_info (abfd.get ())))
526 warning (_("`%s': Shared library architecture %s is not compatible "
527 "with target architecture %s."), bfd_get_filename (abfd),
528 bfd_get_arch_info (abfd.get ())->printable_name,
534 /* Given a pointer to one of the shared objects in our list of mapped
535 objects, use the recorded name to open a bfd descriptor for the
536 object, build a section table, relocate all the section addresses
537 by the base address at which the shared object was mapped, and then
538 add the sections to the target's section table.
540 FIXME: In most (all?) cases the shared object file name recorded in
541 the dynamic linkage tables will be a fully qualified pathname. For
542 cases where it isn't, do we really mimic the systems search
543 mechanism correctly in the below code (particularly the tilde
544 expansion stuff?). */
547 solib_map_sections (struct so_list *so)
549 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
551 struct target_section *p;
552 struct cleanup *old_chain;
554 filename = tilde_expand (so->so_name);
555 old_chain = make_cleanup (xfree, filename);
556 gdb_bfd_ref_ptr abfd (ops->bfd_open (filename));
557 do_cleanups (old_chain);
562 /* Leave bfd open, core_xfer_memory and "info files" need it. */
563 so->abfd = abfd.release ();
565 /* Copy the full path name into so_name, allowing symbol_file_add
566 to find it later. This also affects the =library-loaded GDB/MI
567 event, and in particular the part of that notification providing
568 the library's host-side path. If we let the target dictate
569 that objfile's path, and the target is different from the host,
570 GDB/MI will not provide the correct host-side path. */
571 if (strlen (bfd_get_filename (so->abfd)) >= SO_NAME_MAX_PATH_SIZE)
572 error (_("Shared library file name is too long."));
573 strcpy (so->so_name, bfd_get_filename (so->abfd));
575 if (build_section_table (so->abfd, &so->sections, &so->sections_end))
577 error (_("Can't find the file sections in `%s': %s"),
578 bfd_get_filename (so->abfd), bfd_errmsg (bfd_get_error ()));
581 for (p = so->sections; p < so->sections_end; p++)
583 /* Relocate the section binding addresses as recorded in the shared
584 object's file by the base address to which the object was actually
586 ops->relocate_section_addresses (so, p);
588 /* If the target didn't provide information about the address
589 range of the shared object, assume we want the location of
590 the .text section. */
591 if (so->addr_low == 0 && so->addr_high == 0
592 && strcmp (p->the_bfd_section->name, ".text") == 0)
594 so->addr_low = p->addr;
595 so->addr_high = p->endaddr;
599 /* Add the shared object's sections to the current set of file
600 section tables. Do this immediately after mapping the object so
601 that later nodes in the list can query this object, as is needed
603 add_target_sections (so, so->sections, so->sections_end);
608 /* Free symbol-file related contents of SO and reset for possible reloading
609 of SO. If we have opened a BFD for SO, close it. If we have placed SO's
610 sections in some target's section table, the caller is responsible for
613 This function doesn't mess with objfiles at all. If there is an
614 objfile associated with SO that needs to be removed, the caller is
615 responsible for taking care of that. */
618 clear_so (struct so_list *so)
620 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
624 xfree (so->sections);
625 so->sections = so->sections_end = NULL;
628 gdb_bfd_unref (so->abfd);
631 /* Our caller closed the objfile, possibly via objfile_purge_solibs. */
632 so->symbols_loaded = 0;
635 so->addr_low = so->addr_high = 0;
637 /* Restore the target-supplied file name. SO_NAME may be the path
638 of the symbol file. */
639 strcpy (so->so_name, so->so_original_name);
641 /* Do the same for target-specific data. */
642 if (ops->clear_so != NULL)
646 /* Free the storage associated with the `struct so_list' object SO.
647 If we have opened a BFD for SO, close it.
649 The caller is responsible for removing SO from whatever list it is
650 a member of. If we have placed SO's sections in some target's
651 section table, the caller is responsible for removing them.
653 This function doesn't mess with objfiles at all. If there is an
654 objfile associated with SO that needs to be removed, the caller is
655 responsible for taking care of that. */
658 free_so (struct so_list *so)
660 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
669 /* Return address of first so_list entry in master shared object list. */
671 master_so_list (void)
676 /* Read in symbols for shared object SO. If SYMFILE_VERBOSE is set in FLAGS,
677 be chatty about it. Return non-zero if any symbols were actually
681 solib_read_symbols (struct so_list *so, symfile_add_flags flags)
683 if (so->symbols_loaded)
685 /* If needed, we've already warned in our caller. */
687 else if (so->abfd == NULL)
689 /* We've already warned about this library, when trying to open
695 flags |= current_inferior ()->symfile_flags;
699 struct section_addr_info *sap;
701 /* Have we already loaded this shared object? */
702 ALL_OBJFILES (so->objfile)
704 if (filename_cmp (objfile_name (so->objfile), so->so_name) == 0
705 && so->objfile->addr_low == so->addr_low)
708 if (so->objfile == NULL)
710 sap = build_section_addr_info_from_section_table (so->sections,
712 so->objfile = symbol_file_add_from_bfd (so->abfd, so->so_name,
713 flags, sap, OBJF_SHARED,
715 so->objfile->addr_low = so->addr_low;
716 free_section_addr_info (sap);
719 so->symbols_loaded = 1;
721 CATCH (e, RETURN_MASK_ERROR)
723 exception_fprintf (gdb_stderr, e, _("Error while reading shared"
724 " library symbols for %s:\n"),
735 /* Return 1 if KNOWN->objfile is used by any other so_list object in the
736 SO_LIST_HEAD list. Return 0 otherwise. */
739 solib_used (const struct so_list *const known)
741 const struct so_list *pivot;
743 for (pivot = so_list_head; pivot != NULL; pivot = pivot->next)
744 if (pivot != known && pivot->objfile == known->objfile)
752 update_solib_list (int from_tty)
754 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
755 struct so_list *inferior = ops->current_sos();
756 struct so_list *gdb, **gdb_link;
758 /* We can reach here due to changing solib-search-path or the
759 sysroot, before having any inferior. */
760 if (target_has_execution && !ptid_equal (inferior_ptid, null_ptid))
762 struct inferior *inf = current_inferior ();
764 /* If we are attaching to a running process for which we
765 have not opened a symbol file, we may be able to get its
767 if (inf->attach_flag && symfile_objfile == NULL)
768 catch_errors (ops->open_symbol_file_object, &from_tty,
769 "Error reading attached process's symbol file.\n",
773 /* GDB and the inferior's dynamic linker each maintain their own
774 list of currently loaded shared objects; we want to bring the
775 former in sync with the latter. Scan both lists, seeing which
776 shared objects appear where. There are three cases:
778 - A shared object appears on both lists. This means that GDB
779 knows about it already, and it's still loaded in the inferior.
780 Nothing needs to happen.
782 - A shared object appears only on GDB's list. This means that
783 the inferior has unloaded it. We should remove the shared
784 object from GDB's tables.
786 - A shared object appears only on the inferior's list. This
787 means that it's just been loaded. We should add it to GDB's
790 So we walk GDB's list, checking each entry to see if it appears
791 in the inferior's list too. If it does, no action is needed, and
792 we remove it from the inferior's list. If it doesn't, the
793 inferior has unloaded it, and we remove it from GDB's list. By
794 the time we're done walking GDB's list, the inferior's list
795 contains only the new shared objects, which we then add. */
798 gdb_link = &so_list_head;
801 struct so_list *i = inferior;
802 struct so_list **i_link = &inferior;
804 /* Check to see whether the shared object *gdb also appears in
805 the inferior's current list. */
810 if (ops->same (gdb, i))
815 if (! filename_cmp (gdb->so_original_name, i->so_original_name))
823 /* If the shared object appears on the inferior's list too, then
824 it's still loaded, so we don't need to do anything. Delete
825 it from the inferior's list, and leave it on GDB's list. */
830 gdb_link = &gdb->next;
834 /* If it's not on the inferior's list, remove it from GDB's tables. */
837 /* Notify any observer that the shared object has been
838 unloaded before we remove it from GDB's tables. */
839 observer_notify_solib_unloaded (gdb);
841 VEC_safe_push (char_ptr, current_program_space->deleted_solibs,
842 xstrdup (gdb->so_name));
844 *gdb_link = gdb->next;
846 /* Unless the user loaded it explicitly, free SO's objfile. */
847 if (gdb->objfile && ! (gdb->objfile->flags & OBJF_USERLOADED)
848 && !solib_used (gdb))
849 free_objfile (gdb->objfile);
851 /* Some targets' section tables might be referring to
852 sections from so->abfd; remove them. */
853 remove_target_sections (gdb);
860 /* Now the inferior's list contains only shared objects that don't
861 appear in GDB's list --- those that are newly loaded. Add them
862 to GDB's shared object list. */
866 const char *not_found_filename = NULL;
870 /* Add the new shared objects to GDB's list. */
871 *gdb_link = inferior;
873 /* Fill in the rest of each of the `struct so_list' nodes. */
874 for (i = inferior; i; i = i->next)
877 i->pspace = current_program_space;
878 VEC_safe_push (so_list_ptr, current_program_space->added_solibs, i);
882 /* Fill in the rest of the `struct so_list' node. */
883 if (!solib_map_sections (i))
886 if (not_found_filename == NULL)
887 not_found_filename = i->so_original_name;
891 CATCH (e, RETURN_MASK_ERROR)
893 exception_fprintf (gdb_stderr, e,
894 _("Error while mapping shared "
895 "library sections:\n"));
899 /* Notify any observer that the shared object has been
900 loaded now that we've added it to GDB's tables. */
901 observer_notify_solib_loaded (i);
904 /* If a library was not found, issue an appropriate warning
905 message. We have to use a single call to warning in case the
906 front end does something special with warnings, e.g., pop up
907 a dialog box. It Would Be Nice if we could get a "warning: "
908 prefix on each line in the CLI front end, though - it doesn't
912 warning (_("Could not load shared library symbols for %s.\n"
913 "Do you need \"set solib-search-path\" "
914 "or \"set sysroot\"?"),
916 else if (not_found > 1)
918 Could not load shared library symbols for %d libraries, e.g. %s.\n\
919 Use the \"info sharedlibrary\" command to see the complete listing.\n\
920 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
921 not_found, not_found_filename);
926 /* Return non-zero if NAME is the libpthread shared library.
928 Uses a fairly simplistic heuristic approach where we check
929 the file name against "/libpthread". This can lead to false
930 positives, but this should be good enough in practice. */
933 libpthread_name_p (const char *name)
935 return (strstr (name, "/libpthread") != NULL);
938 /* Return non-zero if SO is the libpthread shared library. */
941 libpthread_solib_p (struct so_list *so)
943 return libpthread_name_p (so->so_name);
946 /* Read in symbolic information for any shared objects whose names
947 match PATTERN. (If we've already read a shared object's symbol
948 info, leave it alone.) If PATTERN is zero, read them all.
950 If READSYMS is 0, defer reading symbolic information until later
951 but still do any needed low level processing.
953 FROM_TTY is described for update_solib_list, above. */
956 solib_add (const char *pattern, int from_tty, int readsyms)
960 if (print_symbol_loading_p (from_tty, 0, 0))
964 printf_unfiltered (_("Loading symbols for shared libraries: %s\n"),
968 printf_unfiltered (_("Loading symbols for shared libraries.\n"));
971 current_program_space->solib_add_generation++;
975 char *re_err = re_comp (pattern);
978 error (_("Invalid regexp: %s"), re_err);
981 update_solib_list (from_tty);
983 /* Walk the list of currently loaded shared libraries, and read
984 symbols for any that match the pattern --- or any whose symbols
985 aren't already loaded, if no pattern was given. */
988 int loaded_any_symbols = 0;
989 symfile_add_flags add_flags = SYMFILE_DEFER_BP_RESET;
992 add_flags |= SYMFILE_VERBOSE;
994 for (gdb = so_list_head; gdb; gdb = gdb->next)
995 if (! pattern || re_exec (gdb->so_name))
997 /* Normally, we would read the symbols from that library
998 only if READSYMS is set. However, we're making a small
999 exception for the pthread library, because we sometimes
1000 need the library symbols to be loaded in order to provide
1001 thread support (x86-linux for instance). */
1002 const int add_this_solib =
1003 (readsyms || libpthread_solib_p (gdb));
1008 if (gdb->symbols_loaded)
1010 /* If no pattern was given, be quiet for shared
1011 libraries we have already loaded. */
1012 if (pattern && (from_tty || info_verbose))
1013 printf_unfiltered (_("Symbols already loaded for %s\n"),
1016 else if (solib_read_symbols (gdb, add_flags))
1017 loaded_any_symbols = 1;
1021 if (loaded_any_symbols)
1022 breakpoint_re_set ();
1024 if (from_tty && pattern && ! any_matches)
1026 ("No loaded shared libraries match the pattern `%s'.\n", pattern);
1028 if (loaded_any_symbols)
1030 /* Getting new symbols may change our opinion about what is
1032 reinit_frame_cache ();
1037 /* Implement the "info sharedlibrary" command. Walk through the
1038 shared library list and print information about each attached
1039 library matching PATTERN. If PATTERN is elided, print them
1043 info_sharedlibrary_command (char *pattern, int from_tty)
1045 struct so_list *so = NULL; /* link map state variable */
1046 int so_missing_debug_info = 0;
1049 struct cleanup *table_cleanup;
1050 struct gdbarch *gdbarch = target_gdbarch ();
1051 struct ui_out *uiout = current_uiout;
1055 char *re_err = re_comp (pattern);
1058 error (_("Invalid regexp: %s"), re_err);
1061 /* "0x", a little whitespace, and two hex digits per byte of pointers. */
1062 addr_width = 4 + (gdbarch_ptr_bit (gdbarch) / 4);
1064 update_solib_list (from_tty);
1066 /* make_cleanup_ui_out_table_begin_end needs to know the number of
1067 rows, so we need to make two passes over the libs. */
1069 for (nr_libs = 0, so = so_list_head; so; so = so->next)
1073 if (pattern && ! re_exec (so->so_name))
1080 make_cleanup_ui_out_table_begin_end (uiout, 4, nr_libs,
1081 "SharedLibraryTable");
1083 /* The "- 1" is because ui_out adds one space between columns. */
1084 uiout->table_header (addr_width - 1, ui_left, "from", "From");
1085 uiout->table_header (addr_width - 1, ui_left, "to", "To");
1086 uiout->table_header (12 - 1, ui_left, "syms-read", "Syms Read");
1087 uiout->table_header (0, ui_noalign, "name", "Shared Object Library");
1089 uiout->table_body ();
1093 struct cleanup *lib_cleanup;
1095 if (! so->so_name[0])
1097 if (pattern && ! re_exec (so->so_name))
1100 lib_cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, "lib");
1102 if (so->addr_high != 0)
1104 uiout->field_core_addr ("from", gdbarch, so->addr_low);
1105 uiout->field_core_addr ("to", gdbarch, so->addr_high);
1109 uiout->field_skip ("from");
1110 uiout->field_skip ("to");
1113 if (! interp_ui_out (top_level_interpreter ())->is_mi_like_p ()
1114 && so->symbols_loaded
1115 && !objfile_has_symbols (so->objfile))
1117 so_missing_debug_info = 1;
1118 uiout->field_string ("syms-read", "Yes (*)");
1121 uiout->field_string ("syms-read", so->symbols_loaded ? "Yes" : "No");
1123 uiout->field_string ("name", so->so_name);
1127 do_cleanups (lib_cleanup);
1130 do_cleanups (table_cleanup);
1135 uiout->message (_("No shared libraries matched.\n"));
1137 uiout->message (_("No shared libraries loaded at this time.\n"));
1141 if (so_missing_debug_info)
1142 uiout->message (_("(*): Shared library is missing "
1143 "debugging information.\n"));
1147 /* Return 1 if ADDRESS lies within SOLIB. */
1150 solib_contains_address_p (const struct so_list *const solib,
1153 struct target_section *p;
1155 for (p = solib->sections; p < solib->sections_end; p++)
1156 if (p->addr <= address && address < p->endaddr)
1162 /* If ADDRESS is in a shared lib in program space PSPACE, return its
1165 Provides a hook for other gdb routines to discover whether or not a
1166 particular address is within the mapped address space of a shared
1169 For example, this routine is called at one point to disable
1170 breakpoints which are in shared libraries that are not currently
1174 solib_name_from_address (struct program_space *pspace, CORE_ADDR address)
1176 struct so_list *so = NULL;
1178 for (so = pspace->so_list; so; so = so->next)
1179 if (solib_contains_address_p (so, address))
1180 return (so->so_name);
1185 /* Return whether the data starting at VADDR, size SIZE, must be kept
1186 in a core file for shared libraries loaded before "gcore" is used
1187 to be handled correctly when the core file is loaded. This only
1188 applies when the section would otherwise not be kept in the core
1189 file (in particular, for readonly sections). */
1192 solib_keep_data_in_core (CORE_ADDR vaddr, unsigned long size)
1194 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1196 if (ops->keep_data_in_core)
1197 return ops->keep_data_in_core (vaddr, size);
1202 /* Called by free_all_symtabs */
1207 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1209 disable_breakpoints_in_shlibs ();
1211 while (so_list_head)
1213 struct so_list *so = so_list_head;
1215 so_list_head = so->next;
1216 observer_notify_solib_unloaded (so);
1217 remove_target_sections (so);
1221 ops->clear_solib ();
1224 /* Shared library startup support. When GDB starts up the inferior,
1225 it nurses it along (through the shell) until it is ready to execute
1226 its first instruction. At this point, this function gets
1230 solib_create_inferior_hook (int from_tty)
1232 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1234 ops->solib_create_inferior_hook (from_tty);
1237 /* Check to see if an address is in the dynamic loader's dynamic
1238 symbol resolution code. Return 1 if so, 0 otherwise. */
1241 in_solib_dynsym_resolve_code (CORE_ADDR pc)
1243 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1245 return ops->in_dynsym_resolve_code (pc);
1248 /* Implements the "sharedlibrary" command. */
1251 sharedlibrary_command (char *args, int from_tty)
1254 solib_add (args, from_tty, 1);
1257 /* Implements the command "nosharedlibrary", which discards symbols
1258 that have been auto-loaded from shared libraries. Symbols from
1259 shared libraries that were added by explicit request of the user
1260 are not discarded. Also called from remote.c. */
1263 no_shared_libraries (char *ignored, int from_tty)
1265 /* The order of the two routines below is important: clear_solib notifies
1266 the solib_unloaded observers, and some of these observers might need
1267 access to their associated objfiles. Therefore, we can not purge the
1268 solibs' objfiles before clear_solib has been called. */
1271 objfile_purge_solibs ();
1277 update_solib_breakpoints (void)
1279 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1281 if (ops->update_breakpoints != NULL)
1282 ops->update_breakpoints ();
1288 handle_solib_event (void)
1290 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1292 if (ops->handle_event != NULL)
1293 ops->handle_event ();
1295 clear_program_space_solib_cache (current_inferior ()->pspace);
1297 /* Check for any newly added shared libraries if we're supposed to
1298 be adding them automatically. Switch terminal for any messages
1299 produced by breakpoint_re_set. */
1300 target_terminal_ours_for_output ();
1301 solib_add (NULL, 0, auto_solib_add);
1302 target_terminal_inferior ();
1305 /* Reload shared libraries, but avoid reloading the same symbol file
1306 we already have loaded. */
1309 reload_shared_libraries_1 (int from_tty)
1312 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
1314 if (print_symbol_loading_p (from_tty, 0, 0))
1315 printf_unfiltered (_("Loading symbols for shared libraries.\n"));
1317 for (so = so_list_head; so != NULL; so = so->next)
1319 char *filename, *found_pathname = NULL;
1320 int was_loaded = so->symbols_loaded;
1321 symfile_add_flags add_flags = SYMFILE_DEFER_BP_RESET;
1324 add_flags |= SYMFILE_VERBOSE;
1326 filename = tilde_expand (so->so_original_name);
1327 make_cleanup (xfree, filename);
1328 gdb_bfd_ref_ptr abfd (solib_bfd_open (filename));
1331 found_pathname = xstrdup (bfd_get_filename (abfd.get ()));
1332 make_cleanup (xfree, found_pathname);
1335 /* If this shared library is no longer associated with its previous
1336 symbol file, close that. */
1337 if ((found_pathname == NULL && was_loaded)
1338 || (found_pathname != NULL
1339 && filename_cmp (found_pathname, so->so_name) != 0))
1341 if (so->objfile && ! (so->objfile->flags & OBJF_USERLOADED)
1342 && !solib_used (so))
1343 free_objfile (so->objfile);
1344 remove_target_sections (so);
1348 /* If this shared library is now associated with a new symbol
1350 if (found_pathname != NULL
1352 || filename_cmp (found_pathname, so->so_name) != 0))
1358 solib_map_sections (so);
1361 CATCH (e, RETURN_MASK_ERROR)
1363 exception_fprintf (gdb_stderr, e,
1364 _("Error while mapping "
1365 "shared library sections:\n"));
1371 && (auto_solib_add || was_loaded || libpthread_solib_p (so)))
1372 solib_read_symbols (so, add_flags);
1376 do_cleanups (old_chain);
1380 reload_shared_libraries (char *ignored, int from_tty,
1381 struct cmd_list_element *e)
1383 const struct target_so_ops *ops;
1385 reload_shared_libraries_1 (from_tty);
1387 ops = solib_ops (target_gdbarch ());
1389 /* Creating inferior hooks here has two purposes. First, if we reload
1390 shared libraries then the address of solib breakpoint we've computed
1391 previously might be no longer valid. For example, if we forgot to set
1392 solib-absolute-prefix and are setting it right now, then the previous
1393 breakpoint address is plain wrong. Second, installing solib hooks
1394 also implicitly figures were ld.so is and loads symbols for it.
1395 Absent this call, if we've just connected to a target and set
1396 solib-absolute-prefix or solib-search-path, we'll lose all information
1398 if (target_has_execution)
1400 /* Reset or free private data structures not associated with
1402 ops->clear_solib ();
1404 /* Remove any previous solib event breakpoint. This is usually
1405 done in common code, at breakpoint_init_inferior time, but
1406 we're not really starting up the inferior here. */
1407 remove_solib_event_breakpoints ();
1409 solib_create_inferior_hook (from_tty);
1412 /* Sometimes the platform-specific hook loads initial shared
1413 libraries, and sometimes it doesn't. If it doesn't FROM_TTY will be
1414 incorrectly 0 but such solib targets should be fixed anyway. If we
1415 made all the inferior hook methods consistent, this call could be
1416 removed. Call it only after the solib target has been initialized by
1417 solib_create_inferior_hook. */
1419 solib_add (NULL, 0, auto_solib_add);
1421 breakpoint_re_set ();
1423 /* We may have loaded or unloaded debug info for some (or all)
1424 shared libraries. However, frames may still reference them. For
1425 example, a frame's unwinder might still point at DWARF FDE
1426 structures that are now freed. Also, getting new symbols may
1427 change our opinion about what is frameless. */
1428 reinit_frame_cache ();
1431 /* Wrapper for reload_shared_libraries that replaces "remote:"
1432 at the start of gdb_sysroot with "target:". */
1435 gdb_sysroot_changed (char *ignored, int from_tty,
1436 struct cmd_list_element *e)
1438 const char *old_prefix = "remote:";
1439 const char *new_prefix = TARGET_SYSROOT_PREFIX;
1441 if (startswith (gdb_sysroot, old_prefix))
1443 static int warning_issued = 0;
1445 gdb_assert (strlen (old_prefix) == strlen (new_prefix));
1446 memcpy (gdb_sysroot, new_prefix, strlen (new_prefix));
1448 if (!warning_issued)
1450 warning (_("\"%s\" is deprecated, use \"%s\" instead."),
1451 old_prefix, new_prefix);
1452 warning (_("sysroot set to \"%s\"."), gdb_sysroot);
1458 reload_shared_libraries (ignored, from_tty, e);
1462 show_auto_solib_add (struct ui_file *file, int from_tty,
1463 struct cmd_list_element *c, const char *value)
1465 fprintf_filtered (file, _("Autoloading of shared library symbols is %s.\n"),
1470 /* Handler for library-specific lookup of global symbol NAME in OBJFILE. Call
1471 the library-specific handler if it is installed for the current target. */
1474 solib_global_lookup (struct objfile *objfile,
1476 const domain_enum domain)
1478 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1480 if (ops->lookup_lib_global_symbol != NULL)
1481 return ops->lookup_lib_global_symbol (objfile, name, domain);
1482 return (struct block_symbol) {NULL, NULL};
1485 /* Lookup the value for a specific symbol from dynamic symbol table. Look
1486 up symbol from ABFD. MATCH_SYM is a callback function to determine
1487 whether to pick up a symbol. DATA is the input of this callback
1488 function. Return NULL if symbol is not found. */
1491 gdb_bfd_lookup_symbol_from_symtab (bfd *abfd,
1492 int (*match_sym) (const asymbol *,
1496 long storage_needed = bfd_get_symtab_upper_bound (abfd);
1497 CORE_ADDR symaddr = 0;
1499 if (storage_needed > 0)
1503 asymbol **symbol_table = (asymbol **) xmalloc (storage_needed);
1504 struct cleanup *back_to = make_cleanup (xfree, symbol_table);
1505 unsigned int number_of_symbols =
1506 bfd_canonicalize_symtab (abfd, symbol_table);
1508 for (i = 0; i < number_of_symbols; i++)
1510 asymbol *sym = *symbol_table++;
1512 if (match_sym (sym, data))
1514 struct gdbarch *gdbarch = target_gdbarch ();
1515 symaddr = sym->value;
1517 /* Some ELF targets fiddle with addresses of symbols they
1518 consider special. They use minimal symbols to do that
1519 and this is needed for correct breakpoint placement,
1520 but we do not have full data here to build a complete
1521 minimal symbol, so just set the address and let the
1522 targets cope with that. */
1523 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour
1524 && gdbarch_elf_make_msymbol_special_p (gdbarch))
1526 struct minimal_symbol msym;
1528 memset (&msym, 0, sizeof (msym));
1529 SET_MSYMBOL_VALUE_ADDRESS (&msym, symaddr);
1530 gdbarch_elf_make_msymbol_special (gdbarch, sym, &msym);
1531 symaddr = MSYMBOL_VALUE_RAW_ADDRESS (&msym);
1534 /* BFD symbols are section relative. */
1535 symaddr += sym->section->vma;
1539 do_cleanups (back_to);
1545 /* Lookup the value for a specific symbol from symbol table. Look up symbol
1546 from ABFD. MATCH_SYM is a callback function to determine whether to pick
1547 up a symbol. DATA is the input of this callback function. Return NULL
1548 if symbol is not found. */
1551 bfd_lookup_symbol_from_dyn_symtab (bfd *abfd,
1552 int (*match_sym) (const asymbol *,
1556 long storage_needed = bfd_get_dynamic_symtab_upper_bound (abfd);
1557 CORE_ADDR symaddr = 0;
1559 if (storage_needed > 0)
1562 asymbol **symbol_table = (asymbol **) xmalloc (storage_needed);
1563 struct cleanup *back_to = make_cleanup (xfree, symbol_table);
1564 unsigned int number_of_symbols =
1565 bfd_canonicalize_dynamic_symtab (abfd, symbol_table);
1567 for (i = 0; i < number_of_symbols; i++)
1569 asymbol *sym = *symbol_table++;
1571 if (match_sym (sym, data))
1573 /* BFD symbols are section relative. */
1574 symaddr = sym->value + sym->section->vma;
1578 do_cleanups (back_to);
1583 /* Lookup the value for a specific symbol from symbol table and dynamic
1584 symbol table. Look up symbol from ABFD. MATCH_SYM is a callback
1585 function to determine whether to pick up a symbol. DATA is the
1586 input of this callback function. Return NULL if symbol is not
1590 gdb_bfd_lookup_symbol (bfd *abfd,
1591 int (*match_sym) (const asymbol *, const void *),
1594 CORE_ADDR symaddr = gdb_bfd_lookup_symbol_from_symtab (abfd, match_sym, data);
1596 /* On FreeBSD, the dynamic linker is stripped by default. So we'll
1597 have to check the dynamic string table too. */
1599 symaddr = bfd_lookup_symbol_from_dyn_symtab (abfd, match_sym, data);
1604 /* SO_LIST_HEAD may contain user-loaded object files that can be removed
1605 out-of-band by the user. So upon notification of free_objfile remove
1606 all references to any user-loaded file that is about to be freed. */
1609 remove_user_added_objfile (struct objfile *objfile)
1613 if (objfile != 0 && objfile->flags & OBJF_USERLOADED)
1615 for (so = so_list_head; so != NULL; so = so->next)
1616 if (so->objfile == objfile)
1621 extern initialize_file_ftype _initialize_solib; /* -Wmissing-prototypes */
1624 _initialize_solib (void)
1626 solib_data = gdbarch_data_register_pre_init (solib_init);
1628 observer_attach_free_objfile (remove_user_added_objfile);
1630 add_com ("sharedlibrary", class_files, sharedlibrary_command,
1631 _("Load shared object library symbols for files matching REGEXP."));
1632 add_info ("sharedlibrary", info_sharedlibrary_command,
1633 _("Status of loaded shared object libraries."));
1634 add_info_alias ("dll", "sharedlibrary", 1);
1635 add_com ("nosharedlibrary", class_files, no_shared_libraries,
1636 _("Unload all shared object library symbols."));
1638 add_setshow_boolean_cmd ("auto-solib-add", class_support,
1639 &auto_solib_add, _("\
1640 Set autoloading of shared library symbols."), _("\
1641 Show autoloading of shared library symbols."), _("\
1642 If \"on\", symbols from all shared object libraries will be loaded\n\
1643 automatically when the inferior begins execution, when the dynamic linker\n\
1644 informs gdb that a new library has been loaded, or when attaching to the\n\
1645 inferior. Otherwise, symbols must be loaded manually, using \
1648 show_auto_solib_add,
1649 &setlist, &showlist);
1651 add_setshow_optional_filename_cmd ("sysroot", class_support,
1653 Set an alternate system root."), _("\
1654 Show the current system root."), _("\
1655 The system root is used to load absolute shared library symbol files.\n\
1656 For other (relative) files, you can add directories using\n\
1657 `set solib-search-path'."),
1658 gdb_sysroot_changed,
1660 &setlist, &showlist);
1662 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1664 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1667 add_setshow_optional_filename_cmd ("solib-search-path", class_support,
1668 &solib_search_path, _("\
1669 Set the search path for loading non-absolute shared library symbol files."),
1671 Show the search path for loading non-absolute shared library symbol files."),
1673 This takes precedence over the environment variables \
1674 PATH and LD_LIBRARY_PATH."),
1675 reload_shared_libraries,
1676 show_solib_search_path,
1677 &setlist, &showlist);