1 /* Handle shared libraries for GDB, the GNU Debugger.
3 Copyright (C) 1990-2013 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>
24 #include "gdb_string.h"
29 #include "exceptions.h"
34 #include "gdb_regex.h"
39 #include "completer.h"
40 #include "filenames.h" /* for DOSish file names */
44 #include "readline/readline.h"
48 #include "filesystem.h"
51 /* Architecture-specific operations. */
53 /* Per-architecture data key. */
54 static struct gdbarch_data
*solib_data
;
57 solib_init (struct obstack
*obstack
)
59 struct target_so_ops
**ops
;
61 ops
= OBSTACK_ZALLOC (obstack
, struct target_so_ops
*);
62 *ops
= current_target_so_ops
;
66 static struct target_so_ops
*
67 solib_ops (struct gdbarch
*gdbarch
)
69 struct target_so_ops
**ops
= gdbarch_data (gdbarch
, solib_data
);
74 /* Set the solib operations for GDBARCH to NEW_OPS. */
77 set_solib_ops (struct gdbarch
*gdbarch
, struct target_so_ops
*new_ops
)
79 struct target_so_ops
**ops
= gdbarch_data (gdbarch
, solib_data
);
85 /* external data declarations */
87 /* FIXME: gdbarch needs to control this variable, or else every
88 configuration needs to call set_solib_ops. */
89 struct target_so_ops
*current_target_so_ops
;
91 /* List of known shared objects */
92 #define so_list_head current_program_space->so_list
94 /* Local function prototypes */
96 /* If non-empty, this is a search path for loading non-absolute shared library
97 symbol files. This takes precedence over the environment variables PATH
98 and LD_LIBRARY_PATH. */
99 static char *solib_search_path
= NULL
;
101 show_solib_search_path (struct ui_file
*file
, int from_tty
,
102 struct cmd_list_element
*c
, const char *value
)
104 fprintf_filtered (file
, _("The search path for loading non-absolute "
105 "shared library symbol files is %s.\n"),
109 /* Same as HAVE_DOS_BASED_FILE_SYSTEM, but useable as an rvalue. */
110 #if (HAVE_DOS_BASED_FILE_SYSTEM)
111 # define DOS_BASED_FILE_SYSTEM 1
113 # define DOS_BASED_FILE_SYSTEM 0
116 /* Returns the full pathname of the shared library file, or NULL if
117 not found. (The pathname is malloc'ed; it needs to be freed by the
118 caller.) *FD is set to either -1 or an open file handle for the
121 Global variable GDB_SYSROOT is used as a prefix directory
122 to search for shared libraries if they have an absolute path.
124 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
125 (or set of directories, as in LD_LIBRARY_PATH) to search for all
126 shared libraries if not found in GDB_SYSROOT.
129 * If there is a gdb_sysroot and path is absolute:
130 * Search for gdb_sysroot/path.
132 * Look for it literally (unmodified).
133 * Look in SOLIB_SEARCH_PATH.
134 * If available, use target defined search function.
135 * If gdb_sysroot is NOT set, perform the following two searches:
136 * Look in inferior's $PATH.
137 * Look in inferior's $LD_LIBRARY_PATH.
139 * The last check avoids doing this search when targetting remote
140 * machines since gdb_sysroot will almost always be set.
144 solib_find (char *in_pathname
, int *fd
)
146 struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
148 char *temp_pathname
= NULL
;
149 int gdb_sysroot_is_empty
;
150 const char *solib_symbols_extension
151 = gdbarch_solib_symbols_extension (target_gdbarch ());
152 const char *fskind
= effective_target_file_system_kind ();
153 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
154 char *sysroot
= NULL
;
156 /* If solib_symbols_extension is set, replace the file's
158 if (solib_symbols_extension
)
160 char *p
= in_pathname
+ strlen (in_pathname
);
162 while (p
> in_pathname
&& *p
!= '.')
169 new_pathname
= alloca (p
- in_pathname
+ 1
170 + strlen (solib_symbols_extension
) + 1);
171 memcpy (new_pathname
, in_pathname
, p
- in_pathname
+ 1);
172 strcpy (new_pathname
+ (p
- in_pathname
) + 1,
173 solib_symbols_extension
);
175 in_pathname
= new_pathname
;
179 gdb_sysroot_is_empty
= (gdb_sysroot
== NULL
|| *gdb_sysroot
== 0);
181 if (!gdb_sysroot_is_empty
)
183 int prefix_len
= strlen (gdb_sysroot
);
185 /* Remove trailing slashes from absolute prefix. */
186 while (prefix_len
> 0
187 && IS_DIR_SEPARATOR (gdb_sysroot
[prefix_len
- 1]))
190 sysroot
= savestring (gdb_sysroot
, prefix_len
);
191 make_cleanup (xfree
, sysroot
);
194 /* If we're on a non-DOS-based system, backslashes won't be
195 understood as directory separator, so, convert them to forward
196 slashes, iff we're supposed to handle DOS-based file system
197 semantics for target paths. */
198 if (!DOS_BASED_FILE_SYSTEM
&& fskind
== file_system_kind_dos_based
)
202 /* Avoid clobbering our input. */
203 p
= alloca (strlen (in_pathname
) + 1);
204 strcpy (p
, in_pathname
);
214 /* Note, we're interested in IS_TARGET_ABSOLUTE_PATH, not
215 IS_ABSOLUTE_PATH. The latter is for host paths only, while
216 IN_PATHNAME is a target path. For example, if we're supposed to
217 be handling DOS-like semantics we want to consider a
218 'c:/foo/bar.dll' path as an absolute path, even on a Unix box.
219 With such a path, before giving up on the sysroot, we'll try:
221 1st attempt, c:/foo/bar.dll ==> /sysroot/c:/foo/bar.dll
222 2nd attempt, c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll
223 3rd attempt, c:/foo/bar.dll ==> /sysroot/foo/bar.dll
226 if (!IS_TARGET_ABSOLUTE_PATH (fskind
, in_pathname
) || gdb_sysroot_is_empty
)
227 temp_pathname
= xstrdup (in_pathname
);
230 int need_dir_separator
;
232 need_dir_separator
= !IS_DIR_SEPARATOR (in_pathname
[0]);
234 /* Cat the prefixed pathname together. */
235 temp_pathname
= concat (sysroot
,
236 need_dir_separator
? SLASH_STRING
: "",
237 in_pathname
, (char *) NULL
);
240 /* Handle remote files. */
241 if (remote_filename_p (temp_pathname
))
244 do_cleanups (old_chain
);
245 return temp_pathname
;
248 /* Now see if we can open it. */
249 found_file
= open (temp_pathname
, O_RDONLY
| O_BINARY
, 0);
251 xfree (temp_pathname
);
253 /* If the search in gdb_sysroot failed, and the path name has a
254 drive spec (e.g, c:/foo), try stripping ':' from the drive spec,
255 and retrying in the sysroot:
256 c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll. */
259 && !gdb_sysroot_is_empty
260 && HAS_TARGET_DRIVE_SPEC (fskind
, in_pathname
))
262 int need_dir_separator
= !IS_DIR_SEPARATOR (in_pathname
[2]);
263 char *drive
= savestring (in_pathname
, 1);
265 temp_pathname
= concat (sysroot
,
268 need_dir_separator
? SLASH_STRING
: "",
269 in_pathname
+ 2, (char *) NULL
);
272 found_file
= open (temp_pathname
, O_RDONLY
| O_BINARY
, 0);
275 xfree (temp_pathname
);
277 /* If the search in gdb_sysroot still failed, try fully
278 stripping the drive spec, and trying once more in the
279 sysroot before giving up.
281 c:/foo/bar.dll ==> /sysroot/foo/bar.dll. */
283 temp_pathname
= concat (sysroot
,
284 need_dir_separator
? SLASH_STRING
: "",
285 in_pathname
+ 2, (char *) NULL
);
287 found_file
= open (temp_pathname
, O_RDONLY
| O_BINARY
, 0);
289 xfree (temp_pathname
);
293 do_cleanups (old_chain
);
295 /* We try to find the library in various ways. After each attempt,
296 either found_file >= 0 and temp_pathname is a malloc'd string, or
297 found_file < 0 and temp_pathname does not point to storage that
298 needs to be freed. */
301 temp_pathname
= NULL
;
303 /* If the search in gdb_sysroot failed, and the path name is
304 absolute at this point, make it relative. (openp will try and open the
305 file according to its absolute path otherwise, which is not what we want.)
306 Affects subsequent searches for this solib. */
307 if (found_file
< 0 && IS_TARGET_ABSOLUTE_PATH (fskind
, in_pathname
))
309 /* First, get rid of any drive letters etc. */
310 while (!IS_TARGET_DIR_SEPARATOR (fskind
, *in_pathname
))
313 /* Next, get rid of all leading dir separators. */
314 while (IS_TARGET_DIR_SEPARATOR (fskind
, *in_pathname
))
318 /* If not found, search the solib_search_path (if any). */
319 if (found_file
< 0 && solib_search_path
!= NULL
)
320 found_file
= openp (solib_search_path
, OPF_TRY_CWD_FIRST
,
321 in_pathname
, O_RDONLY
| O_BINARY
, &temp_pathname
);
323 /* If not found, next search the solib_search_path (if any) for the basename
324 only (ignoring the path). This is to allow reading solibs from a path
325 that differs from the opened path. */
326 if (found_file
< 0 && solib_search_path
!= NULL
)
327 found_file
= openp (solib_search_path
, OPF_TRY_CWD_FIRST
,
328 target_lbasename (fskind
, in_pathname
),
329 O_RDONLY
| O_BINARY
, &temp_pathname
);
331 /* If not found, try to use target supplied solib search method. */
332 if (found_file
< 0 && ops
->find_and_open_solib
)
333 found_file
= ops
->find_and_open_solib (in_pathname
, O_RDONLY
| O_BINARY
,
336 /* If not found, next search the inferior's $PATH environment variable. */
337 if (found_file
< 0 && gdb_sysroot_is_empty
)
338 found_file
= openp (get_in_environ (current_inferior ()->environment
,
340 OPF_TRY_CWD_FIRST
, in_pathname
, O_RDONLY
| O_BINARY
,
343 /* If not found, next search the inferior's $LD_LIBRARY_PATH
344 environment variable. */
345 if (found_file
< 0 && gdb_sysroot_is_empty
)
346 found_file
= openp (get_in_environ (current_inferior ()->environment
,
348 OPF_TRY_CWD_FIRST
, in_pathname
, O_RDONLY
| O_BINARY
,
352 return temp_pathname
;
355 /* Open and return a BFD for the shared library PATHNAME. If FD is not -1,
356 it is used as file handle to open the file. Throws an error if the file
357 could not be opened. Handles both local and remote file access.
359 PATHNAME must be malloc'ed by the caller. It will be freed by this
360 function. If unsuccessful, the FD will be closed (unless FD was
364 solib_bfd_fopen (char *pathname
, int fd
)
368 if (remote_filename_p (pathname
))
370 gdb_assert (fd
== -1);
371 abfd
= remote_bfd_open (pathname
, gnutarget
);
375 abfd
= gdb_bfd_open (pathname
, gnutarget
, fd
);
378 bfd_set_cacheable (abfd
, 1);
383 make_cleanup (xfree
, pathname
);
384 error (_("Could not open `%s' as an executable file: %s"),
385 pathname
, bfd_errmsg (bfd_get_error ()));
393 /* Find shared library PATHNAME and open a BFD for it. */
396 solib_bfd_open (char *pathname
)
398 char *found_pathname
;
401 const struct bfd_arch_info
*b
;
403 /* Search for shared library file. */
404 found_pathname
= solib_find (pathname
, &found_file
);
405 if (found_pathname
== NULL
)
407 /* Return failure if the file could not be found, so that we can
408 accumulate messages about missing libraries. */
412 perror_with_name (pathname
);
415 /* Open bfd for shared library. */
416 abfd
= solib_bfd_fopen (found_pathname
, found_file
);
418 /* Check bfd format. */
419 if (!bfd_check_format (abfd
, bfd_object
))
421 make_cleanup_bfd_unref (abfd
);
422 error (_("`%s': not in executable format: %s"),
423 bfd_get_filename (abfd
), bfd_errmsg (bfd_get_error ()));
426 /* Check bfd arch. */
427 b
= gdbarch_bfd_arch_info (target_gdbarch ());
428 if (!b
->compatible (b
, bfd_get_arch_info (abfd
)))
429 warning (_("`%s': Shared library architecture %s is not compatible "
430 "with target architecture %s."), bfd_get_filename (abfd
),
431 bfd_get_arch_info (abfd
)->printable_name
, b
->printable_name
);
436 /* Given a pointer to one of the shared objects in our list of mapped
437 objects, use the recorded name to open a bfd descriptor for the
438 object, build a section table, relocate all the section addresses
439 by the base address at which the shared object was mapped, and then
440 add the sections to the target's section table.
442 FIXME: In most (all?) cases the shared object file name recorded in
443 the dynamic linkage tables will be a fully qualified pathname. For
444 cases where it isn't, do we really mimic the systems search
445 mechanism correctly in the below code (particularly the tilde
446 expansion stuff?). */
449 solib_map_sections (struct so_list
*so
)
451 struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
453 struct target_section
*p
;
454 struct cleanup
*old_chain
;
457 filename
= tilde_expand (so
->so_name
);
458 old_chain
= make_cleanup (xfree
, filename
);
459 abfd
= ops
->bfd_open (filename
);
460 do_cleanups (old_chain
);
465 /* Leave bfd open, core_xfer_memory and "info files" need it. */
468 if (build_section_table (abfd
, &so
->sections
, &so
->sections_end
))
470 error (_("Can't find the file sections in `%s': %s"),
471 bfd_get_filename (abfd
), bfd_errmsg (bfd_get_error ()));
474 for (p
= so
->sections
; p
< so
->sections_end
; p
++)
476 /* Relocate the section binding addresses as recorded in the shared
477 object's file by the base address to which the object was actually
479 ops
->relocate_section_addresses (so
, p
);
481 /* If the target didn't provide information about the address
482 range of the shared object, assume we want the location of
483 the .text section. */
484 if (so
->addr_low
== 0 && so
->addr_high
== 0
485 && strcmp (p
->the_bfd_section
->name
, ".text") == 0)
487 so
->addr_low
= p
->addr
;
488 so
->addr_high
= p
->endaddr
;
492 /* Add the shared object's sections to the current set of file
493 section tables. Do this immediately after mapping the object so
494 that later nodes in the list can query this object, as is needed
496 add_target_sections (so
, so
->sections
, so
->sections_end
);
501 /* Free symbol-file related contents of SO. If we have opened a BFD
502 for SO, close it. If we have placed SO's sections in some target's
503 section table, the caller is responsible for removing them.
505 This function doesn't mess with objfiles at all. If there is an
506 objfile associated with SO that needs to be removed, the caller is
507 responsible for taking care of that. */
510 free_so_symbols (struct so_list
*so
)
514 xfree (so
->sections
);
515 so
->sections
= so
->sections_end
= NULL
;
518 gdb_bfd_unref (so
->abfd
);
521 /* Our caller closed the objfile, possibly via objfile_purge_solibs. */
522 so
->symbols_loaded
= 0;
525 so
->addr_low
= so
->addr_high
= 0;
527 /* Restore the target-supplied file name. SO_NAME may be the path
528 of the symbol file. */
529 strcpy (so
->so_name
, so
->so_original_name
);
532 /* Free the storage associated with the `struct so_list' object SO.
533 If we have opened a BFD for SO, close it.
535 The caller is responsible for removing SO from whatever list it is
536 a member of. If we have placed SO's sections in some target's
537 section table, the caller is responsible for removing them.
539 This function doesn't mess with objfiles at all. If there is an
540 objfile associated with SO that needs to be removed, the caller is
541 responsible for taking care of that. */
544 free_so (struct so_list
*so
)
546 struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
548 free_so_symbols (so
);
555 /* Return address of first so_list entry in master shared object list. */
557 master_so_list (void)
562 /* Read in symbols for shared object SO. If SYMFILE_VERBOSE is set in FLAGS,
563 be chatty about it. Return non-zero if any symbols were actually
567 solib_read_symbols (struct so_list
*so
, int flags
)
569 const int from_tty
= flags
& SYMFILE_VERBOSE
;
571 if (so
->symbols_loaded
)
573 /* If needed, we've already warned in our caller. */
575 else if (so
->abfd
== NULL
)
577 /* We've already warned about this library, when trying to open
582 volatile struct gdb_exception e
;
584 flags
|= current_inferior ()->symfile_flags
;
586 TRY_CATCH (e
, RETURN_MASK_ERROR
)
588 struct section_addr_info
*sap
;
590 /* Have we already loaded this shared object? */
591 ALL_OBJFILES (so
->objfile
)
593 if (filename_cmp (so
->objfile
->name
, so
->so_name
) == 0
594 && so
->objfile
->addr_low
== so
->addr_low
)
597 if (so
->objfile
!= NULL
)
600 sap
= build_section_addr_info_from_section_table (so
->sections
,
602 so
->objfile
= symbol_file_add_from_bfd (so
->abfd
,
603 flags
, sap
, OBJF_SHARED
,
605 so
->objfile
->addr_low
= so
->addr_low
;
606 free_section_addr_info (sap
);
610 exception_fprintf (gdb_stderr
, e
, _("Error while reading shared"
611 " library symbols for %s:\n"),
615 if (from_tty
|| info_verbose
)
616 printf_unfiltered (_("Loaded symbols for %s\n"), so
->so_name
);
617 so
->symbols_loaded
= 1;
625 /* Return 1 if KNOWN->objfile is used by any other so_list object in the
626 SO_LIST_HEAD list. Return 0 otherwise. */
629 solib_used (const struct so_list
*const known
)
631 const struct so_list
*pivot
;
633 for (pivot
= so_list_head
; pivot
!= NULL
; pivot
= pivot
->next
)
634 if (pivot
!= known
&& pivot
->objfile
== known
->objfile
)
639 /* Synchronize GDB's shared object list with inferior's.
641 Extract the list of currently loaded shared objects from the
642 inferior, and compare it with the list of shared objects currently
643 in GDB's so_list_head list. Edit so_list_head to bring it in sync
644 with the inferior's new list.
646 If we notice that the inferior has unloaded some shared objects,
647 free any symbolic info GDB had read about those shared objects.
649 Don't load symbolic info for any new shared objects; just add them
650 to the list, and leave their symbols_loaded flag clear.
652 If FROM_TTY is non-null, feel free to print messages about what
655 If TARGET is non-null, add the sections of all new shared objects
656 to TARGET's section table. Note that this doesn't remove any
657 sections for shared objects that have been unloaded, and it
658 doesn't check to see if the new shared objects are already present in
659 the section table. But we only use this for core files and
660 processes we've just attached to, so that's okay. */
663 update_solib_list (int from_tty
, struct target_ops
*target
)
665 struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
666 struct so_list
*inferior
= ops
->current_sos();
667 struct so_list
*gdb
, **gdb_link
;
669 /* We can reach here due to changing solib-search-path or the
670 sysroot, before having any inferior. */
671 if (target_has_execution
&& !ptid_equal (inferior_ptid
, null_ptid
))
673 struct inferior
*inf
= current_inferior ();
675 /* If we are attaching to a running process for which we
676 have not opened a symbol file, we may be able to get its
678 if (inf
->attach_flag
&& symfile_objfile
== NULL
)
679 catch_errors (ops
->open_symbol_file_object
, &from_tty
,
680 "Error reading attached process's symbol file.\n",
684 /* GDB and the inferior's dynamic linker each maintain their own
685 list of currently loaded shared objects; we want to bring the
686 former in sync with the latter. Scan both lists, seeing which
687 shared objects appear where. There are three cases:
689 - A shared object appears on both lists. This means that GDB
690 knows about it already, and it's still loaded in the inferior.
691 Nothing needs to happen.
693 - A shared object appears only on GDB's list. This means that
694 the inferior has unloaded it. We should remove the shared
695 object from GDB's tables.
697 - A shared object appears only on the inferior's list. This
698 means that it's just been loaded. We should add it to GDB's
701 So we walk GDB's list, checking each entry to see if it appears
702 in the inferior's list too. If it does, no action is needed, and
703 we remove it from the inferior's list. If it doesn't, the
704 inferior has unloaded it, and we remove it from GDB's list. By
705 the time we're done walking GDB's list, the inferior's list
706 contains only the new shared objects, which we then add. */
709 gdb_link
= &so_list_head
;
712 struct so_list
*i
= inferior
;
713 struct so_list
**i_link
= &inferior
;
715 /* Check to see whether the shared object *gdb also appears in
716 the inferior's current list. */
721 if (ops
->same (gdb
, i
))
726 if (! filename_cmp (gdb
->so_original_name
, i
->so_original_name
))
734 /* If the shared object appears on the inferior's list too, then
735 it's still loaded, so we don't need to do anything. Delete
736 it from the inferior's list, and leave it on GDB's list. */
741 gdb_link
= &gdb
->next
;
745 /* If it's not on the inferior's list, remove it from GDB's tables. */
748 /* Notify any observer that the shared object has been
749 unloaded before we remove it from GDB's tables. */
750 observer_notify_solib_unloaded (gdb
);
752 VEC_safe_push (char_ptr
, current_program_space
->deleted_solibs
,
753 xstrdup (gdb
->so_name
));
755 *gdb_link
= gdb
->next
;
757 /* Unless the user loaded it explicitly, free SO's objfile. */
758 if (gdb
->objfile
&& ! (gdb
->objfile
->flags
& OBJF_USERLOADED
)
759 && !solib_used (gdb
))
760 free_objfile (gdb
->objfile
);
762 /* Some targets' section tables might be referring to
763 sections from so->abfd; remove them. */
764 remove_target_sections (gdb
, gdb
->abfd
);
771 /* Now the inferior's list contains only shared objects that don't
772 appear in GDB's list --- those that are newly loaded. Add them
773 to GDB's shared object list. */
777 const char *not_found_filename
= NULL
;
781 /* Add the new shared objects to GDB's list. */
782 *gdb_link
= inferior
;
784 /* Fill in the rest of each of the `struct so_list' nodes. */
785 for (i
= inferior
; i
; i
= i
->next
)
787 volatile struct gdb_exception e
;
789 i
->pspace
= current_program_space
;
790 VEC_safe_push (so_list_ptr
, current_program_space
->added_solibs
, i
);
792 TRY_CATCH (e
, RETURN_MASK_ERROR
)
794 /* Fill in the rest of the `struct so_list' node. */
795 if (!solib_map_sections (i
))
798 if (not_found_filename
== NULL
)
799 not_found_filename
= i
->so_original_name
;
804 exception_fprintf (gdb_stderr
, e
,
805 _("Error while mapping shared "
806 "library sections:\n"));
808 /* Notify any observer that the shared object has been
809 loaded now that we've added it to GDB's tables. */
810 observer_notify_solib_loaded (i
);
813 /* If a library was not found, issue an appropriate warning
814 message. We have to use a single call to warning in case the
815 front end does something special with warnings, e.g., pop up
816 a dialog box. It Would Be Nice if we could get a "warning: "
817 prefix on each line in the CLI front end, though - it doesn't
821 warning (_("Could not load shared library symbols for %s.\n"
822 "Do you need \"set solib-search-path\" "
823 "or \"set sysroot\"?"),
825 else if (not_found
> 1)
827 Could not load shared library symbols for %d libraries, e.g. %s.\n\
828 Use the \"info sharedlibrary\" command to see the complete listing.\n\
829 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
830 not_found
, not_found_filename
);
835 /* Return non-zero if NAME is the libpthread shared library.
837 Uses a fairly simplistic heuristic approach where we check
838 the file name against "/libpthread". This can lead to false
839 positives, but this should be good enough in practice. */
842 libpthread_name_p (const char *name
)
844 return (strstr (name
, "/libpthread") != NULL
);
847 /* Return non-zero if SO is the libpthread shared library. */
850 libpthread_solib_p (struct so_list
*so
)
852 return libpthread_name_p (so
->so_name
);
855 /* Read in symbolic information for any shared objects whose names
856 match PATTERN. (If we've already read a shared object's symbol
857 info, leave it alone.) If PATTERN is zero, read them all.
859 If READSYMS is 0, defer reading symbolic information until later
860 but still do any needed low level processing.
862 FROM_TTY and TARGET are as described for update_solib_list, above. */
865 solib_add (char *pattern
, int from_tty
,
866 struct target_ops
*target
, int readsyms
)
870 current_program_space
->solib_add_generation
++;
874 char *re_err
= re_comp (pattern
);
877 error (_("Invalid regexp: %s"), re_err
);
880 update_solib_list (from_tty
, target
);
882 /* Walk the list of currently loaded shared libraries, and read
883 symbols for any that match the pattern --- or any whose symbols
884 aren't already loaded, if no pattern was given. */
887 int loaded_any_symbols
= 0;
889 SYMFILE_DEFER_BP_RESET
| (from_tty
? SYMFILE_VERBOSE
: 0);
891 for (gdb
= so_list_head
; gdb
; gdb
= gdb
->next
)
892 if (! pattern
|| re_exec (gdb
->so_name
))
894 /* Normally, we would read the symbols from that library
895 only if READSYMS is set. However, we're making a small
896 exception for the pthread library, because we sometimes
897 need the library symbols to be loaded in order to provide
898 thread support (x86-linux for instance). */
899 const int add_this_solib
=
900 (readsyms
|| libpthread_solib_p (gdb
));
905 if (gdb
->symbols_loaded
)
907 /* If no pattern was given, be quiet for shared
908 libraries we have already loaded. */
909 if (pattern
&& (from_tty
|| info_verbose
))
910 printf_unfiltered (_("Symbols already loaded for %s\n"),
913 else if (solib_read_symbols (gdb
, flags
))
914 loaded_any_symbols
= 1;
918 if (loaded_any_symbols
)
919 breakpoint_re_set ();
921 if (from_tty
&& pattern
&& ! any_matches
)
923 ("No loaded shared libraries match the pattern `%s'.\n", pattern
);
925 if (loaded_any_symbols
)
927 struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
929 /* Getting new symbols may change our opinion about what is
931 reinit_frame_cache ();
933 ops
->special_symbol_handling ();
938 /* Implement the "info sharedlibrary" command. Walk through the
939 shared library list and print information about each attached
940 library matching PATTERN. If PATTERN is elided, print them
944 info_sharedlibrary_command (char *pattern
, int from_tty
)
946 struct so_list
*so
= NULL
; /* link map state variable */
947 int so_missing_debug_info
= 0;
950 struct cleanup
*table_cleanup
;
951 struct gdbarch
*gdbarch
= target_gdbarch ();
952 struct ui_out
*uiout
= current_uiout
;
956 char *re_err
= re_comp (pattern
);
959 error (_("Invalid regexp: %s"), re_err
);
962 /* "0x", a little whitespace, and two hex digits per byte of pointers. */
963 addr_width
= 4 + (gdbarch_ptr_bit (gdbarch
) / 4);
965 update_solib_list (from_tty
, 0);
967 /* make_cleanup_ui_out_table_begin_end needs to know the number of
968 rows, so we need to make two passes over the libs. */
970 for (nr_libs
= 0, so
= so_list_head
; so
; so
= so
->next
)
974 if (pattern
&& ! re_exec (so
->so_name
))
981 make_cleanup_ui_out_table_begin_end (uiout
, 4, nr_libs
,
982 "SharedLibraryTable");
984 /* The "- 1" is because ui_out adds one space between columns. */
985 ui_out_table_header (uiout
, addr_width
- 1, ui_left
, "from", "From");
986 ui_out_table_header (uiout
, addr_width
- 1, ui_left
, "to", "To");
987 ui_out_table_header (uiout
, 12 - 1, ui_left
, "syms-read", "Syms Read");
988 ui_out_table_header (uiout
, 0, ui_noalign
,
989 "name", "Shared Object Library");
991 ui_out_table_body (uiout
);
993 for (so
= so_list_head
; so
; so
= so
->next
)
995 struct cleanup
*lib_cleanup
;
997 if (! so
->so_name
[0])
999 if (pattern
&& ! re_exec (so
->so_name
))
1002 lib_cleanup
= make_cleanup_ui_out_tuple_begin_end (uiout
, "lib");
1004 if (so
->addr_high
!= 0)
1006 ui_out_field_core_addr (uiout
, "from", gdbarch
, so
->addr_low
);
1007 ui_out_field_core_addr (uiout
, "to", gdbarch
, so
->addr_high
);
1011 ui_out_field_skip (uiout
, "from");
1012 ui_out_field_skip (uiout
, "to");
1015 if (! ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ()))
1016 && so
->symbols_loaded
1017 && !objfile_has_symbols (so
->objfile
))
1019 so_missing_debug_info
= 1;
1020 ui_out_field_string (uiout
, "syms-read", "Yes (*)");
1023 ui_out_field_string (uiout
, "syms-read",
1024 so
->symbols_loaded
? "Yes" : "No");
1026 ui_out_field_string (uiout
, "name", so
->so_name
);
1028 ui_out_text (uiout
, "\n");
1030 do_cleanups (lib_cleanup
);
1033 do_cleanups (table_cleanup
);
1038 ui_out_message (uiout
, 0,
1039 _("No shared libraries matched.\n"));
1041 ui_out_message (uiout
, 0,
1042 _("No shared libraries loaded at this time.\n"));
1046 if (so_missing_debug_info
)
1047 ui_out_message (uiout
, 0,
1048 _("(*): Shared library is missing "
1049 "debugging information.\n"));
1053 /* Return 1 if ADDRESS lies within SOLIB. */
1056 solib_contains_address_p (const struct so_list
*const solib
,
1059 struct target_section
*p
;
1061 for (p
= solib
->sections
; p
< solib
->sections_end
; p
++)
1062 if (p
->addr
<= address
&& address
< p
->endaddr
)
1068 /* If ADDRESS is in a shared lib in program space PSPACE, return its
1071 Provides a hook for other gdb routines to discover whether or not a
1072 particular address is within the mapped address space of a shared
1075 For example, this routine is called at one point to disable
1076 breakpoints which are in shared libraries that are not currently
1080 solib_name_from_address (struct program_space
*pspace
, CORE_ADDR address
)
1082 struct so_list
*so
= NULL
;
1084 for (so
= pspace
->so_list
; so
; so
= so
->next
)
1085 if (solib_contains_address_p (so
, address
))
1086 return (so
->so_name
);
1091 /* Return whether the data starting at VADDR, size SIZE, must be kept
1092 in a core file for shared libraries loaded before "gcore" is used
1093 to be handled correctly when the core file is loaded. This only
1094 applies when the section would otherwise not be kept in the core
1095 file (in particular, for readonly sections). */
1098 solib_keep_data_in_core (CORE_ADDR vaddr
, unsigned long size
)
1100 struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1102 if (ops
->keep_data_in_core
)
1103 return ops
->keep_data_in_core (vaddr
, size
);
1108 /* Called by free_all_symtabs */
1113 struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1115 /* This function is expected to handle ELF shared libraries. It is
1116 also used on Solaris, which can run either ELF or a.out binaries
1117 (for compatibility with SunOS 4), both of which can use shared
1118 libraries. So we don't know whether we have an ELF executable or
1119 an a.out executable until the user chooses an executable file.
1121 ELF shared libraries don't get mapped into the address space
1122 until after the program starts, so we'd better not try to insert
1123 breakpoints in them immediately. We have to wait until the
1124 dynamic linker has loaded them; we'll hit a bp_shlib_event
1125 breakpoint (look for calls to create_solib_event_breakpoint) when
1128 SunOS shared libraries seem to be different --- they're present
1129 as soon as the process begins execution, so there's no need to
1130 put off inserting breakpoints. There's also nowhere to put a
1131 bp_shlib_event breakpoint, so if we put it off, we'll never get
1134 So: disable breakpoints only if we're using ELF shared libs. */
1135 if (exec_bfd
!= NULL
1136 && bfd_get_flavour (exec_bfd
) != bfd_target_aout_flavour
)
1137 disable_breakpoints_in_shlibs ();
1139 while (so_list_head
)
1141 struct so_list
*so
= so_list_head
;
1143 so_list_head
= so
->next
;
1144 observer_notify_solib_unloaded (so
);
1146 remove_target_sections (so
, so
->abfd
);
1150 ops
->clear_solib ();
1153 /* Shared library startup support. When GDB starts up the inferior,
1154 it nurses it along (through the shell) until it is ready to execute
1155 its first instruction. At this point, this function gets
1159 solib_create_inferior_hook (int from_tty
)
1161 struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1163 ops
->solib_create_inferior_hook (from_tty
);
1166 /* Check to see if an address is in the dynamic loader's dynamic
1167 symbol resolution code. Return 1 if so, 0 otherwise. */
1170 in_solib_dynsym_resolve_code (CORE_ADDR pc
)
1172 struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1174 return ops
->in_dynsym_resolve_code (pc
);
1177 /* Implements the "sharedlibrary" command. */
1180 sharedlibrary_command (char *args
, int from_tty
)
1183 solib_add (args
, from_tty
, (struct target_ops
*) 0, 1);
1186 /* Implements the command "nosharedlibrary", which discards symbols
1187 that have been auto-loaded from shared libraries. Symbols from
1188 shared libraries that were added by explicit request of the user
1189 are not discarded. Also called from remote.c. */
1192 no_shared_libraries (char *ignored
, int from_tty
)
1194 /* The order of the two routines below is important: clear_solib notifies
1195 the solib_unloaded observers, and some of these observers might need
1196 access to their associated objfiles. Therefore, we can not purge the
1197 solibs' objfiles before clear_solib has been called. */
1200 objfile_purge_solibs ();
1203 /* Reload shared libraries, but avoid reloading the same symbol file
1204 we already have loaded. */
1207 reload_shared_libraries_1 (int from_tty
)
1210 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
1212 for (so
= so_list_head
; so
!= NULL
; so
= so
->next
)
1214 char *filename
, *found_pathname
= NULL
;
1216 int was_loaded
= so
->symbols_loaded
;
1218 SYMFILE_DEFER_BP_RESET
| (from_tty
? SYMFILE_VERBOSE
: 0);
1220 filename
= tilde_expand (so
->so_original_name
);
1221 make_cleanup (xfree
, filename
);
1222 abfd
= solib_bfd_open (filename
);
1225 found_pathname
= xstrdup (bfd_get_filename (abfd
));
1226 make_cleanup (xfree
, found_pathname
);
1227 gdb_bfd_unref (abfd
);
1230 /* If this shared library is no longer associated with its previous
1231 symbol file, close that. */
1232 if ((found_pathname
== NULL
&& was_loaded
)
1233 || (found_pathname
!= NULL
1234 && filename_cmp (found_pathname
, so
->so_name
) != 0))
1236 if (so
->objfile
&& ! (so
->objfile
->flags
& OBJF_USERLOADED
)
1237 && !solib_used (so
))
1238 free_objfile (so
->objfile
);
1239 remove_target_sections (so
, so
->abfd
);
1240 free_so_symbols (so
);
1243 /* If this shared library is now associated with a new symbol
1245 if (found_pathname
!= NULL
1247 || filename_cmp (found_pathname
, so
->so_name
) != 0))
1249 volatile struct gdb_exception e
;
1251 TRY_CATCH (e
, RETURN_MASK_ERROR
)
1252 solib_map_sections (so
);
1255 exception_fprintf (gdb_stderr
, e
,
1256 _("Error while mapping "
1257 "shared library sections:\n"));
1258 else if (auto_solib_add
|| was_loaded
|| libpthread_solib_p (so
))
1259 solib_read_symbols (so
, flags
);
1263 do_cleanups (old_chain
);
1267 reload_shared_libraries (char *ignored
, int from_tty
,
1268 struct cmd_list_element
*e
)
1270 struct target_so_ops
*ops
;
1272 reload_shared_libraries_1 (from_tty
);
1274 ops
= solib_ops (target_gdbarch ());
1276 /* Creating inferior hooks here has two purposes. First, if we reload
1277 shared libraries then the address of solib breakpoint we've computed
1278 previously might be no longer valid. For example, if we forgot to set
1279 solib-absolute-prefix and are setting it right now, then the previous
1280 breakpoint address is plain wrong. Second, installing solib hooks
1281 also implicitly figures were ld.so is and loads symbols for it.
1282 Absent this call, if we've just connected to a target and set
1283 solib-absolute-prefix or solib-search-path, we'll lose all information
1285 if (target_has_execution
)
1287 /* Reset or free private data structures not associated with
1289 ops
->clear_solib ();
1291 /* Remove any previous solib event breakpoint. This is usually
1292 done in common code, at breakpoint_init_inferior time, but
1293 we're not really starting up the inferior here. */
1294 remove_solib_event_breakpoints ();
1296 #ifdef SOLIB_CREATE_INFERIOR_HOOK
1297 SOLIB_CREATE_INFERIOR_HOOK (PIDGET (inferior_ptid
));
1299 solib_create_inferior_hook (from_tty
);
1303 /* Sometimes the platform-specific hook loads initial shared
1304 libraries, and sometimes it doesn't. If it doesn't FROM_TTY will be
1305 incorrectly 0 but such solib targets should be fixed anyway. If we
1306 made all the inferior hook methods consistent, this call could be
1307 removed. Call it only after the solib target has been initialized by
1308 solib_create_inferior_hook. */
1310 solib_add (NULL
, 0, NULL
, auto_solib_add
);
1312 breakpoint_re_set ();
1314 /* We may have loaded or unloaded debug info for some (or all)
1315 shared libraries. However, frames may still reference them. For
1316 example, a frame's unwinder might still point at DWARF FDE
1317 structures that are now freed. Also, getting new symbols may
1318 change our opinion about what is frameless. */
1319 reinit_frame_cache ();
1321 ops
->special_symbol_handling ();
1325 show_auto_solib_add (struct ui_file
*file
, int from_tty
,
1326 struct cmd_list_element
*c
, const char *value
)
1328 fprintf_filtered (file
, _("Autoloading of shared library symbols is %s.\n"),
1333 /* Handler for library-specific lookup of global symbol NAME in OBJFILE. Call
1334 the library-specific handler if it is installed for the current target. */
1337 solib_global_lookup (const struct objfile
*objfile
,
1339 const domain_enum domain
)
1341 struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1343 if (ops
->lookup_lib_global_symbol
!= NULL
)
1344 return ops
->lookup_lib_global_symbol (objfile
, name
, domain
);
1348 /* Lookup the value for a specific symbol from dynamic symbol table. Look
1349 up symbol from ABFD. MATCH_SYM is a callback function to determine
1350 whether to pick up a symbol. DATA is the input of this callback
1351 function. Return NULL if symbol is not found. */
1354 gdb_bfd_lookup_symbol_from_symtab (bfd
*abfd
,
1355 int (*match_sym
) (asymbol
*, void *),
1358 long storage_needed
= bfd_get_symtab_upper_bound (abfd
);
1359 CORE_ADDR symaddr
= 0;
1361 if (storage_needed
> 0)
1365 asymbol
**symbol_table
= (asymbol
**) xmalloc (storage_needed
);
1366 struct cleanup
*back_to
= make_cleanup (xfree
, symbol_table
);
1367 unsigned int number_of_symbols
=
1368 bfd_canonicalize_symtab (abfd
, symbol_table
);
1370 for (i
= 0; i
< number_of_symbols
; i
++)
1372 asymbol
*sym
= *symbol_table
++;
1374 if (match_sym (sym
, data
))
1376 /* BFD symbols are section relative. */
1377 symaddr
= sym
->value
+ sym
->section
->vma
;
1381 do_cleanups (back_to
);
1387 /* Lookup the value for a specific symbol from symbol table. Look up symbol
1388 from ABFD. MATCH_SYM is a callback function to determine whether to pick
1389 up a symbol. DATA is the input of this callback function. Return NULL
1390 if symbol is not found. */
1393 bfd_lookup_symbol_from_dyn_symtab (bfd
*abfd
,
1394 int (*match_sym
) (asymbol
*, void *),
1397 long storage_needed
= bfd_get_dynamic_symtab_upper_bound (abfd
);
1398 CORE_ADDR symaddr
= 0;
1400 if (storage_needed
> 0)
1403 asymbol
**symbol_table
= (asymbol
**) xmalloc (storage_needed
);
1404 struct cleanup
*back_to
= make_cleanup (xfree
, symbol_table
);
1405 unsigned int number_of_symbols
=
1406 bfd_canonicalize_dynamic_symtab (abfd
, symbol_table
);
1408 for (i
= 0; i
< number_of_symbols
; i
++)
1410 asymbol
*sym
= *symbol_table
++;
1412 if (match_sym (sym
, data
))
1414 /* BFD symbols are section relative. */
1415 symaddr
= sym
->value
+ sym
->section
->vma
;
1419 do_cleanups (back_to
);
1424 /* Lookup the value for a specific symbol from symbol table and dynamic
1425 symbol table. Look up symbol from ABFD. MATCH_SYM is a callback
1426 function to determine whether to pick up a symbol. DATA is the
1427 input of this callback function. Return NULL if symbol is not
1431 gdb_bfd_lookup_symbol (bfd
*abfd
,
1432 int (*match_sym
) (asymbol
*, void *),
1435 CORE_ADDR symaddr
= gdb_bfd_lookup_symbol_from_symtab (abfd
, match_sym
, data
);
1437 /* On FreeBSD, the dynamic linker is stripped by default. So we'll
1438 have to check the dynamic string table too. */
1440 symaddr
= bfd_lookup_symbol_from_dyn_symtab (abfd
, match_sym
, data
);
1445 extern initialize_file_ftype _initialize_solib
; /* -Wmissing-prototypes */
1448 _initialize_solib (void)
1450 solib_data
= gdbarch_data_register_pre_init (solib_init
);
1452 add_com ("sharedlibrary", class_files
, sharedlibrary_command
,
1453 _("Load shared object library symbols for files matching REGEXP."));
1454 add_info ("sharedlibrary", info_sharedlibrary_command
,
1455 _("Status of loaded shared object libraries."));
1456 add_com ("nosharedlibrary", class_files
, no_shared_libraries
,
1457 _("Unload all shared object library symbols."));
1459 add_setshow_boolean_cmd ("auto-solib-add", class_support
,
1460 &auto_solib_add
, _("\
1461 Set autoloading of shared library symbols."), _("\
1462 Show autoloading of shared library symbols."), _("\
1463 If \"on\", symbols from all shared object libraries will be loaded\n\
1464 automatically when the inferior begins execution, when the dynamic linker\n\
1465 informs gdb that a new library has been loaded, or when attaching to the\n\
1466 inferior. Otherwise, symbols must be loaded manually, using \
1469 show_auto_solib_add
,
1470 &setlist
, &showlist
);
1472 add_setshow_filename_cmd ("sysroot", class_support
,
1474 Set an alternate system root."), _("\
1475 Show the current system root."), _("\
1476 The system root is used to load absolute shared library symbol files.\n\
1477 For other (relative) files, you can add directories using\n\
1478 `set solib-search-path'."),
1479 reload_shared_libraries
,
1481 &setlist
, &showlist
);
1483 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support
, 0,
1485 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support
, 0,
1488 add_setshow_optional_filename_cmd ("solib-search-path", class_support
,
1489 &solib_search_path
, _("\
1490 Set the search path for loading non-absolute shared library symbol files."),
1492 Show the search path for loading non-absolute shared library symbol files."),
1494 This takes precedence over the environment variables \
1495 PATH and LD_LIBRARY_PATH."),
1496 reload_shared_libraries
,
1497 show_solib_search_path
,
1498 &setlist
, &showlist
);