1 /* Handle shared libraries for GDB, the GNU Debugger.
3 Copyright (C) 1990-2016 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 /* List of known shared objects */
93 #define so_list_head current_program_space->so_list
95 /* Local function prototypes */
97 /* If non-empty, this is a search path for loading non-absolute shared library
98 symbol files. This takes precedence over the environment variables PATH
99 and LD_LIBRARY_PATH. */
100 static char *solib_search_path = NULL;
102 show_solib_search_path (struct ui_file *file, int from_tty,
103 struct cmd_list_element *c, const char *value)
105 fprintf_filtered (file, _("The search path for loading non-absolute "
106 "shared library symbol files is %s.\n"),
110 /* Same as HAVE_DOS_BASED_FILE_SYSTEM, but useable as an rvalue. */
111 #if (HAVE_DOS_BASED_FILE_SYSTEM)
112 # define DOS_BASED_FILE_SYSTEM 1
114 # define DOS_BASED_FILE_SYSTEM 0
117 /* Return the full pathname of a binary file (the main executable
118 or a shared library file), or NULL if not found. The returned
119 pathname is malloc'ed and must be freed by the caller. If FD
120 is non-NULL, *FD is set to either -1 or an open file handle for
123 Global variable GDB_SYSROOT is used as a prefix directory
124 to search for binary files if they have an absolute path.
125 If GDB_SYSROOT starts with "target:" and target filesystem
126 is the local filesystem then the "target:" prefix will be
127 stripped before the search starts. This ensures that the
128 same search algorithm is used for local files regardless of
129 whether a "target:" prefix was used.
131 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
132 (or set of directories, as in LD_LIBRARY_PATH) to search for all
133 shared libraries if not found in either the sysroot (if set) or
134 the local filesystem. SOLIB_SEARCH_PATH is not used when searching
135 for the main executable.
138 * If a sysroot is set and path is absolute:
139 * Search for sysroot/path.
141 * Look for it literally (unmodified).
142 * If IS_SOLIB is non-zero:
143 * Look in SOLIB_SEARCH_PATH.
144 * If available, use target defined search function.
145 * If NO sysroot is set, perform the following two searches:
146 * Look in inferior's $PATH.
147 * If IS_SOLIB is non-zero:
148 * Look in inferior's $LD_LIBRARY_PATH.
150 * The last check avoids doing this search when targetting remote
151 * machines since a sysroot will almost always be set.
155 solib_find_1 (char *in_pathname, int *fd, int is_solib)
157 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
159 char *temp_pathname = NULL;
160 const char *fskind = effective_target_file_system_kind ();
161 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
162 char *sysroot = gdb_sysroot;
163 int prefix_len, orig_prefix_len;
165 /* If the absolute prefix starts with "target:" but the filesystem
166 accessed by the target_fileio_* methods is the local filesystem
167 then we strip the "target:" prefix now and work with the local
168 filesystem. This ensures that the same search algorithm is used
169 for all local files regardless of whether a "target:" prefix was
171 if (is_target_filename (sysroot) && target_filesystem_is_local ())
172 sysroot += strlen (TARGET_SYSROOT_PREFIX);
174 /* Strip any trailing slashes from the absolute prefix. */
175 prefix_len = orig_prefix_len = strlen (sysroot);
177 while (prefix_len > 0 && IS_DIR_SEPARATOR (sysroot[prefix_len - 1]))
182 else if (prefix_len != orig_prefix_len)
184 sysroot = savestring (sysroot, prefix_len);
185 make_cleanup (xfree, sysroot);
188 /* If we're on a non-DOS-based system, backslashes won't be
189 understood as directory separator, so, convert them to forward
190 slashes, iff we're supposed to handle DOS-based file system
191 semantics for target paths. */
192 if (!DOS_BASED_FILE_SYSTEM && fskind == file_system_kind_dos_based)
196 /* Avoid clobbering our input. */
197 p = (char *) alloca (strlen (in_pathname) + 1);
198 strcpy (p, in_pathname);
208 /* Note, we're interested in IS_TARGET_ABSOLUTE_PATH, not
209 IS_ABSOLUTE_PATH. The latter is for host paths only, while
210 IN_PATHNAME is a target path. For example, if we're supposed to
211 be handling DOS-like semantics we want to consider a
212 'c:/foo/bar.dll' path as an absolute path, even on a Unix box.
213 With such a path, before giving up on the sysroot, we'll try:
215 1st attempt, c:/foo/bar.dll ==> /sysroot/c:/foo/bar.dll
216 2nd attempt, c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll
217 3rd attempt, c:/foo/bar.dll ==> /sysroot/foo/bar.dll
220 if (!IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname) || sysroot == NULL)
221 temp_pathname = xstrdup (in_pathname);
224 int need_dir_separator;
226 /* Concatenate the sysroot and the target reported filename. We
227 may need to glue them with a directory separator. Cases to
230 | sysroot | separator | in_pathname |
231 |-----------------+-----------+----------------|
232 | /some/dir | / | c:/foo/bar.dll |
233 | /some/dir | | /foo/bar.dll |
234 | target: | | c:/foo/bar.dll |
235 | target: | | /foo/bar.dll |
236 | target:some/dir | / | c:/foo/bar.dll |
237 | target:some/dir | | /foo/bar.dll |
239 IOW, we don't need to add a separator if IN_PATHNAME already
240 has one, or when the the sysroot is exactly "target:".
241 There's no need to check for drive spec explicitly, as we only
242 get here if IN_PATHNAME is considered an absolute path. */
243 need_dir_separator = !(IS_DIR_SEPARATOR (in_pathname[0])
244 || strcmp (TARGET_SYSROOT_PREFIX, sysroot) == 0);
246 /* Cat the prefixed pathname together. */
247 temp_pathname = concat (sysroot,
248 need_dir_separator ? SLASH_STRING : "",
249 in_pathname, (char *) NULL);
252 /* Handle files to be accessed via the target. */
253 if (is_target_filename (temp_pathname))
257 do_cleanups (old_chain);
258 return temp_pathname;
261 /* Now see if we can open it. */
262 found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
264 xfree (temp_pathname);
266 /* If the search in gdb_sysroot failed, and the path name has a
267 drive spec (e.g, c:/foo), try stripping ':' from the drive spec,
268 and retrying in the sysroot:
269 c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll. */
273 && HAS_TARGET_DRIVE_SPEC (fskind, in_pathname))
275 int need_dir_separator = !IS_DIR_SEPARATOR (in_pathname[2]);
276 char *drive = savestring (in_pathname, 1);
278 temp_pathname = concat (sysroot,
281 need_dir_separator ? SLASH_STRING : "",
282 in_pathname + 2, (char *) NULL);
285 found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
288 xfree (temp_pathname);
290 /* If the search in gdb_sysroot still failed, try fully
291 stripping the drive spec, and trying once more in the
292 sysroot before giving up.
294 c:/foo/bar.dll ==> /sysroot/foo/bar.dll. */
296 temp_pathname = concat (sysroot,
297 need_dir_separator ? SLASH_STRING : "",
298 in_pathname + 2, (char *) NULL);
300 found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
302 xfree (temp_pathname);
306 do_cleanups (old_chain);
308 /* We try to find the library in various ways. After each attempt,
309 either found_file >= 0 and temp_pathname is a malloc'd string, or
310 found_file < 0 and temp_pathname does not point to storage that
311 needs to be freed. */
314 temp_pathname = NULL;
316 /* If the search in gdb_sysroot failed, and the path name is
317 absolute at this point, make it relative. (openp will try and open the
318 file according to its absolute path otherwise, which is not what we want.)
319 Affects subsequent searches for this solib. */
320 if (found_file < 0 && IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname))
322 /* First, get rid of any drive letters etc. */
323 while (!IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
326 /* Next, get rid of all leading dir separators. */
327 while (IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
331 /* If not found, and we're looking for a solib, search the
332 solib_search_path (if any). */
333 if (is_solib && found_file < 0 && solib_search_path != NULL)
334 found_file = openp (solib_search_path,
335 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
336 in_pathname, O_RDONLY | O_BINARY, &temp_pathname);
338 /* If not found, and we're looking for a solib, next search the
339 solib_search_path (if any) for the basename only (ignoring the
340 path). This is to allow reading solibs from a path that differs
341 from the opened path. */
342 if (is_solib && found_file < 0 && solib_search_path != NULL)
343 found_file = openp (solib_search_path,
344 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
345 target_lbasename (fskind, in_pathname),
346 O_RDONLY | O_BINARY, &temp_pathname);
348 /* If not found, and we're looking for a solib, try to use target
349 supplied solib search method. */
350 if (is_solib && found_file < 0 && ops->find_and_open_solib)
351 found_file = ops->find_and_open_solib (in_pathname, O_RDONLY | O_BINARY,
354 /* If not found, next search the inferior's $PATH environment variable. */
355 if (found_file < 0 && sysroot == NULL)
356 found_file = openp (get_in_environ (current_inferior ()->environment,
358 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
359 O_RDONLY | O_BINARY, &temp_pathname);
361 /* If not found, and we're looking for a solib, next search the
362 inferior's $LD_LIBRARY_PATH environment variable. */
363 if (is_solib && found_file < 0 && sysroot == NULL)
364 found_file = openp (get_in_environ (current_inferior ()->environment,
366 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
367 O_RDONLY | O_BINARY, &temp_pathname);
377 return temp_pathname;
380 /* Return the full pathname of the main executable, or NULL if not
381 found. The returned pathname is malloc'ed and must be freed by
382 the caller. If FD is non-NULL, *FD is set to either -1 or an open
383 file handle for the main executable. */
386 exec_file_find (char *in_pathname, int *fd)
389 const char *fskind = effective_target_file_system_kind ();
391 if (in_pathname == NULL)
394 if (*gdb_sysroot != '\0' && IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname))
396 result = solib_find_1 (in_pathname, fd, 0);
398 if (result == NULL && fskind == file_system_kind_dos_based)
402 new_pathname = (char *) alloca (strlen (in_pathname) + 5);
403 strcpy (new_pathname, in_pathname);
404 strcat (new_pathname, ".exe");
406 result = solib_find_1 (new_pathname, fd, 0);
411 /* It's possible we don't have a full path, but rather just a
412 filename. Some targets, such as HP-UX, don't provide the
415 Attempt to qualify the filename against the source path.
416 (If that fails, we'll just fall back on the original
417 filename. Not much more we can do...) */
419 if (!source_full_path_of (in_pathname, &result))
420 result = xstrdup (in_pathname);
428 /* Return the full pathname of a shared library file, or NULL if not
429 found. The returned pathname is malloc'ed and must be freed by
430 the caller. If FD is non-NULL, *FD is set to either -1 or an open
431 file handle for the shared library.
433 The search algorithm used is described in solib_find_1's comment
437 solib_find (char *in_pathname, int *fd)
439 const char *solib_symbols_extension
440 = gdbarch_solib_symbols_extension (target_gdbarch ());
442 /* If solib_symbols_extension is set, replace the file's
444 if (solib_symbols_extension != NULL)
446 char *p = in_pathname + strlen (in_pathname);
448 while (p > in_pathname && *p != '.')
456 = (char *) alloca (p - in_pathname + 1
457 + strlen (solib_symbols_extension) + 1);
458 memcpy (new_pathname, in_pathname, p - in_pathname + 1);
459 strcpy (new_pathname + (p - in_pathname) + 1,
460 solib_symbols_extension);
462 in_pathname = new_pathname;
466 return solib_find_1 (in_pathname, fd, 1);
469 /* Open and return a BFD for the shared library PATHNAME. If FD is not -1,
470 it is used as file handle to open the file. Throws an error if the file
471 could not be opened. Handles both local and remote file access.
473 PATHNAME must be malloc'ed by the caller. It will be freed by this
474 function. If unsuccessful, the FD will be closed (unless FD was
478 solib_bfd_fopen (char *pathname, int fd)
480 bfd *abfd = gdb_bfd_open (pathname, gnutarget, fd);
482 if (abfd != NULL && !gdb_bfd_has_target_filename (abfd))
483 bfd_set_cacheable (abfd, 1);
487 make_cleanup (xfree, pathname);
488 error (_("Could not open `%s' as an executable file: %s"),
489 pathname, bfd_errmsg (bfd_get_error ()));
497 /* Find shared library PATHNAME and open a BFD for it. */
500 solib_bfd_open (char *pathname)
502 char *found_pathname;
505 const struct bfd_arch_info *b;
507 /* Search for shared library file. */
508 found_pathname = solib_find (pathname, &found_file);
509 if (found_pathname == NULL)
511 /* Return failure if the file could not be found, so that we can
512 accumulate messages about missing libraries. */
516 perror_with_name (pathname);
519 /* Open bfd for shared library. */
520 abfd = solib_bfd_fopen (found_pathname, found_file);
522 /* Check bfd format. */
523 if (!bfd_check_format (abfd, bfd_object))
525 make_cleanup_bfd_unref (abfd);
526 error (_("`%s': not in executable format: %s"),
527 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
530 /* Check bfd arch. */
531 b = gdbarch_bfd_arch_info (target_gdbarch ());
532 if (!b->compatible (b, bfd_get_arch_info (abfd)))
533 warning (_("`%s': Shared library architecture %s is not compatible "
534 "with target architecture %s."), bfd_get_filename (abfd),
535 bfd_get_arch_info (abfd)->printable_name, b->printable_name);
540 /* Given a pointer to one of the shared objects in our list of mapped
541 objects, use the recorded name to open a bfd descriptor for the
542 object, build a section table, relocate all the section addresses
543 by the base address at which the shared object was mapped, and then
544 add the sections to the target's section table.
546 FIXME: In most (all?) cases the shared object file name recorded in
547 the dynamic linkage tables will be a fully qualified pathname. For
548 cases where it isn't, do we really mimic the systems search
549 mechanism correctly in the below code (particularly the tilde
550 expansion stuff?). */
553 solib_map_sections (struct so_list *so)
555 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
557 struct target_section *p;
558 struct cleanup *old_chain;
561 filename = tilde_expand (so->so_name);
562 old_chain = make_cleanup (xfree, filename);
563 abfd = ops->bfd_open (filename);
564 do_cleanups (old_chain);
569 /* Leave bfd open, core_xfer_memory and "info files" need it. */
572 /* Copy the full path name into so_name, allowing symbol_file_add
573 to find it later. This also affects the =library-loaded GDB/MI
574 event, and in particular the part of that notification providing
575 the library's host-side path. If we let the target dictate
576 that objfile's path, and the target is different from the host,
577 GDB/MI will not provide the correct host-side path. */
578 if (strlen (bfd_get_filename (abfd)) >= SO_NAME_MAX_PATH_SIZE)
579 error (_("Shared library file name is too long."));
580 strcpy (so->so_name, bfd_get_filename (abfd));
582 if (build_section_table (abfd, &so->sections, &so->sections_end))
584 error (_("Can't find the file sections in `%s': %s"),
585 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
588 for (p = so->sections; p < so->sections_end; p++)
590 /* Relocate the section binding addresses as recorded in the shared
591 object's file by the base address to which the object was actually
593 ops->relocate_section_addresses (so, p);
595 /* If the target didn't provide information about the address
596 range of the shared object, assume we want the location of
597 the .text section. */
598 if (so->addr_low == 0 && so->addr_high == 0
599 && strcmp (p->the_bfd_section->name, ".text") == 0)
601 so->addr_low = p->addr;
602 so->addr_high = p->endaddr;
606 /* Add the shared object's sections to the current set of file
607 section tables. Do this immediately after mapping the object so
608 that later nodes in the list can query this object, as is needed
610 add_target_sections (so, so->sections, so->sections_end);
615 /* Free symbol-file related contents of SO and reset for possible reloading
616 of SO. If we have opened a BFD for SO, close it. If we have placed SO's
617 sections in some target's section table, the caller is responsible for
620 This function doesn't mess with objfiles at all. If there is an
621 objfile associated with SO that needs to be removed, the caller is
622 responsible for taking care of that. */
625 clear_so (struct so_list *so)
627 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
631 xfree (so->sections);
632 so->sections = so->sections_end = NULL;
635 gdb_bfd_unref (so->abfd);
638 /* Our caller closed the objfile, possibly via objfile_purge_solibs. */
639 so->symbols_loaded = 0;
642 so->addr_low = so->addr_high = 0;
644 /* Restore the target-supplied file name. SO_NAME may be the path
645 of the symbol file. */
646 strcpy (so->so_name, so->so_original_name);
648 /* Do the same for target-specific data. */
649 if (ops->clear_so != NULL)
653 /* Free the storage associated with the `struct so_list' object SO.
654 If we have opened a BFD for SO, close it.
656 The caller is responsible for removing SO from whatever list it is
657 a member of. If we have placed SO's sections in some target's
658 section table, the caller is responsible for removing them.
660 This function doesn't mess with objfiles at all. If there is an
661 objfile associated with SO that needs to be removed, the caller is
662 responsible for taking care of that. */
665 free_so (struct so_list *so)
667 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
676 /* Return address of first so_list entry in master shared object list. */
678 master_so_list (void)
683 /* Read in symbols for shared object SO. If SYMFILE_VERBOSE is set in FLAGS,
684 be chatty about it. Return non-zero if any symbols were actually
688 solib_read_symbols (struct so_list *so, symfile_add_flags flags)
690 if (so->symbols_loaded)
692 /* If needed, we've already warned in our caller. */
694 else if (so->abfd == NULL)
696 /* We've already warned about this library, when trying to open
702 flags |= current_inferior ()->symfile_flags;
706 struct section_addr_info *sap;
708 /* Have we already loaded this shared object? */
709 ALL_OBJFILES (so->objfile)
711 if (filename_cmp (objfile_name (so->objfile), so->so_name) == 0
712 && so->objfile->addr_low == so->addr_low)
715 if (so->objfile == NULL)
717 sap = build_section_addr_info_from_section_table (so->sections,
719 so->objfile = symbol_file_add_from_bfd (so->abfd, so->so_name,
720 flags, sap, OBJF_SHARED,
722 so->objfile->addr_low = so->addr_low;
723 free_section_addr_info (sap);
726 so->symbols_loaded = 1;
728 CATCH (e, RETURN_MASK_ERROR)
730 exception_fprintf (gdb_stderr, e, _("Error while reading shared"
731 " library symbols for %s:\n"),
742 /* Return 1 if KNOWN->objfile is used by any other so_list object in the
743 SO_LIST_HEAD list. Return 0 otherwise. */
746 solib_used (const struct so_list *const known)
748 const struct so_list *pivot;
750 for (pivot = so_list_head; pivot != NULL; pivot = pivot->next)
751 if (pivot != known && pivot->objfile == known->objfile)
756 /* Synchronize GDB's shared object list with inferior's.
758 Extract the list of currently loaded shared objects from the
759 inferior, and compare it with the list of shared objects currently
760 in GDB's so_list_head list. Edit so_list_head to bring it in sync
761 with the inferior's new list.
763 If we notice that the inferior has unloaded some shared objects,
764 free any symbolic info GDB had read about those shared objects.
766 Don't load symbolic info for any new shared objects; just add them
767 to the list, and leave their symbols_loaded flag clear.
769 If FROM_TTY is non-null, feel free to print messages about what
772 If TARGET is non-null, add the sections of all new shared objects
773 to TARGET's section table. Note that this doesn't remove any
774 sections for shared objects that have been unloaded, and it
775 doesn't check to see if the new shared objects are already present in
776 the section table. But we only use this for core files and
777 processes we've just attached to, so that's okay. */
780 update_solib_list (int from_tty, struct target_ops *target)
782 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
783 struct so_list *inferior = ops->current_sos();
784 struct so_list *gdb, **gdb_link;
786 /* We can reach here due to changing solib-search-path or the
787 sysroot, before having any inferior. */
788 if (target_has_execution && !ptid_equal (inferior_ptid, null_ptid))
790 struct inferior *inf = current_inferior ();
792 /* If we are attaching to a running process for which we
793 have not opened a symbol file, we may be able to get its
795 if (inf->attach_flag && symfile_objfile == NULL)
796 catch_errors (ops->open_symbol_file_object, &from_tty,
797 "Error reading attached process's symbol file.\n",
801 /* GDB and the inferior's dynamic linker each maintain their own
802 list of currently loaded shared objects; we want to bring the
803 former in sync with the latter. Scan both lists, seeing which
804 shared objects appear where. There are three cases:
806 - A shared object appears on both lists. This means that GDB
807 knows about it already, and it's still loaded in the inferior.
808 Nothing needs to happen.
810 - A shared object appears only on GDB's list. This means that
811 the inferior has unloaded it. We should remove the shared
812 object from GDB's tables.
814 - A shared object appears only on the inferior's list. This
815 means that it's just been loaded. We should add it to GDB's
818 So we walk GDB's list, checking each entry to see if it appears
819 in the inferior's list too. If it does, no action is needed, and
820 we remove it from the inferior's list. If it doesn't, the
821 inferior has unloaded it, and we remove it from GDB's list. By
822 the time we're done walking GDB's list, the inferior's list
823 contains only the new shared objects, which we then add. */
826 gdb_link = &so_list_head;
829 struct so_list *i = inferior;
830 struct so_list **i_link = &inferior;
832 /* Check to see whether the shared object *gdb also appears in
833 the inferior's current list. */
838 if (ops->same (gdb, i))
843 if (! filename_cmp (gdb->so_original_name, i->so_original_name))
851 /* If the shared object appears on the inferior's list too, then
852 it's still loaded, so we don't need to do anything. Delete
853 it from the inferior's list, and leave it on GDB's list. */
858 gdb_link = &gdb->next;
862 /* If it's not on the inferior's list, remove it from GDB's tables. */
865 /* Notify any observer that the shared object has been
866 unloaded before we remove it from GDB's tables. */
867 observer_notify_solib_unloaded (gdb);
869 VEC_safe_push (char_ptr, current_program_space->deleted_solibs,
870 xstrdup (gdb->so_name));
872 *gdb_link = gdb->next;
874 /* Unless the user loaded it explicitly, free SO's objfile. */
875 if (gdb->objfile && ! (gdb->objfile->flags & OBJF_USERLOADED)
876 && !solib_used (gdb))
877 free_objfile (gdb->objfile);
879 /* Some targets' section tables might be referring to
880 sections from so->abfd; remove them. */
881 remove_target_sections (gdb);
888 /* Now the inferior's list contains only shared objects that don't
889 appear in GDB's list --- those that are newly loaded. Add them
890 to GDB's shared object list. */
894 const char *not_found_filename = NULL;
898 /* Add the new shared objects to GDB's list. */
899 *gdb_link = inferior;
901 /* Fill in the rest of each of the `struct so_list' nodes. */
902 for (i = inferior; i; i = i->next)
905 i->pspace = current_program_space;
906 VEC_safe_push (so_list_ptr, current_program_space->added_solibs, i);
910 /* Fill in the rest of the `struct so_list' node. */
911 if (!solib_map_sections (i))
914 if (not_found_filename == NULL)
915 not_found_filename = i->so_original_name;
919 CATCH (e, RETURN_MASK_ERROR)
921 exception_fprintf (gdb_stderr, e,
922 _("Error while mapping shared "
923 "library sections:\n"));
927 /* Notify any observer that the shared object has been
928 loaded now that we've added it to GDB's tables. */
929 observer_notify_solib_loaded (i);
932 /* If a library was not found, issue an appropriate warning
933 message. We have to use a single call to warning in case the
934 front end does something special with warnings, e.g., pop up
935 a dialog box. It Would Be Nice if we could get a "warning: "
936 prefix on each line in the CLI front end, though - it doesn't
940 warning (_("Could not load shared library symbols for %s.\n"
941 "Do you need \"set solib-search-path\" "
942 "or \"set sysroot\"?"),
944 else if (not_found > 1)
946 Could not load shared library symbols for %d libraries, e.g. %s.\n\
947 Use the \"info sharedlibrary\" command to see the complete listing.\n\
948 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
949 not_found, not_found_filename);
954 /* Return non-zero if NAME is the libpthread shared library.
956 Uses a fairly simplistic heuristic approach where we check
957 the file name against "/libpthread". This can lead to false
958 positives, but this should be good enough in practice. */
961 libpthread_name_p (const char *name)
963 return (strstr (name, "/libpthread") != NULL);
966 /* Return non-zero if SO is the libpthread shared library. */
969 libpthread_solib_p (struct so_list *so)
971 return libpthread_name_p (so->so_name);
974 /* Read in symbolic information for any shared objects whose names
975 match PATTERN. (If we've already read a shared object's symbol
976 info, leave it alone.) If PATTERN is zero, read them all.
978 If READSYMS is 0, defer reading symbolic information until later
979 but still do any needed low level processing.
981 FROM_TTY and TARGET are as described for update_solib_list, above. */
984 solib_add (const char *pattern, int from_tty,
985 struct target_ops *target, int readsyms)
989 if (print_symbol_loading_p (from_tty, 0, 0))
993 printf_unfiltered (_("Loading symbols for shared libraries: %s\n"),
997 printf_unfiltered (_("Loading symbols for shared libraries.\n"));
1000 current_program_space->solib_add_generation++;
1004 char *re_err = re_comp (pattern);
1007 error (_("Invalid regexp: %s"), re_err);
1010 update_solib_list (from_tty, target);
1012 /* Walk the list of currently loaded shared libraries, and read
1013 symbols for any that match the pattern --- or any whose symbols
1014 aren't already loaded, if no pattern was given. */
1016 int any_matches = 0;
1017 int loaded_any_symbols = 0;
1018 symfile_add_flags add_flags = SYMFILE_DEFER_BP_RESET;
1021 add_flags |= SYMFILE_VERBOSE;
1023 for (gdb = so_list_head; gdb; gdb = gdb->next)
1024 if (! pattern || re_exec (gdb->so_name))
1026 /* Normally, we would read the symbols from that library
1027 only if READSYMS is set. However, we're making a small
1028 exception for the pthread library, because we sometimes
1029 need the library symbols to be loaded in order to provide
1030 thread support (x86-linux for instance). */
1031 const int add_this_solib =
1032 (readsyms || libpthread_solib_p (gdb));
1037 if (gdb->symbols_loaded)
1039 /* If no pattern was given, be quiet for shared
1040 libraries we have already loaded. */
1041 if (pattern && (from_tty || info_verbose))
1042 printf_unfiltered (_("Symbols already loaded for %s\n"),
1045 else if (solib_read_symbols (gdb, add_flags))
1046 loaded_any_symbols = 1;
1050 if (loaded_any_symbols)
1051 breakpoint_re_set ();
1053 if (from_tty && pattern && ! any_matches)
1055 ("No loaded shared libraries match the pattern `%s'.\n", pattern);
1057 if (loaded_any_symbols)
1059 /* Getting new symbols may change our opinion about what is
1061 reinit_frame_cache ();
1066 /* Implement the "info sharedlibrary" command. Walk through the
1067 shared library list and print information about each attached
1068 library matching PATTERN. If PATTERN is elided, print them
1072 info_sharedlibrary_command (char *pattern, int from_tty)
1074 struct so_list *so = NULL; /* link map state variable */
1075 int so_missing_debug_info = 0;
1078 struct cleanup *table_cleanup;
1079 struct gdbarch *gdbarch = target_gdbarch ();
1080 struct ui_out *uiout = current_uiout;
1084 char *re_err = re_comp (pattern);
1087 error (_("Invalid regexp: %s"), re_err);
1090 /* "0x", a little whitespace, and two hex digits per byte of pointers. */
1091 addr_width = 4 + (gdbarch_ptr_bit (gdbarch) / 4);
1093 update_solib_list (from_tty, 0);
1095 /* make_cleanup_ui_out_table_begin_end needs to know the number of
1096 rows, so we need to make two passes over the libs. */
1098 for (nr_libs = 0, so = so_list_head; so; so = so->next)
1102 if (pattern && ! re_exec (so->so_name))
1109 make_cleanup_ui_out_table_begin_end (uiout, 4, nr_libs,
1110 "SharedLibraryTable");
1112 /* The "- 1" is because ui_out adds one space between columns. */
1113 ui_out_table_header (uiout, addr_width - 1, ui_left, "from", "From");
1114 ui_out_table_header (uiout, addr_width - 1, ui_left, "to", "To");
1115 ui_out_table_header (uiout, 12 - 1, ui_left, "syms-read", "Syms Read");
1116 ui_out_table_header (uiout, 0, ui_noalign,
1117 "name", "Shared Object Library");
1119 ui_out_table_body (uiout);
1121 for (so = so_list_head; so; so = so->next)
1123 struct cleanup *lib_cleanup;
1125 if (! so->so_name[0])
1127 if (pattern && ! re_exec (so->so_name))
1130 lib_cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, "lib");
1132 if (so->addr_high != 0)
1134 ui_out_field_core_addr (uiout, "from", gdbarch, so->addr_low);
1135 ui_out_field_core_addr (uiout, "to", gdbarch, so->addr_high);
1139 ui_out_field_skip (uiout, "from");
1140 ui_out_field_skip (uiout, "to");
1143 if (! ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ()))
1144 && so->symbols_loaded
1145 && !objfile_has_symbols (so->objfile))
1147 so_missing_debug_info = 1;
1148 ui_out_field_string (uiout, "syms-read", "Yes (*)");
1151 ui_out_field_string (uiout, "syms-read",
1152 so->symbols_loaded ? "Yes" : "No");
1154 ui_out_field_string (uiout, "name", so->so_name);
1156 ui_out_text (uiout, "\n");
1158 do_cleanups (lib_cleanup);
1161 do_cleanups (table_cleanup);
1166 ui_out_message (uiout,
1167 _("No shared libraries matched.\n"));
1169 ui_out_message (uiout,
1170 _("No shared libraries loaded at this time.\n"));
1174 if (so_missing_debug_info)
1175 ui_out_message (uiout,
1176 _("(*): Shared library is missing "
1177 "debugging information.\n"));
1181 /* Return 1 if ADDRESS lies within SOLIB. */
1184 solib_contains_address_p (const struct so_list *const solib,
1187 struct target_section *p;
1189 for (p = solib->sections; p < solib->sections_end; p++)
1190 if (p->addr <= address && address < p->endaddr)
1196 /* If ADDRESS is in a shared lib in program space PSPACE, return its
1199 Provides a hook for other gdb routines to discover whether or not a
1200 particular address is within the mapped address space of a shared
1203 For example, this routine is called at one point to disable
1204 breakpoints which are in shared libraries that are not currently
1208 solib_name_from_address (struct program_space *pspace, CORE_ADDR address)
1210 struct so_list *so = NULL;
1212 for (so = pspace->so_list; so; so = so->next)
1213 if (solib_contains_address_p (so, address))
1214 return (so->so_name);
1219 /* Return whether the data starting at VADDR, size SIZE, must be kept
1220 in a core file for shared libraries loaded before "gcore" is used
1221 to be handled correctly when the core file is loaded. This only
1222 applies when the section would otherwise not be kept in the core
1223 file (in particular, for readonly sections). */
1226 solib_keep_data_in_core (CORE_ADDR vaddr, unsigned long size)
1228 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1230 if (ops->keep_data_in_core)
1231 return ops->keep_data_in_core (vaddr, size);
1236 /* Called by free_all_symtabs */
1241 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1243 disable_breakpoints_in_shlibs ();
1245 while (so_list_head)
1247 struct so_list *so = so_list_head;
1249 so_list_head = so->next;
1250 observer_notify_solib_unloaded (so);
1251 remove_target_sections (so);
1255 ops->clear_solib ();
1258 /* Shared library startup support. When GDB starts up the inferior,
1259 it nurses it along (through the shell) until it is ready to execute
1260 its first instruction. At this point, this function gets
1264 solib_create_inferior_hook (int from_tty)
1266 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1268 ops->solib_create_inferior_hook (from_tty);
1271 /* Check to see if an address is in the dynamic loader's dynamic
1272 symbol resolution code. Return 1 if so, 0 otherwise. */
1275 in_solib_dynsym_resolve_code (CORE_ADDR pc)
1277 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1279 return ops->in_dynsym_resolve_code (pc);
1282 /* Implements the "sharedlibrary" command. */
1285 sharedlibrary_command (char *args, int from_tty)
1288 solib_add (args, from_tty, (struct target_ops *) 0, 1);
1291 /* Implements the command "nosharedlibrary", which discards symbols
1292 that have been auto-loaded from shared libraries. Symbols from
1293 shared libraries that were added by explicit request of the user
1294 are not discarded. Also called from remote.c. */
1297 no_shared_libraries (char *ignored, int from_tty)
1299 /* The order of the two routines below is important: clear_solib notifies
1300 the solib_unloaded observers, and some of these observers might need
1301 access to their associated objfiles. Therefore, we can not purge the
1302 solibs' objfiles before clear_solib has been called. */
1305 objfile_purge_solibs ();
1311 update_solib_breakpoints (void)
1313 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1315 if (ops->update_breakpoints != NULL)
1316 ops->update_breakpoints ();
1322 handle_solib_event (void)
1324 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1326 if (ops->handle_event != NULL)
1327 ops->handle_event ();
1329 clear_program_space_solib_cache (current_inferior ()->pspace);
1331 /* Check for any newly added shared libraries if we're supposed to
1332 be adding them automatically. Switch terminal for any messages
1333 produced by breakpoint_re_set. */
1334 target_terminal_ours_for_output ();
1335 solib_add (NULL, 0, ¤t_target, auto_solib_add);
1336 target_terminal_inferior ();
1339 /* Reload shared libraries, but avoid reloading the same symbol file
1340 we already have loaded. */
1343 reload_shared_libraries_1 (int from_tty)
1346 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
1348 if (print_symbol_loading_p (from_tty, 0, 0))
1349 printf_unfiltered (_("Loading symbols for shared libraries.\n"));
1351 for (so = so_list_head; so != NULL; so = so->next)
1353 char *filename, *found_pathname = NULL;
1355 int was_loaded = so->symbols_loaded;
1356 symfile_add_flags add_flags = SYMFILE_DEFER_BP_RESET;
1359 add_flags |= SYMFILE_VERBOSE;
1361 filename = tilde_expand (so->so_original_name);
1362 make_cleanup (xfree, filename);
1363 abfd = solib_bfd_open (filename);
1366 found_pathname = xstrdup (bfd_get_filename (abfd));
1367 make_cleanup (xfree, found_pathname);
1368 gdb_bfd_unref (abfd);
1371 /* If this shared library is no longer associated with its previous
1372 symbol file, close that. */
1373 if ((found_pathname == NULL && was_loaded)
1374 || (found_pathname != NULL
1375 && filename_cmp (found_pathname, so->so_name) != 0))
1377 if (so->objfile && ! (so->objfile->flags & OBJF_USERLOADED)
1378 && !solib_used (so))
1379 free_objfile (so->objfile);
1380 remove_target_sections (so);
1384 /* If this shared library is now associated with a new symbol
1386 if (found_pathname != NULL
1388 || filename_cmp (found_pathname, so->so_name) != 0))
1394 solib_map_sections (so);
1397 CATCH (e, RETURN_MASK_ERROR)
1399 exception_fprintf (gdb_stderr, e,
1400 _("Error while mapping "
1401 "shared library sections:\n"));
1407 && (auto_solib_add || was_loaded || libpthread_solib_p (so)))
1408 solib_read_symbols (so, add_flags);
1412 do_cleanups (old_chain);
1416 reload_shared_libraries (char *ignored, int from_tty,
1417 struct cmd_list_element *e)
1419 const struct target_so_ops *ops;
1421 reload_shared_libraries_1 (from_tty);
1423 ops = solib_ops (target_gdbarch ());
1425 /* Creating inferior hooks here has two purposes. First, if we reload
1426 shared libraries then the address of solib breakpoint we've computed
1427 previously might be no longer valid. For example, if we forgot to set
1428 solib-absolute-prefix and are setting it right now, then the previous
1429 breakpoint address is plain wrong. Second, installing solib hooks
1430 also implicitly figures were ld.so is and loads symbols for it.
1431 Absent this call, if we've just connected to a target and set
1432 solib-absolute-prefix or solib-search-path, we'll lose all information
1434 if (target_has_execution)
1436 /* Reset or free private data structures not associated with
1438 ops->clear_solib ();
1440 /* Remove any previous solib event breakpoint. This is usually
1441 done in common code, at breakpoint_init_inferior time, but
1442 we're not really starting up the inferior here. */
1443 remove_solib_event_breakpoints ();
1445 solib_create_inferior_hook (from_tty);
1448 /* Sometimes the platform-specific hook loads initial shared
1449 libraries, and sometimes it doesn't. If it doesn't FROM_TTY will be
1450 incorrectly 0 but such solib targets should be fixed anyway. If we
1451 made all the inferior hook methods consistent, this call could be
1452 removed. Call it only after the solib target has been initialized by
1453 solib_create_inferior_hook. */
1455 solib_add (NULL, 0, NULL, auto_solib_add);
1457 breakpoint_re_set ();
1459 /* We may have loaded or unloaded debug info for some (or all)
1460 shared libraries. However, frames may still reference them. For
1461 example, a frame's unwinder might still point at DWARF FDE
1462 structures that are now freed. Also, getting new symbols may
1463 change our opinion about what is frameless. */
1464 reinit_frame_cache ();
1467 /* Wrapper for reload_shared_libraries that replaces "remote:"
1468 at the start of gdb_sysroot with "target:". */
1471 gdb_sysroot_changed (char *ignored, int from_tty,
1472 struct cmd_list_element *e)
1474 const char *old_prefix = "remote:";
1475 const char *new_prefix = TARGET_SYSROOT_PREFIX;
1477 if (startswith (gdb_sysroot, old_prefix))
1479 static int warning_issued = 0;
1481 gdb_assert (strlen (old_prefix) == strlen (new_prefix));
1482 memcpy (gdb_sysroot, new_prefix, strlen (new_prefix));
1484 if (!warning_issued)
1486 warning (_("\"%s\" is deprecated, use \"%s\" instead."),
1487 old_prefix, new_prefix);
1488 warning (_("sysroot set to \"%s\"."), gdb_sysroot);
1494 reload_shared_libraries (ignored, from_tty, e);
1498 show_auto_solib_add (struct ui_file *file, int from_tty,
1499 struct cmd_list_element *c, const char *value)
1501 fprintf_filtered (file, _("Autoloading of shared library symbols is %s.\n"),
1506 /* Handler for library-specific lookup of global symbol NAME in OBJFILE. Call
1507 the library-specific handler if it is installed for the current target. */
1510 solib_global_lookup (struct objfile *objfile,
1512 const domain_enum domain)
1514 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1516 if (ops->lookup_lib_global_symbol != NULL)
1517 return ops->lookup_lib_global_symbol (objfile, name, domain);
1518 return (struct block_symbol) {NULL, NULL};
1521 /* Lookup the value for a specific symbol from dynamic symbol table. Look
1522 up symbol from ABFD. MATCH_SYM is a callback function to determine
1523 whether to pick up a symbol. DATA is the input of this callback
1524 function. Return NULL if symbol is not found. */
1527 gdb_bfd_lookup_symbol_from_symtab (bfd *abfd,
1528 int (*match_sym) (const asymbol *,
1532 long storage_needed = bfd_get_symtab_upper_bound (abfd);
1533 CORE_ADDR symaddr = 0;
1535 if (storage_needed > 0)
1539 asymbol **symbol_table = (asymbol **) xmalloc (storage_needed);
1540 struct cleanup *back_to = make_cleanup (xfree, symbol_table);
1541 unsigned int number_of_symbols =
1542 bfd_canonicalize_symtab (abfd, symbol_table);
1544 for (i = 0; i < number_of_symbols; i++)
1546 asymbol *sym = *symbol_table++;
1548 if (match_sym (sym, data))
1550 struct gdbarch *gdbarch = target_gdbarch ();
1551 symaddr = sym->value;
1553 /* Some ELF targets fiddle with addresses of symbols they
1554 consider special. They use minimal symbols to do that
1555 and this is needed for correct breakpoint placement,
1556 but we do not have full data here to build a complete
1557 minimal symbol, so just set the address and let the
1558 targets cope with that. */
1559 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour
1560 && gdbarch_elf_make_msymbol_special_p (gdbarch))
1562 struct minimal_symbol msym;
1564 memset (&msym, 0, sizeof (msym));
1565 SET_MSYMBOL_VALUE_ADDRESS (&msym, symaddr);
1566 gdbarch_elf_make_msymbol_special (gdbarch, sym, &msym);
1567 symaddr = MSYMBOL_VALUE_RAW_ADDRESS (&msym);
1570 /* BFD symbols are section relative. */
1571 symaddr += sym->section->vma;
1575 do_cleanups (back_to);
1581 /* Lookup the value for a specific symbol from symbol table. Look up symbol
1582 from ABFD. MATCH_SYM is a callback function to determine whether to pick
1583 up a symbol. DATA is the input of this callback function. Return NULL
1584 if symbol is not found. */
1587 bfd_lookup_symbol_from_dyn_symtab (bfd *abfd,
1588 int (*match_sym) (const asymbol *,
1592 long storage_needed = bfd_get_dynamic_symtab_upper_bound (abfd);
1593 CORE_ADDR symaddr = 0;
1595 if (storage_needed > 0)
1598 asymbol **symbol_table = (asymbol **) xmalloc (storage_needed);
1599 struct cleanup *back_to = make_cleanup (xfree, symbol_table);
1600 unsigned int number_of_symbols =
1601 bfd_canonicalize_dynamic_symtab (abfd, symbol_table);
1603 for (i = 0; i < number_of_symbols; i++)
1605 asymbol *sym = *symbol_table++;
1607 if (match_sym (sym, data))
1609 /* BFD symbols are section relative. */
1610 symaddr = sym->value + sym->section->vma;
1614 do_cleanups (back_to);
1619 /* Lookup the value for a specific symbol from symbol table and dynamic
1620 symbol table. Look up symbol from ABFD. MATCH_SYM is a callback
1621 function to determine whether to pick up a symbol. DATA is the
1622 input of this callback function. Return NULL if symbol is not
1626 gdb_bfd_lookup_symbol (bfd *abfd,
1627 int (*match_sym) (const asymbol *, const void *),
1630 CORE_ADDR symaddr = gdb_bfd_lookup_symbol_from_symtab (abfd, match_sym, data);
1632 /* On FreeBSD, the dynamic linker is stripped by default. So we'll
1633 have to check the dynamic string table too. */
1635 symaddr = bfd_lookup_symbol_from_dyn_symtab (abfd, match_sym, data);
1640 /* SO_LIST_HEAD may contain user-loaded object files that can be removed
1641 out-of-band by the user. So upon notification of free_objfile remove
1642 all references to any user-loaded file that is about to be freed. */
1645 remove_user_added_objfile (struct objfile *objfile)
1649 if (objfile != 0 && objfile->flags & OBJF_USERLOADED)
1651 for (so = so_list_head; so != NULL; so = so->next)
1652 if (so->objfile == objfile)
1657 extern initialize_file_ftype _initialize_solib; /* -Wmissing-prototypes */
1660 _initialize_solib (void)
1662 solib_data = gdbarch_data_register_pre_init (solib_init);
1664 observer_attach_free_objfile (remove_user_added_objfile);
1666 add_com ("sharedlibrary", class_files, sharedlibrary_command,
1667 _("Load shared object library symbols for files matching REGEXP."));
1668 add_info ("sharedlibrary", info_sharedlibrary_command,
1669 _("Status of loaded shared object libraries."));
1670 add_info_alias ("dll", "sharedlibrary", 1);
1671 add_com ("nosharedlibrary", class_files, no_shared_libraries,
1672 _("Unload all shared object library symbols."));
1674 add_setshow_boolean_cmd ("auto-solib-add", class_support,
1675 &auto_solib_add, _("\
1676 Set autoloading of shared library symbols."), _("\
1677 Show autoloading of shared library symbols."), _("\
1678 If \"on\", symbols from all shared object libraries will be loaded\n\
1679 automatically when the inferior begins execution, when the dynamic linker\n\
1680 informs gdb that a new library has been loaded, or when attaching to the\n\
1681 inferior. Otherwise, symbols must be loaded manually, using \
1684 show_auto_solib_add,
1685 &setlist, &showlist);
1687 add_setshow_optional_filename_cmd ("sysroot", class_support,
1689 Set an alternate system root."), _("\
1690 Show the current system root."), _("\
1691 The system root is used to load absolute shared library symbol files.\n\
1692 For other (relative) files, you can add directories using\n\
1693 `set solib-search-path'."),
1694 gdb_sysroot_changed,
1696 &setlist, &showlist);
1698 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1700 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1703 add_setshow_optional_filename_cmd ("solib-search-path", class_support,
1704 &solib_search_path, _("\
1705 Set the search path for loading non-absolute shared library symbol files."),
1707 Show the search path for loading non-absolute shared library symbol files."),
1709 This takes precedence over the environment variables \
1710 PATH and LD_LIBRARY_PATH."),
1711 reload_shared_libraries,
1712 show_solib_search_path,
1713 &setlist, &showlist);