1 /* Handle shared libraries for GDB, the GNU Debugger.
3 Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 2000, 2001, 2002, 2003, 2005, 2006, 2007, 2008, 2009, 2010, 2011
5 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
26 #include "gdb_string.h"
31 #include "exceptions.h"
36 #include "gdb_regex.h"
41 #include "completer.h"
42 #include "filenames.h" /* for DOSish file names */
46 #include "readline/readline.h"
50 #include "filesystem.h"
52 /* Architecture-specific operations. */
54 /* Per-architecture data key. */
55 static struct gdbarch_data
*solib_data
;
58 solib_init (struct obstack
*obstack
)
60 struct target_so_ops
**ops
;
62 ops
= OBSTACK_ZALLOC (obstack
, struct target_so_ops
*);
63 *ops
= current_target_so_ops
;
67 static struct target_so_ops
*
68 solib_ops (struct gdbarch
*gdbarch
)
70 struct target_so_ops
**ops
= gdbarch_data (gdbarch
, solib_data
);
75 /* Set the solib operations for GDBARCH to NEW_OPS. */
78 set_solib_ops (struct gdbarch
*gdbarch
, struct target_so_ops
*new_ops
)
80 struct target_so_ops
**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
121 solib_find -- Find a shared library file.
125 char *solib_find (char *in_pathname, int *fd);
129 Global variable GDB_SYSROOT is used as a prefix directory
130 to search for shared libraries if they have an absolute path.
132 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
133 (or set of directories, as in LD_LIBRARY_PATH) to search for all
134 shared libraries if not found in GDB_SYSROOT.
137 * If there is a gdb_sysroot and path is absolute:
138 * Search for gdb_sysroot/path.
140 * Look for it literally (unmodified).
141 * Look in SOLIB_SEARCH_PATH.
142 * If available, use target defined search function.
143 * If gdb_sysroot is NOT set, perform the following two searches:
144 * Look in inferior's $PATH.
145 * Look in inferior's $LD_LIBRARY_PATH.
147 * The last check avoids doing this search when targetting remote
148 * machines since gdb_sysroot will almost always be set.
152 Full pathname of the shared library file, or NULL if not found.
153 (The pathname is malloc'ed; it needs to be freed by the caller.)
154 *FD is set to either -1 or an open file handle for the library. */
157 solib_find (char *in_pathname
, int *fd
)
159 struct target_so_ops
*ops
= solib_ops (target_gdbarch
);
161 char *temp_pathname
= NULL
;
162 int gdb_sysroot_is_empty
;
163 const char *solib_symbols_extension
164 = gdbarch_solib_symbols_extension (target_gdbarch
);
165 const char *fskind
= effective_target_file_system_kind ();
166 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
167 char *sysroot
= NULL
;
169 /* If solib_symbols_extension is set, replace the file's
171 if (solib_symbols_extension
)
173 char *p
= in_pathname
+ strlen (in_pathname
);
175 while (p
> in_pathname
&& *p
!= '.')
182 new_pathname
= alloca (p
- in_pathname
+ 1
183 + strlen (solib_symbols_extension
) + 1);
184 memcpy (new_pathname
, in_pathname
, p
- in_pathname
+ 1);
185 strcpy (new_pathname
+ (p
- in_pathname
) + 1,
186 solib_symbols_extension
);
188 in_pathname
= new_pathname
;
192 gdb_sysroot_is_empty
= (gdb_sysroot
== NULL
|| *gdb_sysroot
== 0);
194 if (!gdb_sysroot_is_empty
)
196 int prefix_len
= strlen (gdb_sysroot
);
198 /* Remove trailing slashes from absolute prefix. */
199 while (prefix_len
> 0
200 && IS_DIR_SEPARATOR (gdb_sysroot
[prefix_len
- 1]))
203 sysroot
= savestring (gdb_sysroot
, prefix_len
);
204 make_cleanup (xfree
, sysroot
);
207 /* If we're on a non-DOS-based system, backslashes won't be
208 understood as directory separator, so, convert them to forward
209 slashes, iff we're supposed to handle DOS-based file system
210 semantics for target paths. */
211 if (!DOS_BASED_FILE_SYSTEM
&& fskind
== file_system_kind_dos_based
)
215 /* Avoid clobbering our input. */
216 p
= alloca (strlen (in_pathname
) + 1);
217 strcpy (p
, in_pathname
);
227 /* Note, we're interested in IS_TARGET_ABSOLUTE_PATH, not
228 IS_ABSOLUTE_PATH. The latter is for host paths only, while
229 IN_PATHNAME is a target path. For example, if we're supposed to
230 be handling DOS-like semantics we want to consider a
231 'c:/foo/bar.dll' path as an absolute path, even on a Unix box.
232 With such a path, before giving up on the sysroot, we'll try:
234 1st attempt, c:/foo/bar.dll ==> /sysroot/c:/foo/bar.dll
235 2nd attempt, c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll
236 3rd attempt, c:/foo/bar.dll ==> /sysroot/foo/bar.dll
239 if (!IS_TARGET_ABSOLUTE_PATH (fskind
, in_pathname
) || gdb_sysroot_is_empty
)
240 temp_pathname
= xstrdup (in_pathname
);
243 int need_dir_separator
;
245 need_dir_separator
= !IS_DIR_SEPARATOR (in_pathname
[0]);
247 /* Cat the prefixed pathname together. */
248 temp_pathname
= concat (sysroot
,
249 need_dir_separator
? SLASH_STRING
: "",
250 in_pathname
, (char *) NULL
);
253 /* Handle remote files. */
254 if (remote_filename_p (temp_pathname
))
257 do_cleanups (old_chain
);
258 return temp_pathname
;
261 /* Now see if we can open it. */
262 found_file
= open (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. */
272 && !gdb_sysroot_is_empty
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
= open (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
= open (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 not found, search the solib_search_path (if any). */
317 if (found_file
< 0 && solib_search_path
!= NULL
)
318 found_file
= openp (solib_search_path
, OPF_TRY_CWD_FIRST
,
319 in_pathname
, O_RDONLY
| O_BINARY
, &temp_pathname
);
321 /* If the search in gdb_sysroot failed, and the path name is
322 absolute at this point, make it relative. (openp will try and open the
323 file according to its absolute path otherwise, which is not what we want.)
324 Affects subsequent searches for this solib. */
325 if (found_file
< 0 && IS_TARGET_ABSOLUTE_PATH (fskind
, in_pathname
))
327 /* First, get rid of any drive letters etc. */
328 while (!IS_TARGET_DIR_SEPARATOR (fskind
, *in_pathname
))
331 /* Next, get rid of all leading dir separators. */
332 while (IS_TARGET_DIR_SEPARATOR (fskind
, *in_pathname
))
336 /* If not found, search the solib_search_path (if any). */
337 if (found_file
< 0 && solib_search_path
!= NULL
)
338 found_file
= openp (solib_search_path
, OPF_TRY_CWD_FIRST
,
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
, OPF_TRY_CWD_FIRST
,
346 target_lbasename (fskind
, in_pathname
),
347 O_RDONLY
| O_BINARY
, &temp_pathname
);
349 /* If not found, try to use target supplied solib search method. */
350 if (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 && gdb_sysroot_is_empty
)
356 found_file
= openp (get_in_environ (current_inferior ()->environment
,
358 OPF_TRY_CWD_FIRST
, in_pathname
, O_RDONLY
| O_BINARY
,
361 /* If not found, next search the inferior's $LD_LIBRARY_PATH
362 environment variable. */
363 if (found_file
< 0 && gdb_sysroot_is_empty
)
364 found_file
= openp (get_in_environ (current_inferior ()->environment
,
366 OPF_TRY_CWD_FIRST
, in_pathname
, O_RDONLY
| O_BINARY
,
370 return temp_pathname
;
373 /* Open and return a BFD for the shared library PATHNAME. If FD is not -1,
374 it is used as file handle to open the file. Throws an error if the file
375 could not be opened. Handles both local and remote file access.
377 PATHNAME must be malloc'ed by the caller. If successful, the new BFD's
378 name will point to it. If unsuccessful, PATHNAME will be freed and the
379 FD will be closed (unless FD was -1). */
382 solib_bfd_fopen (char *pathname
, int fd
)
386 if (remote_filename_p (pathname
))
388 gdb_assert (fd
== -1);
389 abfd
= remote_bfd_open (pathname
, gnutarget
);
393 abfd
= bfd_fopen (pathname
, gnutarget
, FOPEN_RB
, fd
);
396 bfd_set_cacheable (abfd
, 1);
403 make_cleanup (xfree
, pathname
);
404 error (_("Could not open `%s' as an executable file: %s"),
405 pathname
, bfd_errmsg (bfd_get_error ()));
411 /* Find shared library PATHNAME and open a BFD for it. */
414 solib_bfd_open (char *pathname
)
416 char *found_pathname
;
419 const struct bfd_arch_info
*b
;
421 /* Search for shared library file. */
422 found_pathname
= solib_find (pathname
, &found_file
);
423 if (found_pathname
== NULL
)
425 /* Return failure if the file could not be found, so that we can
426 accumulate messages about missing libraries. */
430 perror_with_name (pathname
);
433 /* Open bfd for shared library. */
434 abfd
= solib_bfd_fopen (found_pathname
, found_file
);
436 /* Check bfd format. */
437 if (!bfd_check_format (abfd
, bfd_object
))
440 make_cleanup (xfree
, found_pathname
);
441 error (_("`%s': not in executable format: %s"),
442 found_pathname
, bfd_errmsg (bfd_get_error ()));
445 /* Check bfd arch. */
446 b
= gdbarch_bfd_arch_info (target_gdbarch
);
447 if (!b
->compatible (b
, bfd_get_arch_info (abfd
)))
448 warning (_("`%s': Shared library architecture %s is not compatible "
449 "with target architecture %s."), found_pathname
,
450 bfd_get_arch_info (abfd
)->printable_name
, b
->printable_name
);
460 solib_map_sections -- open bfd and build sections for shared lib
464 static int solib_map_sections (struct so_list *so)
468 Given a pointer to one of the shared objects in our list
469 of mapped objects, use the recorded name to open a bfd
470 descriptor for the object, build a section table, and then
471 relocate all the section addresses by the base address at
472 which the shared object was mapped.
476 In most (all?) cases the shared object file name recorded in the
477 dynamic linkage tables will be a fully qualified pathname. For
478 cases where it isn't, do we really mimic the systems search
479 mechanism correctly in the below code (particularly the tilde
484 solib_map_sections (struct so_list
*so
)
486 struct target_so_ops
*ops
= solib_ops (target_gdbarch
);
488 struct target_section
*p
;
489 struct cleanup
*old_chain
;
492 filename
= tilde_expand (so
->so_name
);
493 old_chain
= make_cleanup (xfree
, filename
);
494 abfd
= ops
->bfd_open (filename
);
495 do_cleanups (old_chain
);
500 /* Leave bfd open, core_xfer_memory and "info files" need it. */
501 so
->abfd
= gdb_bfd_ref (abfd
);
503 /* copy full path name into so_name, so that later symbol_file_add
505 if (strlen (bfd_get_filename (abfd
)) >= SO_NAME_MAX_PATH_SIZE
)
506 error (_("Shared library file name is too long."));
507 strcpy (so
->so_name
, bfd_get_filename (abfd
));
509 if (build_section_table (abfd
, &so
->sections
, &so
->sections_end
))
511 error (_("Can't find the file sections in `%s': %s"),
512 bfd_get_filename (abfd
), bfd_errmsg (bfd_get_error ()));
515 for (p
= so
->sections
; p
< so
->sections_end
; p
++)
517 /* Relocate the section binding addresses as recorded in the shared
518 object's file by the base address to which the object was actually
520 ops
->relocate_section_addresses (so
, p
);
522 /* If the target didn't provide information about the address
523 range of the shared object, assume we want the location of
524 the .text section. */
525 if (so
->addr_low
== 0 && so
->addr_high
== 0
526 && strcmp (p
->the_bfd_section
->name
, ".text") == 0)
528 so
->addr_low
= p
->addr
;
529 so
->addr_high
= p
->endaddr
;
533 /* Add the shared object's sections to the current set of file
534 section tables. Do this immediately after mapping the object so
535 that later nodes in the list can query this object, as is needed
537 add_target_sections (so
->sections
, so
->sections_end
);
542 /* Free symbol-file related contents of SO. If we have opened a BFD
543 for SO, close it. If we have placed SO's sections in some target's
544 section table, the caller is responsible for removing them.
546 This function doesn't mess with objfiles at all. If there is an
547 objfile associated with SO that needs to be removed, the caller is
548 responsible for taking care of that. */
551 free_so_symbols (struct so_list
*so
)
555 xfree (so
->sections
);
556 so
->sections
= so
->sections_end
= NULL
;
559 gdb_bfd_unref (so
->abfd
);
562 /* Our caller closed the objfile, possibly via objfile_purge_solibs. */
563 so
->symbols_loaded
= 0;
566 so
->addr_low
= so
->addr_high
= 0;
568 /* Restore the target-supplied file name. SO_NAME may be the path
569 of the symbol file. */
570 strcpy (so
->so_name
, so
->so_original_name
);
575 free_so --- free a `struct so_list' object
579 void free_so (struct so_list *so)
583 Free the storage associated with the `struct so_list' object SO.
584 If we have opened a BFD for SO, close it.
586 The caller is responsible for removing SO from whatever list it is
587 a member of. If we have placed SO's sections in some target's
588 section table, the caller is responsible for removing them.
590 This function doesn't mess with objfiles at all. If there is an
591 objfile associated with SO that needs to be removed, the caller is
592 responsible for taking care of that. */
595 free_so (struct so_list
*so
)
597 struct target_so_ops
*ops
= solib_ops (target_gdbarch
);
599 free_so_symbols (so
);
606 /* Return address of first so_list entry in master shared object list. */
608 master_so_list (void)
613 /* Read in symbols for shared object SO. If SYMFILE_VERBOSE is set in FLAGS,
614 be chatty about it. Return non-zero if any symbols were actually
618 solib_read_symbols (struct so_list
*so
, int flags
)
620 const int from_tty
= flags
& SYMFILE_VERBOSE
;
622 if (so
->symbols_loaded
)
624 /* If needed, we've already warned in our caller. */
626 else if (so
->abfd
== NULL
)
628 /* We've already warned about this library, when trying to open
633 volatile struct gdb_exception e
;
635 TRY_CATCH (e
, RETURN_MASK_ERROR
)
637 struct section_addr_info
*sap
;
639 /* Have we already loaded this shared object? */
640 ALL_OBJFILES (so
->objfile
)
642 if (filename_cmp (so
->objfile
->name
, so
->so_name
) == 0
643 && so
->objfile
->addr_low
== so
->addr_low
)
646 if (so
->objfile
!= NULL
)
649 sap
= build_section_addr_info_from_section_table (so
->sections
,
651 so
->objfile
= symbol_file_add_from_bfd (so
->abfd
,
652 flags
, sap
, OBJF_SHARED
,
654 so
->objfile
->addr_low
= so
->addr_low
;
655 free_section_addr_info (sap
);
659 exception_fprintf (gdb_stderr
, e
, _("Error while reading shared"
660 " library symbols for %s:\n"),
664 if (from_tty
|| info_verbose
)
665 printf_unfiltered (_("Loaded symbols for %s\n"), so
->so_name
);
666 so
->symbols_loaded
= 1;
676 update_solib_list --- synchronize GDB's shared object list with inferior's
680 void update_solib_list (int from_tty, struct target_ops *TARGET)
682 Extract the list of currently loaded shared objects from the
683 inferior, and compare it with the list of shared objects currently
684 in GDB's so_list_head list. Edit so_list_head to bring it in sync
685 with the inferior's new list.
687 If we notice that the inferior has unloaded some shared objects,
688 free any symbolic info GDB had read about those shared objects.
690 Don't load symbolic info for any new shared objects; just add them
691 to the list, and leave their symbols_loaded flag clear.
693 If FROM_TTY is non-null, feel free to print messages about what
696 If TARGET is non-null, add the sections of all new shared objects
697 to TARGET's section table. Note that this doesn't remove any
698 sections for shared objects that have been unloaded, and it
699 doesn't check to see if the new shared objects are already present in
700 the section table. But we only use this for core files and
701 processes we've just attached to, so that's okay. */
704 update_solib_list (int from_tty
, struct target_ops
*target
)
706 struct target_so_ops
*ops
= solib_ops (target_gdbarch
);
707 struct so_list
*inferior
= ops
->current_sos();
708 struct so_list
*gdb
, **gdb_link
;
710 /* We can reach here due to changing solib-search-path or the
711 sysroot, before having any inferior. */
712 if (target_has_execution
&& !ptid_equal (inferior_ptid
, null_ptid
))
714 struct inferior
*inf
= current_inferior ();
716 /* If we are attaching to a running process for which we
717 have not opened a symbol file, we may be able to get its
719 if (inf
->attach_flag
&& symfile_objfile
== NULL
)
720 catch_errors (ops
->open_symbol_file_object
, &from_tty
,
721 "Error reading attached process's symbol file.\n",
725 /* GDB and the inferior's dynamic linker each maintain their own
726 list of currently loaded shared objects; we want to bring the
727 former in sync with the latter. Scan both lists, seeing which
728 shared objects appear where. There are three cases:
730 - A shared object appears on both lists. This means that GDB
731 knows about it already, and it's still loaded in the inferior.
732 Nothing needs to happen.
734 - A shared object appears only on GDB's list. This means that
735 the inferior has unloaded it. We should remove the shared
736 object from GDB's tables.
738 - A shared object appears only on the inferior's list. This
739 means that it's just been loaded. We should add it to GDB's
742 So we walk GDB's list, checking each entry to see if it appears
743 in the inferior's list too. If it does, no action is needed, and
744 we remove it from the inferior's list. If it doesn't, the
745 inferior has unloaded it, and we remove it from GDB's list. By
746 the time we're done walking GDB's list, the inferior's list
747 contains only the new shared objects, which we then add. */
750 gdb_link
= &so_list_head
;
753 struct so_list
*i
= inferior
;
754 struct so_list
**i_link
= &inferior
;
756 /* Check to see whether the shared object *gdb also appears in
757 the inferior's current list. */
762 if (ops
->same (gdb
, i
))
767 if (! filename_cmp (gdb
->so_original_name
, i
->so_original_name
))
775 /* If the shared object appears on the inferior's list too, then
776 it's still loaded, so we don't need to do anything. Delete
777 it from the inferior's list, and leave it on GDB's list. */
782 gdb_link
= &gdb
->next
;
786 /* If it's not on the inferior's list, remove it from GDB's tables. */
789 /* Notify any observer that the shared object has been
790 unloaded before we remove it from GDB's tables. */
791 observer_notify_solib_unloaded (gdb
);
793 *gdb_link
= gdb
->next
;
795 /* Unless the user loaded it explicitly, free SO's objfile. */
796 if (gdb
->objfile
&& ! (gdb
->objfile
->flags
& OBJF_USERLOADED
))
797 free_objfile (gdb
->objfile
);
799 /* Some targets' section tables might be referring to
800 sections from so->abfd; remove them. */
801 remove_target_sections (gdb
->abfd
);
808 /* Now the inferior's list contains only shared objects that don't
809 appear in GDB's list --- those that are newly loaded. Add them
810 to GDB's shared object list. */
814 const char *not_found_filename
= NULL
;
818 /* Add the new shared objects to GDB's list. */
819 *gdb_link
= inferior
;
821 /* Fill in the rest of each of the `struct so_list' nodes. */
822 for (i
= inferior
; i
; i
= i
->next
)
824 volatile struct gdb_exception e
;
826 i
->pspace
= current_program_space
;
828 TRY_CATCH (e
, RETURN_MASK_ERROR
)
830 /* Fill in the rest of the `struct so_list' node. */
831 if (!solib_map_sections (i
))
834 if (not_found_filename
== NULL
)
835 not_found_filename
= i
->so_original_name
;
840 exception_fprintf (gdb_stderr
, e
,
841 _("Error while mapping shared "
842 "library sections:\n"));
844 /* Notify any observer that the shared object has been
845 loaded now that we've added it to GDB's tables. */
846 observer_notify_solib_loaded (i
);
849 /* If a library was not found, issue an appropriate warning
850 message. We have to use a single call to warning in case the
851 front end does something special with warnings, e.g., pop up
852 a dialog box. It Would Be Nice if we could get a "warning: "
853 prefix on each line in the CLI front end, though - it doesn't
857 warning (_("Could not load shared library symbols for %s.\n"
858 "Do you need \"set solib-search-path\" "
859 "or \"set sysroot\"?"),
861 else if (not_found
> 1)
863 Could not load shared library symbols for %d libraries, e.g. %s.\n\
864 Use the \"info sharedlibrary\" command to see the complete listing.\n\
865 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
866 not_found
, not_found_filename
);
871 /* Return non-zero if NAME is the libpthread shared library.
873 Uses a fairly simplistic heuristic approach where we check
874 the file name against "/libpthread". This can lead to false
875 positives, but this should be good enough in practice. */
878 libpthread_name_p (const char *name
)
880 return (strstr (name
, "/libpthread") != NULL
);
883 /* Return non-zero if SO is the libpthread shared library. */
886 libpthread_solib_p (struct so_list
*so
)
888 return libpthread_name_p (so
->so_name
);
893 solib_add -- read in symbol info for newly added shared libraries
897 void solib_add (char *pattern, int from_tty, struct target_ops
898 *TARGET, int readsyms)
902 Read in symbolic information for any shared objects whose names
903 match PATTERN. (If we've already read a shared object's symbol
904 info, leave it alone.) If PATTERN is zero, read them all.
906 If READSYMS is 0, defer reading symbolic information until later
907 but still do any needed low level processing.
909 FROM_TTY and TARGET are as described for update_solib_list, above. */
912 solib_add (char *pattern
, int from_tty
,
913 struct target_ops
*target
, int readsyms
)
917 current_program_space
->solib_add_generation
++;
921 char *re_err
= re_comp (pattern
);
924 error (_("Invalid regexp: %s"), re_err
);
927 update_solib_list (from_tty
, target
);
929 /* Walk the list of currently loaded shared libraries, and read
930 symbols for any that match the pattern --- or any whose symbols
931 aren't already loaded, if no pattern was given. */
934 int loaded_any_symbols
= 0;
936 SYMFILE_DEFER_BP_RESET
| (from_tty
? SYMFILE_VERBOSE
: 0);
938 for (gdb
= so_list_head
; gdb
; gdb
= gdb
->next
)
939 if (! pattern
|| re_exec (gdb
->so_name
))
941 /* Normally, we would read the symbols from that library
942 only if READSYMS is set. However, we're making a small
943 exception for the pthread library, because we sometimes
944 need the library symbols to be loaded in order to provide
945 thread support (x86-linux for instance). */
946 const int add_this_solib
=
947 (readsyms
|| libpthread_solib_p (gdb
));
952 if (gdb
->symbols_loaded
)
954 /* If no pattern was given, be quiet for shared
955 libraries we have already loaded. */
956 if (pattern
&& (from_tty
|| info_verbose
))
957 printf_unfiltered (_("Symbols already loaded for %s\n"),
960 else if (solib_read_symbols (gdb
, flags
))
961 loaded_any_symbols
= 1;
965 if (loaded_any_symbols
)
966 breakpoint_re_set ();
968 if (from_tty
&& pattern
&& ! any_matches
)
970 ("No loaded shared libraries match the pattern `%s'.\n", pattern
);
972 if (loaded_any_symbols
)
974 struct target_so_ops
*ops
= solib_ops (target_gdbarch
);
976 /* Getting new symbols may change our opinion about what is
978 reinit_frame_cache ();
980 ops
->special_symbol_handling ();
990 info_sharedlibrary_command -- code for "info sharedlibrary"
994 static void info_sharedlibrary_command ()
998 Walk through the shared library list and print information
999 about each attached library matching PATTERN. If PATTERN is elided,
1004 info_sharedlibrary_command (char *pattern
, int from_tty
)
1006 struct so_list
*so
= NULL
; /* link map state variable */
1007 int so_missing_debug_info
= 0;
1010 struct cleanup
*table_cleanup
;
1011 struct gdbarch
*gdbarch
= target_gdbarch
;
1015 char *re_err
= re_comp (pattern
);
1018 error (_("Invalid regexp: %s"), re_err
);
1021 /* "0x", a little whitespace, and two hex digits per byte of pointers. */
1022 addr_width
= 4 + (gdbarch_ptr_bit (gdbarch
) / 4);
1024 update_solib_list (from_tty
, 0);
1026 /* make_cleanup_ui_out_table_begin_end needs to know the number of
1027 rows, so we need to make two passes over the libs. */
1029 for (nr_libs
= 0, so
= so_list_head
; so
; so
= so
->next
)
1033 if (pattern
&& ! re_exec (so
->so_name
))
1040 make_cleanup_ui_out_table_begin_end (uiout
, 4, nr_libs
,
1041 "SharedLibraryTable");
1043 /* The "- 1" is because ui_out adds one space between columns. */
1044 ui_out_table_header (uiout
, addr_width
- 1, ui_left
, "from", "From");
1045 ui_out_table_header (uiout
, addr_width
- 1, ui_left
, "to", "To");
1046 ui_out_table_header (uiout
, 12 - 1, ui_left
, "syms-read", "Syms Read");
1047 ui_out_table_header (uiout
, 0, ui_noalign
,
1048 "name", "Shared Object Library");
1050 ui_out_table_body (uiout
);
1052 for (so
= so_list_head
; so
; so
= so
->next
)
1054 struct cleanup
*lib_cleanup
;
1056 if (! so
->so_name
[0])
1058 if (pattern
&& ! re_exec (so
->so_name
))
1061 lib_cleanup
= make_cleanup_ui_out_tuple_begin_end (uiout
, "lib");
1063 if (so
->addr_high
!= 0)
1065 ui_out_field_core_addr (uiout
, "from", gdbarch
, so
->addr_low
);
1066 ui_out_field_core_addr (uiout
, "to", gdbarch
, so
->addr_high
);
1070 ui_out_field_skip (uiout
, "from");
1071 ui_out_field_skip (uiout
, "to");
1074 if (! ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ()))
1075 && so
->symbols_loaded
1076 && !objfile_has_symbols (so
->objfile
))
1078 so_missing_debug_info
= 1;
1079 ui_out_field_string (uiout
, "syms-read", "Yes (*)");
1082 ui_out_field_string (uiout
, "syms-read",
1083 so
->symbols_loaded
? "Yes" : "No");
1085 ui_out_field_string (uiout
, "name", so
->so_name
);
1087 ui_out_text (uiout
, "\n");
1089 do_cleanups (lib_cleanup
);
1092 do_cleanups (table_cleanup
);
1097 ui_out_message (uiout
, 0,
1098 _("No shared libraries matched.\n"));
1100 ui_out_message (uiout
, 0,
1101 _("No shared libraries loaded at this time.\n"));
1105 if (so_missing_debug_info
)
1106 ui_out_message (uiout
, 0,
1107 _("(*): Shared library is missing "
1108 "debugging information.\n"));
1112 /* Return 1 if ADDRESS lies within SOLIB. */
1115 solib_contains_address_p (const struct so_list
*const solib
,
1118 struct target_section
*p
;
1120 for (p
= solib
->sections
; p
< solib
->sections_end
; p
++)
1121 if (p
->addr
<= address
&& address
< p
->endaddr
)
1131 solib_name_from_address -- if an address is in a shared lib, return
1136 char * solib_name_from_address (CORE_ADDR address)
1140 Provides a hook for other gdb routines to discover whether or
1141 not a particular address is within the mapped address space of
1144 For example, this routine is called at one point to disable
1145 breakpoints which are in shared libraries that are not currently
1150 solib_name_from_address (struct program_space
*pspace
, CORE_ADDR address
)
1152 struct so_list
*so
= NULL
;
1154 for (so
= pspace
->so_list
; so
; so
= so
->next
)
1155 if (solib_contains_address_p (so
, address
))
1156 return (so
->so_name
);
1161 /* Return whether the data starting at VADDR, size SIZE, must be kept
1162 in a core file for shared libraries loaded before "gcore" is used
1163 to be handled correctly when the core file is loaded. This only
1164 applies when the section would otherwise not be kept in the core
1165 file (in particular, for readonly sections). */
1168 solib_keep_data_in_core (CORE_ADDR vaddr
, unsigned long size
)
1170 struct target_so_ops
*ops
= solib_ops (target_gdbarch
);
1172 if (ops
->keep_data_in_core
)
1173 return ops
->keep_data_in_core (vaddr
, size
);
1178 /* Called by free_all_symtabs */
1183 struct target_so_ops
*ops
= solib_ops (target_gdbarch
);
1185 /* This function is expected to handle ELF shared libraries. It is
1186 also used on Solaris, which can run either ELF or a.out binaries
1187 (for compatibility with SunOS 4), both of which can use shared
1188 libraries. So we don't know whether we have an ELF executable or
1189 an a.out executable until the user chooses an executable file.
1191 ELF shared libraries don't get mapped into the address space
1192 until after the program starts, so we'd better not try to insert
1193 breakpoints in them immediately. We have to wait until the
1194 dynamic linker has loaded them; we'll hit a bp_shlib_event
1195 breakpoint (look for calls to create_solib_event_breakpoint) when
1198 SunOS shared libraries seem to be different --- they're present
1199 as soon as the process begins execution, so there's no need to
1200 put off inserting breakpoints. There's also nowhere to put a
1201 bp_shlib_event breakpoint, so if we put it off, we'll never get
1204 So: disable breakpoints only if we're using ELF shared libs. */
1205 if (exec_bfd
!= NULL
1206 && bfd_get_flavour (exec_bfd
) != bfd_target_aout_flavour
)
1207 disable_breakpoints_in_shlibs ();
1209 while (so_list_head
)
1211 struct so_list
*so
= so_list_head
;
1213 so_list_head
= so
->next
;
1214 observer_notify_solib_unloaded (so
);
1216 remove_target_sections (so
->abfd
);
1220 ops
->clear_solib ();
1225 solib_create_inferior_hook -- shared library startup support
1229 void solib_create_inferior_hook (int from_tty)
1233 When gdb starts up the inferior, it nurses it along (through the
1234 shell) until it is ready to execute it's first instruction. At this
1235 point, this function gets called via expansion of the macro
1236 SOLIB_CREATE_INFERIOR_HOOK. */
1239 solib_create_inferior_hook (int from_tty
)
1241 struct target_so_ops
*ops
= solib_ops (target_gdbarch
);
1243 ops
->solib_create_inferior_hook (from_tty
);
1248 in_solib_dynsym_resolve_code -- check to see if an address is in
1249 dynamic loader's dynamic symbol
1254 int in_solib_dynsym_resolve_code (CORE_ADDR pc)
1258 Determine if PC is in the dynamic linker's symbol resolution
1259 code. Return 1 if so, 0 otherwise.
1263 in_solib_dynsym_resolve_code (CORE_ADDR pc
)
1265 struct target_so_ops
*ops
= solib_ops (target_gdbarch
);
1267 return ops
->in_dynsym_resolve_code (pc
);
1274 sharedlibrary_command -- handle command to explicitly add library
1278 static void sharedlibrary_command (char *args, int from_tty)
1285 sharedlibrary_command (char *args
, int from_tty
)
1288 solib_add (args
, from_tty
, (struct target_ops
*) 0, 1);
1293 no_shared_libraries -- handle command to explicitly discard symbols
1294 from shared libraries.
1298 Implements the command "nosharedlibrary", which discards symbols
1299 that have been auto-loaded from shared libraries. Symbols from
1300 shared libraries that were added by explicit request of the user
1301 are not discarded. Also called from remote.c. */
1304 no_shared_libraries (char *ignored
, int from_tty
)
1306 /* The order of the two routines below is important: clear_solib notifies
1307 the solib_unloaded observers, and some of these observers might need
1308 access to their associated objfiles. Therefore, we can not purge the
1309 solibs' objfiles before clear_solib has been called. */
1312 objfile_purge_solibs ();
1315 /* Reload shared libraries, but avoid reloading the same symbol file
1316 we already have loaded. */
1319 reload_shared_libraries_1 (int from_tty
)
1322 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
1324 for (so
= so_list_head
; so
!= NULL
; so
= so
->next
)
1326 char *filename
, *found_pathname
= NULL
;
1328 int was_loaded
= so
->symbols_loaded
;
1330 SYMFILE_DEFER_BP_RESET
| (from_tty
? SYMFILE_VERBOSE
: 0);
1332 filename
= tilde_expand (so
->so_original_name
);
1333 make_cleanup (xfree
, filename
);
1334 abfd
= solib_bfd_open (filename
);
1337 found_pathname
= xstrdup (bfd_get_filename (abfd
));
1338 make_cleanup (xfree
, found_pathname
);
1339 gdb_bfd_close_or_warn (abfd
);
1342 /* If this shared library is no longer associated with its previous
1343 symbol file, close that. */
1344 if ((found_pathname
== NULL
&& was_loaded
)
1345 || (found_pathname
!= NULL
1346 && filename_cmp (found_pathname
, so
->so_name
) != 0))
1348 if (so
->objfile
&& ! (so
->objfile
->flags
& OBJF_USERLOADED
))
1349 free_objfile (so
->objfile
);
1350 remove_target_sections (so
->abfd
);
1351 free_so_symbols (so
);
1354 /* If this shared library is now associated with a new symbol
1356 if (found_pathname
!= NULL
1358 || filename_cmp (found_pathname
, so
->so_name
) != 0))
1360 volatile struct gdb_exception e
;
1362 TRY_CATCH (e
, RETURN_MASK_ERROR
)
1363 solib_map_sections (so
);
1366 exception_fprintf (gdb_stderr
, e
,
1367 _("Error while mapping "
1368 "shared library sections:\n"));
1369 else if (auto_solib_add
|| was_loaded
|| libpthread_solib_p (so
))
1370 solib_read_symbols (so
, flags
);
1374 do_cleanups (old_chain
);
1378 reload_shared_libraries (char *ignored
, int from_tty
,
1379 struct cmd_list_element
*e
)
1381 struct target_so_ops
*ops
;
1383 reload_shared_libraries_1 (from_tty
);
1385 ops
= solib_ops (target_gdbarch
);
1387 /* Creating inferior hooks here has two purposes. First, if we reload
1388 shared libraries then the address of solib breakpoint we've computed
1389 previously might be no longer valid. For example, if we forgot to set
1390 solib-absolute-prefix and are setting it right now, then the previous
1391 breakpoint address is plain wrong. Second, installing solib hooks
1392 also implicitly figures were ld.so is and loads symbols for it.
1393 Absent this call, if we've just connected to a target and set
1394 solib-absolute-prefix or solib-search-path, we'll lose all information
1396 if (target_has_execution
)
1398 /* Reset or free private data structures not associated with
1400 ops
->clear_solib ();
1402 /* Remove any previous solib event breakpoint. This is usually
1403 done in common code, at breakpoint_init_inferior time, but
1404 we're not really starting up the inferior here. */
1405 remove_solib_event_breakpoints ();
1407 #ifdef SOLIB_CREATE_INFERIOR_HOOK
1408 SOLIB_CREATE_INFERIOR_HOOK (PIDGET (inferior_ptid
));
1410 solib_create_inferior_hook (from_tty
);
1414 /* Sometimes the platform-specific hook loads initial shared
1415 libraries, and sometimes it doesn't. If it doesn't FROM_TTY will be
1416 incorrectly 0 but such solib targets should be fixed anyway. If we
1417 made all the inferior hook methods consistent, this call could be
1418 removed. Call it only after the solib target has been initialized by
1419 solib_create_inferior_hook. */
1421 solib_add (NULL
, 0, NULL
, auto_solib_add
);
1423 breakpoint_re_set ();
1425 /* We may have loaded or unloaded debug info for some (or all)
1426 shared libraries. However, frames may still reference them. For
1427 example, a frame's unwinder might still point at DWARF FDE
1428 structures that are now freed. Also, getting new symbols may
1429 change our opinion about what is frameless. */
1430 reinit_frame_cache ();
1432 ops
->special_symbol_handling ();
1436 show_auto_solib_add (struct ui_file
*file
, int from_tty
,
1437 struct cmd_list_element
*c
, const char *value
)
1439 fprintf_filtered (file
, _("Autoloading of shared library symbols is %s.\n"),
1444 /* Handler for library-specific lookup of global symbol NAME in OBJFILE. Call
1445 the library-specific handler if it is installed for the current target. */
1448 solib_global_lookup (const struct objfile
*objfile
,
1450 const domain_enum domain
)
1452 struct target_so_ops
*ops
= solib_ops (target_gdbarch
);
1454 if (ops
->lookup_lib_global_symbol
!= NULL
)
1455 return ops
->lookup_lib_global_symbol (objfile
, name
, domain
);
1460 extern initialize_file_ftype _initialize_solib
; /* -Wmissing-prototypes */
1463 _initialize_solib (void)
1465 solib_data
= gdbarch_data_register_pre_init (solib_init
);
1467 add_com ("sharedlibrary", class_files
, sharedlibrary_command
,
1468 _("Load shared object library symbols for files matching REGEXP."));
1469 add_info ("sharedlibrary", info_sharedlibrary_command
,
1470 _("Status of loaded shared object libraries."));
1471 add_com ("nosharedlibrary", class_files
, no_shared_libraries
,
1472 _("Unload all shared object library symbols."));
1474 add_setshow_boolean_cmd ("auto-solib-add", class_support
,
1475 &auto_solib_add
, _("\
1476 Set autoloading of shared library symbols."), _("\
1477 Show autoloading of shared library symbols."), _("\
1478 If \"on\", symbols from all shared object libraries will be loaded\n\
1479 automatically when the inferior begins execution, when the dynamic linker\n\
1480 informs gdb that a new library has been loaded, or when attaching to the\n\
1481 inferior. Otherwise, symbols must be loaded manually, using \
1484 show_auto_solib_add
,
1485 &setlist
, &showlist
);
1487 add_setshow_filename_cmd ("sysroot", class_support
,
1489 Set an alternate system root."), _("\
1490 Show the current system root."), _("\
1491 The system root is used to load absolute shared library symbol files.\n\
1492 For other (relative) files, you can add directories using\n\
1493 `set solib-search-path'."),
1494 reload_shared_libraries
,
1496 &setlist
, &showlist
);
1498 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support
, 0,
1500 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support
, 0,
1503 add_setshow_optional_filename_cmd ("solib-search-path", class_support
,
1504 &solib_search_path
, _("\
1505 Set the search path for loading non-absolute shared library symbol files."),
1507 Show the search path for loading non-absolute shared library symbol files."),
1509 This takes precedence over the environment variables \
1510 PATH and LD_LIBRARY_PATH."),
1511 reload_shared_libraries
,
1512 show_solib_search_path
,
1513 &setlist
, &showlist
);