1 /* Handle shared libraries for GDB, the GNU Debugger.
3 Copyright (C) 1990-2015 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include <sys/types.h>
32 #include "gdb_regex.h"
37 #include "completer.h"
38 #include "filenames.h" /* for DOSish file names */
42 #include "readline/readline.h"
46 #include "filesystem.h"
48 #include "filestuff.h"
50 /* Architecture-specific operations. */
52 /* Per-architecture data key. */
53 static struct gdbarch_data *solib_data;
56 solib_init (struct obstack *obstack)
58 struct target_so_ops **ops;
60 ops = OBSTACK_ZALLOC (obstack, struct target_so_ops *);
61 *ops = current_target_so_ops;
65 static const struct target_so_ops *
66 solib_ops (struct gdbarch *gdbarch)
68 const struct target_so_ops **ops = gdbarch_data (gdbarch, solib_data);
73 /* Set the solib operations for GDBARCH to NEW_OPS. */
76 set_solib_ops (struct gdbarch *gdbarch, const struct target_so_ops *new_ops)
78 const struct target_so_ops **ops = gdbarch_data (gdbarch, solib_data);
84 /* external data declarations */
86 /* FIXME: gdbarch needs to control this variable, or else every
87 configuration needs to call set_solib_ops. */
88 struct target_so_ops *current_target_so_ops;
90 /* List of known shared objects */
91 #define so_list_head current_program_space->so_list
93 /* Local function prototypes */
95 /* If non-empty, this is a search path for loading non-absolute shared library
96 symbol files. This takes precedence over the environment variables PATH
97 and LD_LIBRARY_PATH. */
98 static char *solib_search_path = NULL;
100 show_solib_search_path (struct ui_file *file, int from_tty,
101 struct cmd_list_element *c, const char *value)
103 fprintf_filtered (file, _("The search path for loading non-absolute "
104 "shared library symbol files is %s.\n"),
108 /* Same as HAVE_DOS_BASED_FILE_SYSTEM, but useable as an rvalue. */
109 #if (HAVE_DOS_BASED_FILE_SYSTEM)
110 # define DOS_BASED_FILE_SYSTEM 1
112 # define DOS_BASED_FILE_SYSTEM 0
115 /* Returns the full pathname of the shared library file, or NULL if
116 not found. (The pathname is malloc'ed; it needs to be freed by the
117 caller.) *FD is set to either -1 or an open file handle for the
120 Global variable GDB_SYSROOT is used as a prefix directory
121 to search for shared libraries if they have an absolute path.
123 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
124 (or set of directories, as in LD_LIBRARY_PATH) to search for all
125 shared libraries if not found in GDB_SYSROOT.
128 * If there is a gdb_sysroot and path is absolute:
129 * Search for gdb_sysroot/path.
131 * Look for it literally (unmodified).
132 * Look in SOLIB_SEARCH_PATH.
133 * If available, use target defined search function.
134 * If gdb_sysroot is NOT set, perform the following two searches:
135 * Look in inferior's $PATH.
136 * Look in inferior's $LD_LIBRARY_PATH.
138 * The last check avoids doing this search when targetting remote
139 * machines since gdb_sysroot will almost always be set.
143 solib_find (char *in_pathname, int *fd)
145 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
147 char *temp_pathname = NULL;
148 int gdb_sysroot_is_empty;
149 const char *solib_symbols_extension
150 = gdbarch_solib_symbols_extension (target_gdbarch ());
151 const char *fskind = effective_target_file_system_kind ();
152 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
153 char *sysroot = NULL;
155 /* If solib_symbols_extension is set, replace the file's
157 if (solib_symbols_extension)
159 char *p = in_pathname + strlen (in_pathname);
161 while (p > in_pathname && *p != '.')
168 new_pathname = alloca (p - in_pathname + 1
169 + strlen (solib_symbols_extension) + 1);
170 memcpy (new_pathname, in_pathname, p - in_pathname + 1);
171 strcpy (new_pathname + (p - in_pathname) + 1,
172 solib_symbols_extension);
174 in_pathname = new_pathname;
178 gdb_sysroot_is_empty = (gdb_sysroot == NULL || *gdb_sysroot == 0);
180 if (!gdb_sysroot_is_empty)
182 int prefix_len = strlen (gdb_sysroot);
184 /* Remove trailing slashes from absolute prefix. */
185 while (prefix_len > 0
186 && IS_DIR_SEPARATOR (gdb_sysroot[prefix_len - 1]))
189 sysroot = savestring (gdb_sysroot, prefix_len);
190 make_cleanup (xfree, sysroot);
193 /* If we're on a non-DOS-based system, backslashes won't be
194 understood as directory separator, so, convert them to forward
195 slashes, iff we're supposed to handle DOS-based file system
196 semantics for target paths. */
197 if (!DOS_BASED_FILE_SYSTEM && fskind == file_system_kind_dos_based)
201 /* Avoid clobbering our input. */
202 p = alloca (strlen (in_pathname) + 1);
203 strcpy (p, in_pathname);
213 /* Note, we're interested in IS_TARGET_ABSOLUTE_PATH, not
214 IS_ABSOLUTE_PATH. The latter is for host paths only, while
215 IN_PATHNAME is a target path. For example, if we're supposed to
216 be handling DOS-like semantics we want to consider a
217 'c:/foo/bar.dll' path as an absolute path, even on a Unix box.
218 With such a path, before giving up on the sysroot, we'll try:
220 1st attempt, c:/foo/bar.dll ==> /sysroot/c:/foo/bar.dll
221 2nd attempt, c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll
222 3rd attempt, c:/foo/bar.dll ==> /sysroot/foo/bar.dll
225 if (!IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname) || gdb_sysroot_is_empty)
226 temp_pathname = xstrdup (in_pathname);
229 int need_dir_separator;
231 /* Concatenate the sysroot and the target reported filename. We
232 may need to glue them with a directory separator. Cases to
235 | sysroot | separator | in_pathname |
236 |-----------------+-----------+----------------|
237 | /some/dir | / | c:/foo/bar.dll |
238 | /some/dir | | /foo/bar.dll |
239 | target: | | c:/foo/bar.dll |
240 | target: | | /foo/bar.dll |
241 | target:some/dir | / | c:/foo/bar.dll |
242 | target:some/dir | | /foo/bar.dll |
244 IOW, we don't need to add a separator if IN_PATHNAME already
245 has one, or when the the sysroot is exactly "target:".
246 There's no need to check for drive spec explicitly, as we only
247 get here if IN_PATHNAME is considered an absolute path. */
248 need_dir_separator = !(IS_DIR_SEPARATOR (in_pathname[0])
249 || strcmp (TARGET_SYSROOT_PREFIX, sysroot) == 0);
251 /* Cat the prefixed pathname together. */
252 temp_pathname = concat (sysroot,
253 need_dir_separator ? SLASH_STRING : "",
254 in_pathname, (char *) NULL);
257 /* Handle files to be accessed via the target. */
258 if (is_target_filename (temp_pathname))
261 do_cleanups (old_chain);
262 return temp_pathname;
265 /* Now see if we can open it. */
266 found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
268 xfree (temp_pathname);
270 /* If the search in gdb_sysroot failed, and the path name has a
271 drive spec (e.g, c:/foo), try stripping ':' from the drive spec,
272 and retrying in the sysroot:
273 c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll. */
276 && !gdb_sysroot_is_empty
277 && HAS_TARGET_DRIVE_SPEC (fskind, in_pathname))
279 int need_dir_separator = !IS_DIR_SEPARATOR (in_pathname[2]);
280 char *drive = savestring (in_pathname, 1);
282 temp_pathname = concat (sysroot,
285 need_dir_separator ? SLASH_STRING : "",
286 in_pathname + 2, (char *) NULL);
289 found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
292 xfree (temp_pathname);
294 /* If the search in gdb_sysroot still failed, try fully
295 stripping the drive spec, and trying once more in the
296 sysroot before giving up.
298 c:/foo/bar.dll ==> /sysroot/foo/bar.dll. */
300 temp_pathname = concat (sysroot,
301 need_dir_separator ? SLASH_STRING : "",
302 in_pathname + 2, (char *) NULL);
304 found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
306 xfree (temp_pathname);
310 do_cleanups (old_chain);
312 /* We try to find the library in various ways. After each attempt,
313 either found_file >= 0 and temp_pathname is a malloc'd string, or
314 found_file < 0 and temp_pathname does not point to storage that
315 needs to be freed. */
318 temp_pathname = NULL;
320 /* If the search in gdb_sysroot failed, and the path name is
321 absolute at this point, make it relative. (openp will try and open the
322 file according to its absolute path otherwise, which is not what we want.)
323 Affects subsequent searches for this solib. */
324 if (found_file < 0 && IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname))
326 /* First, get rid of any drive letters etc. */
327 while (!IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
330 /* Next, get rid of all leading dir separators. */
331 while (IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
335 /* If not found, search the solib_search_path (if any). */
336 if (found_file < 0 && solib_search_path != NULL)
337 found_file = openp (solib_search_path,
338 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
339 in_pathname, O_RDONLY | O_BINARY, &temp_pathname);
341 /* If not found, next search the solib_search_path (if any) for the basename
342 only (ignoring the path). This is to allow reading solibs from a path
343 that differs from the opened path. */
344 if (found_file < 0 && solib_search_path != NULL)
345 found_file = openp (solib_search_path,
346 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
347 target_lbasename (fskind, in_pathname),
348 O_RDONLY | O_BINARY, &temp_pathname);
350 /* If not found, try to use target supplied solib search method. */
351 if (found_file < 0 && ops->find_and_open_solib)
352 found_file = ops->find_and_open_solib (in_pathname, O_RDONLY | O_BINARY,
355 /* If not found, next search the inferior's $PATH environment variable. */
356 if (found_file < 0 && gdb_sysroot_is_empty)
357 found_file = openp (get_in_environ (current_inferior ()->environment,
359 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
360 O_RDONLY | O_BINARY, &temp_pathname);
362 /* If not found, next search the inferior's $LD_LIBRARY_PATH
363 environment variable. */
364 if (found_file < 0 && gdb_sysroot_is_empty)
365 found_file = openp (get_in_environ (current_inferior ()->environment,
367 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
368 O_RDONLY | O_BINARY, &temp_pathname);
371 return temp_pathname;
374 /* Open and return a BFD for the shared library PATHNAME. If FD is not -1,
375 it is used as file handle to open the file. Throws an error if the file
376 could not be opened. Handles both local and remote file access.
378 PATHNAME must be malloc'ed by the caller. It will be freed by this
379 function. If unsuccessful, the FD will be closed (unless FD was
383 solib_bfd_fopen (char *pathname, int fd)
385 bfd *abfd = gdb_bfd_open (pathname, gnutarget, fd);
387 if (abfd != NULL && !gdb_bfd_has_target_filename (abfd))
388 bfd_set_cacheable (abfd, 1);
392 make_cleanup (xfree, pathname);
393 error (_("Could not open `%s' as an executable file: %s"),
394 pathname, bfd_errmsg (bfd_get_error ()));
402 /* Find shared library PATHNAME and open a BFD for it. */
405 solib_bfd_open (char *pathname)
407 char *found_pathname;
410 const struct bfd_arch_info *b;
412 /* Search for shared library file. */
413 found_pathname = solib_find (pathname, &found_file);
414 if (found_pathname == NULL)
416 /* Return failure if the file could not be found, so that we can
417 accumulate messages about missing libraries. */
421 perror_with_name (pathname);
424 /* Open bfd for shared library. */
425 abfd = solib_bfd_fopen (found_pathname, found_file);
427 /* Check bfd format. */
428 if (!bfd_check_format (abfd, bfd_object))
430 make_cleanup_bfd_unref (abfd);
431 error (_("`%s': not in executable format: %s"),
432 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
435 /* Check bfd arch. */
436 b = gdbarch_bfd_arch_info (target_gdbarch ());
437 if (!b->compatible (b, bfd_get_arch_info (abfd)))
438 warning (_("`%s': Shared library architecture %s is not compatible "
439 "with target architecture %s."), bfd_get_filename (abfd),
440 bfd_get_arch_info (abfd)->printable_name, b->printable_name);
445 /* Given a pointer to one of the shared objects in our list of mapped
446 objects, use the recorded name to open a bfd descriptor for the
447 object, build a section table, relocate all the section addresses
448 by the base address at which the shared object was mapped, and then
449 add the sections to the target's section table.
451 FIXME: In most (all?) cases the shared object file name recorded in
452 the dynamic linkage tables will be a fully qualified pathname. For
453 cases where it isn't, do we really mimic the systems search
454 mechanism correctly in the below code (particularly the tilde
455 expansion stuff?). */
458 solib_map_sections (struct so_list *so)
460 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
462 struct target_section *p;
463 struct cleanup *old_chain;
466 filename = tilde_expand (so->so_name);
467 old_chain = make_cleanup (xfree, filename);
468 abfd = ops->bfd_open (filename);
469 do_cleanups (old_chain);
474 /* Leave bfd open, core_xfer_memory and "info files" need it. */
477 /* Copy the full path name into so_name, allowing symbol_file_add
478 to find it later. This also affects the =library-loaded GDB/MI
479 event, and in particular the part of that notification providing
480 the library's host-side path. If we let the target dictate
481 that objfile's path, and the target is different from the host,
482 GDB/MI will not provide the correct host-side path. */
483 if (strlen (bfd_get_filename (abfd)) >= SO_NAME_MAX_PATH_SIZE)
484 error (_("Shared library file name is too long."));
485 strcpy (so->so_name, bfd_get_filename (abfd));
487 if (build_section_table (abfd, &so->sections, &so->sections_end))
489 error (_("Can't find the file sections in `%s': %s"),
490 bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
493 for (p = so->sections; p < so->sections_end; p++)
495 /* Relocate the section binding addresses as recorded in the shared
496 object's file by the base address to which the object was actually
498 ops->relocate_section_addresses (so, p);
500 /* If the target didn't provide information about the address
501 range of the shared object, assume we want the location of
502 the .text section. */
503 if (so->addr_low == 0 && so->addr_high == 0
504 && strcmp (p->the_bfd_section->name, ".text") == 0)
506 so->addr_low = p->addr;
507 so->addr_high = p->endaddr;
511 /* Add the shared object's sections to the current set of file
512 section tables. Do this immediately after mapping the object so
513 that later nodes in the list can query this object, as is needed
515 add_target_sections (so, so->sections, so->sections_end);
520 /* Free symbol-file related contents of SO and reset for possible reloading
521 of SO. If we have opened a BFD for SO, close it. If we have placed SO's
522 sections in some target's section table, the caller is responsible for
525 This function doesn't mess with objfiles at all. If there is an
526 objfile associated with SO that needs to be removed, the caller is
527 responsible for taking care of that. */
530 clear_so (struct so_list *so)
532 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
536 xfree (so->sections);
537 so->sections = so->sections_end = NULL;
540 gdb_bfd_unref (so->abfd);
543 /* Our caller closed the objfile, possibly via objfile_purge_solibs. */
544 so->symbols_loaded = 0;
547 so->addr_low = so->addr_high = 0;
549 /* Restore the target-supplied file name. SO_NAME may be the path
550 of the symbol file. */
551 strcpy (so->so_name, so->so_original_name);
553 /* Do the same for target-specific data. */
554 if (ops->clear_so != NULL)
558 /* Free the storage associated with the `struct so_list' object SO.
559 If we have opened a BFD for SO, close it.
561 The caller is responsible for removing SO from whatever list it is
562 a member of. If we have placed SO's sections in some target's
563 section table, the caller is responsible for removing them.
565 This function doesn't mess with objfiles at all. If there is an
566 objfile associated with SO that needs to be removed, the caller is
567 responsible for taking care of that. */
570 free_so (struct so_list *so)
572 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
581 /* Return address of first so_list entry in master shared object list. */
583 master_so_list (void)
588 /* Read in symbols for shared object SO. If SYMFILE_VERBOSE is set in FLAGS,
589 be chatty about it. Return non-zero if any symbols were actually
593 solib_read_symbols (struct so_list *so, int flags)
595 if (so->symbols_loaded)
597 /* If needed, we've already warned in our caller. */
599 else if (so->abfd == NULL)
601 /* We've already warned about this library, when trying to open
607 flags |= current_inferior ()->symfile_flags;
611 struct section_addr_info *sap;
613 /* Have we already loaded this shared object? */
614 ALL_OBJFILES (so->objfile)
616 if (filename_cmp (objfile_name (so->objfile), so->so_name) == 0
617 && so->objfile->addr_low == so->addr_low)
620 if (so->objfile != NULL)
623 sap = build_section_addr_info_from_section_table (so->sections,
625 so->objfile = symbol_file_add_from_bfd (so->abfd, so->so_name,
626 flags, sap, OBJF_SHARED,
628 so->objfile->addr_low = so->addr_low;
629 free_section_addr_info (sap);
631 so->symbols_loaded = 1;
633 CATCH (e, RETURN_MASK_ERROR)
635 exception_fprintf (gdb_stderr, e, _("Error while reading shared"
636 " library symbols for %s:\n"),
647 /* Return 1 if KNOWN->objfile is used by any other so_list object in the
648 SO_LIST_HEAD list. Return 0 otherwise. */
651 solib_used (const struct so_list *const known)
653 const struct so_list *pivot;
655 for (pivot = so_list_head; pivot != NULL; pivot = pivot->next)
656 if (pivot != known && pivot->objfile == known->objfile)
661 /* Synchronize GDB's shared object list with inferior's.
663 Extract the list of currently loaded shared objects from the
664 inferior, and compare it with the list of shared objects currently
665 in GDB's so_list_head list. Edit so_list_head to bring it in sync
666 with the inferior's new list.
668 If we notice that the inferior has unloaded some shared objects,
669 free any symbolic info GDB had read about those shared objects.
671 Don't load symbolic info for any new shared objects; just add them
672 to the list, and leave their symbols_loaded flag clear.
674 If FROM_TTY is non-null, feel free to print messages about what
677 If TARGET is non-null, add the sections of all new shared objects
678 to TARGET's section table. Note that this doesn't remove any
679 sections for shared objects that have been unloaded, and it
680 doesn't check to see if the new shared objects are already present in
681 the section table. But we only use this for core files and
682 processes we've just attached to, so that's okay. */
685 update_solib_list (int from_tty, struct target_ops *target)
687 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
688 struct so_list *inferior = ops->current_sos();
689 struct so_list *gdb, **gdb_link;
691 /* We can reach here due to changing solib-search-path or the
692 sysroot, before having any inferior. */
693 if (target_has_execution && !ptid_equal (inferior_ptid, null_ptid))
695 struct inferior *inf = current_inferior ();
697 /* If we are attaching to a running process for which we
698 have not opened a symbol file, we may be able to get its
700 if (inf->attach_flag && symfile_objfile == NULL)
701 catch_errors (ops->open_symbol_file_object, &from_tty,
702 "Error reading attached process's symbol file.\n",
706 /* GDB and the inferior's dynamic linker each maintain their own
707 list of currently loaded shared objects; we want to bring the
708 former in sync with the latter. Scan both lists, seeing which
709 shared objects appear where. There are three cases:
711 - A shared object appears on both lists. This means that GDB
712 knows about it already, and it's still loaded in the inferior.
713 Nothing needs to happen.
715 - A shared object appears only on GDB's list. This means that
716 the inferior has unloaded it. We should remove the shared
717 object from GDB's tables.
719 - A shared object appears only on the inferior's list. This
720 means that it's just been loaded. We should add it to GDB's
723 So we walk GDB's list, checking each entry to see if it appears
724 in the inferior's list too. If it does, no action is needed, and
725 we remove it from the inferior's list. If it doesn't, the
726 inferior has unloaded it, and we remove it from GDB's list. By
727 the time we're done walking GDB's list, the inferior's list
728 contains only the new shared objects, which we then add. */
731 gdb_link = &so_list_head;
734 struct so_list *i = inferior;
735 struct so_list **i_link = &inferior;
737 /* Check to see whether the shared object *gdb also appears in
738 the inferior's current list. */
743 if (ops->same (gdb, i))
748 if (! filename_cmp (gdb->so_original_name, i->so_original_name))
756 /* If the shared object appears on the inferior's list too, then
757 it's still loaded, so we don't need to do anything. Delete
758 it from the inferior's list, and leave it on GDB's list. */
763 gdb_link = &gdb->next;
767 /* If it's not on the inferior's list, remove it from GDB's tables. */
770 /* Notify any observer that the shared object has been
771 unloaded before we remove it from GDB's tables. */
772 observer_notify_solib_unloaded (gdb);
774 VEC_safe_push (char_ptr, current_program_space->deleted_solibs,
775 xstrdup (gdb->so_name));
777 *gdb_link = gdb->next;
779 /* Unless the user loaded it explicitly, free SO's objfile. */
780 if (gdb->objfile && ! (gdb->objfile->flags & OBJF_USERLOADED)
781 && !solib_used (gdb))
782 free_objfile (gdb->objfile);
784 /* Some targets' section tables might be referring to
785 sections from so->abfd; remove them. */
786 remove_target_sections (gdb);
793 /* Now the inferior's list contains only shared objects that don't
794 appear in GDB's list --- those that are newly loaded. Add them
795 to GDB's shared object list. */
799 const char *not_found_filename = NULL;
803 /* Add the new shared objects to GDB's list. */
804 *gdb_link = inferior;
806 /* Fill in the rest of each of the `struct so_list' nodes. */
807 for (i = inferior; i; i = i->next)
810 i->pspace = current_program_space;
811 VEC_safe_push (so_list_ptr, current_program_space->added_solibs, i);
815 /* Fill in the rest of the `struct so_list' node. */
816 if (!solib_map_sections (i))
819 if (not_found_filename == NULL)
820 not_found_filename = i->so_original_name;
824 CATCH (e, RETURN_MASK_ERROR)
826 exception_fprintf (gdb_stderr, e,
827 _("Error while mapping shared "
828 "library sections:\n"));
832 /* Notify any observer that the shared object has been
833 loaded now that we've added it to GDB's tables. */
834 observer_notify_solib_loaded (i);
837 /* If a library was not found, issue an appropriate warning
838 message. We have to use a single call to warning in case the
839 front end does something special with warnings, e.g., pop up
840 a dialog box. It Would Be Nice if we could get a "warning: "
841 prefix on each line in the CLI front end, though - it doesn't
845 warning (_("Could not load shared library symbols for %s.\n"
846 "Do you need \"set solib-search-path\" "
847 "or \"set sysroot\"?"),
849 else if (not_found > 1)
851 Could not load shared library symbols for %d libraries, e.g. %s.\n\
852 Use the \"info sharedlibrary\" command to see the complete listing.\n\
853 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
854 not_found, not_found_filename);
859 /* Return non-zero if NAME is the libpthread shared library.
861 Uses a fairly simplistic heuristic approach where we check
862 the file name against "/libpthread". This can lead to false
863 positives, but this should be good enough in practice. */
866 libpthread_name_p (const char *name)
868 return (strstr (name, "/libpthread") != NULL);
871 /* Return non-zero if SO is the libpthread shared library. */
874 libpthread_solib_p (struct so_list *so)
876 return libpthread_name_p (so->so_name);
879 /* Read in symbolic information for any shared objects whose names
880 match PATTERN. (If we've already read a shared object's symbol
881 info, leave it alone.) If PATTERN is zero, read them all.
883 If READSYMS is 0, defer reading symbolic information until later
884 but still do any needed low level processing.
886 FROM_TTY and TARGET are as described for update_solib_list, above. */
889 solib_add (const char *pattern, int from_tty,
890 struct target_ops *target, int readsyms)
894 if (print_symbol_loading_p (from_tty, 0, 0))
898 printf_unfiltered (_("Loading symbols for shared libraries: %s\n"),
902 printf_unfiltered (_("Loading symbols for shared libraries.\n"));
905 current_program_space->solib_add_generation++;
909 char *re_err = re_comp (pattern);
912 error (_("Invalid regexp: %s"), re_err);
915 update_solib_list (from_tty, target);
917 /* Walk the list of currently loaded shared libraries, and read
918 symbols for any that match the pattern --- or any whose symbols
919 aren't already loaded, if no pattern was given. */
922 int loaded_any_symbols = 0;
924 SYMFILE_DEFER_BP_RESET | (from_tty ? SYMFILE_VERBOSE : 0);
926 for (gdb = so_list_head; gdb; gdb = gdb->next)
927 if (! pattern || re_exec (gdb->so_name))
929 /* Normally, we would read the symbols from that library
930 only if READSYMS is set. However, we're making a small
931 exception for the pthread library, because we sometimes
932 need the library symbols to be loaded in order to provide
933 thread support (x86-linux for instance). */
934 const int add_this_solib =
935 (readsyms || libpthread_solib_p (gdb));
940 if (gdb->symbols_loaded)
942 /* If no pattern was given, be quiet for shared
943 libraries we have already loaded. */
944 if (pattern && (from_tty || info_verbose))
945 printf_unfiltered (_("Symbols already loaded for %s\n"),
948 else if (solib_read_symbols (gdb, flags))
949 loaded_any_symbols = 1;
953 if (loaded_any_symbols)
954 breakpoint_re_set ();
956 if (from_tty && pattern && ! any_matches)
958 ("No loaded shared libraries match the pattern `%s'.\n", pattern);
960 if (loaded_any_symbols)
962 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
964 /* Getting new symbols may change our opinion about what is
966 reinit_frame_cache ();
968 ops->special_symbol_handling ();
973 /* Implement the "info sharedlibrary" command. Walk through the
974 shared library list and print information about each attached
975 library matching PATTERN. If PATTERN is elided, print them
979 info_sharedlibrary_command (char *pattern, int from_tty)
981 struct so_list *so = NULL; /* link map state variable */
982 int so_missing_debug_info = 0;
985 struct cleanup *table_cleanup;
986 struct gdbarch *gdbarch = target_gdbarch ();
987 struct ui_out *uiout = current_uiout;
991 char *re_err = re_comp (pattern);
994 error (_("Invalid regexp: %s"), re_err);
997 /* "0x", a little whitespace, and two hex digits per byte of pointers. */
998 addr_width = 4 + (gdbarch_ptr_bit (gdbarch) / 4);
1000 update_solib_list (from_tty, 0);
1002 /* make_cleanup_ui_out_table_begin_end needs to know the number of
1003 rows, so we need to make two passes over the libs. */
1005 for (nr_libs = 0, so = so_list_head; so; so = so->next)
1009 if (pattern && ! re_exec (so->so_name))
1016 make_cleanup_ui_out_table_begin_end (uiout, 4, nr_libs,
1017 "SharedLibraryTable");
1019 /* The "- 1" is because ui_out adds one space between columns. */
1020 ui_out_table_header (uiout, addr_width - 1, ui_left, "from", "From");
1021 ui_out_table_header (uiout, addr_width - 1, ui_left, "to", "To");
1022 ui_out_table_header (uiout, 12 - 1, ui_left, "syms-read", "Syms Read");
1023 ui_out_table_header (uiout, 0, ui_noalign,
1024 "name", "Shared Object Library");
1026 ui_out_table_body (uiout);
1028 for (so = so_list_head; so; so = so->next)
1030 struct cleanup *lib_cleanup;
1032 if (! so->so_name[0])
1034 if (pattern && ! re_exec (so->so_name))
1037 lib_cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, "lib");
1039 if (so->addr_high != 0)
1041 ui_out_field_core_addr (uiout, "from", gdbarch, so->addr_low);
1042 ui_out_field_core_addr (uiout, "to", gdbarch, so->addr_high);
1046 ui_out_field_skip (uiout, "from");
1047 ui_out_field_skip (uiout, "to");
1050 if (! ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ()))
1051 && so->symbols_loaded
1052 && !objfile_has_symbols (so->objfile))
1054 so_missing_debug_info = 1;
1055 ui_out_field_string (uiout, "syms-read", "Yes (*)");
1058 ui_out_field_string (uiout, "syms-read",
1059 so->symbols_loaded ? "Yes" : "No");
1061 ui_out_field_string (uiout, "name", so->so_name);
1063 ui_out_text (uiout, "\n");
1065 do_cleanups (lib_cleanup);
1068 do_cleanups (table_cleanup);
1073 ui_out_message (uiout, 0,
1074 _("No shared libraries matched.\n"));
1076 ui_out_message (uiout, 0,
1077 _("No shared libraries loaded at this time.\n"));
1081 if (so_missing_debug_info)
1082 ui_out_message (uiout, 0,
1083 _("(*): Shared library is missing "
1084 "debugging information.\n"));
1088 /* Return 1 if ADDRESS lies within SOLIB. */
1091 solib_contains_address_p (const struct so_list *const solib,
1094 struct target_section *p;
1096 for (p = solib->sections; p < solib->sections_end; p++)
1097 if (p->addr <= address && address < p->endaddr)
1103 /* If ADDRESS is in a shared lib in program space PSPACE, return its
1106 Provides a hook for other gdb routines to discover whether or not a
1107 particular address is within the mapped address space of a shared
1110 For example, this routine is called at one point to disable
1111 breakpoints which are in shared libraries that are not currently
1115 solib_name_from_address (struct program_space *pspace, CORE_ADDR address)
1117 struct so_list *so = NULL;
1119 for (so = pspace->so_list; so; so = so->next)
1120 if (solib_contains_address_p (so, address))
1121 return (so->so_name);
1126 /* Return whether the data starting at VADDR, size SIZE, must be kept
1127 in a core file for shared libraries loaded before "gcore" is used
1128 to be handled correctly when the core file is loaded. This only
1129 applies when the section would otherwise not be kept in the core
1130 file (in particular, for readonly sections). */
1133 solib_keep_data_in_core (CORE_ADDR vaddr, unsigned long size)
1135 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1137 if (ops->keep_data_in_core)
1138 return ops->keep_data_in_core (vaddr, size);
1143 /* Called by free_all_symtabs */
1148 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1150 /* This function is expected to handle ELF shared libraries. It is
1151 also used on Solaris, which can run either ELF or a.out binaries
1152 (for compatibility with SunOS 4), both of which can use shared
1153 libraries. So we don't know whether we have an ELF executable or
1154 an a.out executable until the user chooses an executable file.
1156 ELF shared libraries don't get mapped into the address space
1157 until after the program starts, so we'd better not try to insert
1158 breakpoints in them immediately. We have to wait until the
1159 dynamic linker has loaded them; we'll hit a bp_shlib_event
1160 breakpoint (look for calls to create_solib_event_breakpoint) when
1163 SunOS shared libraries seem to be different --- they're present
1164 as soon as the process begins execution, so there's no need to
1165 put off inserting breakpoints. There's also nowhere to put a
1166 bp_shlib_event breakpoint, so if we put it off, we'll never get
1169 So: disable breakpoints only if we're using ELF shared libs. */
1170 if (exec_bfd != NULL
1171 && bfd_get_flavour (exec_bfd) != bfd_target_aout_flavour)
1172 disable_breakpoints_in_shlibs ();
1174 while (so_list_head)
1176 struct so_list *so = so_list_head;
1178 so_list_head = so->next;
1179 observer_notify_solib_unloaded (so);
1180 remove_target_sections (so);
1184 ops->clear_solib ();
1187 /* Shared library startup support. When GDB starts up the inferior,
1188 it nurses it along (through the shell) until it is ready to execute
1189 its first instruction. At this point, this function gets
1193 solib_create_inferior_hook (int from_tty)
1195 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1197 ops->solib_create_inferior_hook (from_tty);
1200 /* Check to see if an address is in the dynamic loader's dynamic
1201 symbol resolution code. Return 1 if so, 0 otherwise. */
1204 in_solib_dynsym_resolve_code (CORE_ADDR pc)
1206 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1208 return ops->in_dynsym_resolve_code (pc);
1211 /* Implements the "sharedlibrary" command. */
1214 sharedlibrary_command (char *args, int from_tty)
1217 solib_add (args, from_tty, (struct target_ops *) 0, 1);
1220 /* Implements the command "nosharedlibrary", which discards symbols
1221 that have been auto-loaded from shared libraries. Symbols from
1222 shared libraries that were added by explicit request of the user
1223 are not discarded. Also called from remote.c. */
1226 no_shared_libraries (char *ignored, int from_tty)
1228 /* The order of the two routines below is important: clear_solib notifies
1229 the solib_unloaded observers, and some of these observers might need
1230 access to their associated objfiles. Therefore, we can not purge the
1231 solibs' objfiles before clear_solib has been called. */
1234 objfile_purge_solibs ();
1240 update_solib_breakpoints (void)
1242 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1244 if (ops->update_breakpoints != NULL)
1245 ops->update_breakpoints ();
1251 handle_solib_event (void)
1253 const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1255 if (ops->handle_event != NULL)
1256 ops->handle_event ();
1258 clear_program_space_solib_cache (current_inferior ()->pspace);
1260 /* Check for any newly added shared libraries if we're supposed to
1261 be adding them automatically. Switch terminal for any messages
1262 produced by breakpoint_re_set. */
1263 target_terminal_ours_for_output ();
1264 solib_add (NULL, 0, ¤t_target, auto_solib_add);
1265 target_terminal_inferior ();
1268 /* Reload shared libraries, but avoid reloading the same symbol file
1269 we already have loaded. */
1272 reload_shared_libraries_1 (int from_tty)
1275 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
1277 if (print_symbol_loading_p (from_tty, 0, 0))
1278 printf_unfiltered (_("Loading symbols for shared libraries.\n"));
1280 for (so = so_list_head; so != NULL; so = so->next)
1282 char *filename, *found_pathname = NULL;
1284 int was_loaded = so->symbols_loaded;
1286 SYMFILE_DEFER_BP_RESET | (from_tty ? SYMFILE_VERBOSE : 0);
1288 filename = tilde_expand (so->so_original_name);
1289 make_cleanup (xfree, filename);
1290 abfd = solib_bfd_open (filename);
1293 found_pathname = xstrdup (bfd_get_filename (abfd));
1294 make_cleanup (xfree, found_pathname);
1295 gdb_bfd_unref (abfd);
1298 /* If this shared library is no longer associated with its previous
1299 symbol file, close that. */
1300 if ((found_pathname == NULL && was_loaded)
1301 || (found_pathname != NULL
1302 && filename_cmp (found_pathname, so->so_name) != 0))
1304 if (so->objfile && ! (so->objfile->flags & OBJF_USERLOADED)
1305 && !solib_used (so))
1306 free_objfile (so->objfile);
1307 remove_target_sections (so);
1311 /* If this shared library is now associated with a new symbol
1313 if (found_pathname != NULL
1315 || filename_cmp (found_pathname, so->so_name) != 0))
1321 solib_map_sections (so);
1324 CATCH (e, RETURN_MASK_ERROR)
1326 exception_fprintf (gdb_stderr, e,
1327 _("Error while mapping "
1328 "shared library sections:\n"));
1334 && (auto_solib_add || was_loaded || libpthread_solib_p (so)))
1335 solib_read_symbols (so, flags);
1339 do_cleanups (old_chain);
1343 reload_shared_libraries (char *ignored, int from_tty,
1344 struct cmd_list_element *e)
1346 const struct target_so_ops *ops;
1348 reload_shared_libraries_1 (from_tty);
1350 ops = solib_ops (target_gdbarch ());
1352 /* Creating inferior hooks here has two purposes. First, if we reload
1353 shared libraries then the address of solib breakpoint we've computed
1354 previously might be no longer valid. For example, if we forgot to set
1355 solib-absolute-prefix and are setting it right now, then the previous
1356 breakpoint address is plain wrong. Second, installing solib hooks
1357 also implicitly figures were ld.so is and loads symbols for it.
1358 Absent this call, if we've just connected to a target and set
1359 solib-absolute-prefix or solib-search-path, we'll lose all information
1361 if (target_has_execution)
1363 /* Reset or free private data structures not associated with
1365 ops->clear_solib ();
1367 /* Remove any previous solib event breakpoint. This is usually
1368 done in common code, at breakpoint_init_inferior time, but
1369 we're not really starting up the inferior here. */
1370 remove_solib_event_breakpoints ();
1372 solib_create_inferior_hook (from_tty);
1375 /* Sometimes the platform-specific hook loads initial shared
1376 libraries, and sometimes it doesn't. If it doesn't FROM_TTY will be
1377 incorrectly 0 but such solib targets should be fixed anyway. If we
1378 made all the inferior hook methods consistent, this call could be
1379 removed. Call it only after the solib target has been initialized by
1380 solib_create_inferior_hook. */
1382 solib_add (NULL, 0, NULL, auto_solib_add);
1384 breakpoint_re_set ();
1386 /* We may have loaded or unloaded debug info for some (or all)
1387 shared libraries. However, frames may still reference them. For
1388 example, a frame's unwinder might still point at DWARF FDE
1389 structures that are now freed. Also, getting new symbols may
1390 change our opinion about what is frameless. */
1391 reinit_frame_cache ();
1393 ops->special_symbol_handling ();
1396 /* Wrapper for reload_shared_libraries that replaces "remote:"
1397 at the start of gdb_sysroot with "target:". */
1400 gdb_sysroot_changed (char *ignored, int from_tty,
1401 struct cmd_list_element *e)
1403 const char *old_prefix = "remote:";
1404 const char *new_prefix = TARGET_SYSROOT_PREFIX;
1406 if (startswith (gdb_sysroot, old_prefix))
1408 static int warning_issued = 0;
1410 gdb_assert (strlen (old_prefix) == strlen (new_prefix));
1411 memcpy (gdb_sysroot, new_prefix, strlen (new_prefix));
1413 if (!warning_issued)
1415 warning (_("\"%s\" is deprecated, use \"%s\" instead."),
1416 old_prefix, new_prefix);
1417 warning (_("sysroot set to \"%s\"."), gdb_sysroot);
1423 reload_shared_libraries (ignored, from_tty, e);
1427 show_auto_solib_add (struct ui_file *file, int from_tty,
1428 struct cmd_list_element *c, const char *value)
1430 fprintf_filtered (file, _("Autoloading of shared library symbols is %s.\n"),
1435 /* Handler for library-specific lookup of global symbol NAME in OBJFILE. Call
1436 the library-specific handler if it is installed for the current target. */
1439 solib_global_lookup (struct objfile *objfile,
1441 const domain_enum domain)
1443 const struct target_so_ops *ops = solib_ops (get_objfile_arch (objfile));
1445 if (ops->lookup_lib_global_symbol != NULL)
1446 return ops->lookup_lib_global_symbol (objfile, name, domain);
1450 /* Lookup the value for a specific symbol from dynamic symbol table. Look
1451 up symbol from ABFD. MATCH_SYM is a callback function to determine
1452 whether to pick up a symbol. DATA is the input of this callback
1453 function. Return NULL if symbol is not found. */
1456 gdb_bfd_lookup_symbol_from_symtab (bfd *abfd,
1457 int (*match_sym) (asymbol *, void *),
1460 long storage_needed = bfd_get_symtab_upper_bound (abfd);
1461 CORE_ADDR symaddr = 0;
1463 if (storage_needed > 0)
1467 asymbol **symbol_table = (asymbol **) xmalloc (storage_needed);
1468 struct cleanup *back_to = make_cleanup (xfree, symbol_table);
1469 unsigned int number_of_symbols =
1470 bfd_canonicalize_symtab (abfd, symbol_table);
1472 for (i = 0; i < number_of_symbols; i++)
1474 asymbol *sym = *symbol_table++;
1476 if (match_sym (sym, data))
1478 struct gdbarch *gdbarch = target_gdbarch ();
1479 symaddr = sym->value;
1481 /* Some ELF targets fiddle with addresses of symbols they
1482 consider special. They use minimal symbols to do that
1483 and this is needed for correct breakpoint placement,
1484 but we do not have full data here to build a complete
1485 minimal symbol, so just set the address and let the
1486 targets cope with that. */
1487 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour
1488 && gdbarch_elf_make_msymbol_special_p (gdbarch))
1490 struct minimal_symbol msym;
1492 memset (&msym, 0, sizeof (msym));
1493 SET_MSYMBOL_VALUE_ADDRESS (&msym, symaddr);
1494 gdbarch_elf_make_msymbol_special (gdbarch, sym, &msym);
1495 symaddr = MSYMBOL_VALUE_RAW_ADDRESS (&msym);
1498 /* BFD symbols are section relative. */
1499 symaddr += sym->section->vma;
1503 do_cleanups (back_to);
1509 /* Lookup the value for a specific symbol from symbol table. Look up symbol
1510 from ABFD. MATCH_SYM is a callback function to determine whether to pick
1511 up a symbol. DATA is the input of this callback function. Return NULL
1512 if symbol is not found. */
1515 bfd_lookup_symbol_from_dyn_symtab (bfd *abfd,
1516 int (*match_sym) (asymbol *, void *),
1519 long storage_needed = bfd_get_dynamic_symtab_upper_bound (abfd);
1520 CORE_ADDR symaddr = 0;
1522 if (storage_needed > 0)
1525 asymbol **symbol_table = (asymbol **) xmalloc (storage_needed);
1526 struct cleanup *back_to = make_cleanup (xfree, symbol_table);
1527 unsigned int number_of_symbols =
1528 bfd_canonicalize_dynamic_symtab (abfd, symbol_table);
1530 for (i = 0; i < number_of_symbols; i++)
1532 asymbol *sym = *symbol_table++;
1534 if (match_sym (sym, data))
1536 /* BFD symbols are section relative. */
1537 symaddr = sym->value + sym->section->vma;
1541 do_cleanups (back_to);
1546 /* Lookup the value for a specific symbol from symbol table and dynamic
1547 symbol table. Look up symbol from ABFD. MATCH_SYM is a callback
1548 function to determine whether to pick up a symbol. DATA is the
1549 input of this callback function. Return NULL if symbol is not
1553 gdb_bfd_lookup_symbol (bfd *abfd,
1554 int (*match_sym) (asymbol *, void *),
1557 CORE_ADDR symaddr = gdb_bfd_lookup_symbol_from_symtab (abfd, match_sym, data);
1559 /* On FreeBSD, the dynamic linker is stripped by default. So we'll
1560 have to check the dynamic string table too. */
1562 symaddr = bfd_lookup_symbol_from_dyn_symtab (abfd, match_sym, data);
1567 /* SO_LIST_HEAD may contain user-loaded object files that can be removed
1568 out-of-band by the user. So upon notification of free_objfile remove
1569 all references to any user-loaded file that is about to be freed. */
1572 remove_user_added_objfile (struct objfile *objfile)
1576 if (objfile != 0 && objfile->flags & OBJF_USERLOADED)
1578 for (so = so_list_head; so != NULL; so = so->next)
1579 if (so->objfile == objfile)
1584 extern initialize_file_ftype _initialize_solib; /* -Wmissing-prototypes */
1587 _initialize_solib (void)
1589 solib_data = gdbarch_data_register_pre_init (solib_init);
1591 observer_attach_free_objfile (remove_user_added_objfile);
1593 add_com ("sharedlibrary", class_files, sharedlibrary_command,
1594 _("Load shared object library symbols for files matching REGEXP."));
1595 add_info ("sharedlibrary", info_sharedlibrary_command,
1596 _("Status of loaded shared object libraries."));
1597 add_com ("nosharedlibrary", class_files, no_shared_libraries,
1598 _("Unload all shared object library symbols."));
1600 add_setshow_boolean_cmd ("auto-solib-add", class_support,
1601 &auto_solib_add, _("\
1602 Set autoloading of shared library symbols."), _("\
1603 Show autoloading of shared library symbols."), _("\
1604 If \"on\", symbols from all shared object libraries will be loaded\n\
1605 automatically when the inferior begins execution, when the dynamic linker\n\
1606 informs gdb that a new library has been loaded, or when attaching to the\n\
1607 inferior. Otherwise, symbols must be loaded manually, using \
1610 show_auto_solib_add,
1611 &setlist, &showlist);
1613 add_setshow_optional_filename_cmd ("sysroot", class_support,
1615 Set an alternate system root."), _("\
1616 Show the current system root."), _("\
1617 The system root is used to load absolute shared library symbol files.\n\
1618 For other (relative) files, you can add directories using\n\
1619 `set solib-search-path'."),
1620 gdb_sysroot_changed,
1622 &setlist, &showlist);
1624 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1626 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1629 add_setshow_optional_filename_cmd ("solib-search-path", class_support,
1630 &solib_search_path, _("\
1631 Set the search path for loading non-absolute shared library symbol files."),
1633 Show the search path for loading non-absolute shared library symbol files."),
1635 This takes precedence over the environment variables \
1636 PATH and LD_LIBRARY_PATH."),
1637 reload_shared_libraries,
1638 show_solib_search_path,
1639 &setlist, &showlist);