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"
50 #include "filestuff.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 const struct target_so_ops
*
68 solib_ops (struct gdbarch
*gdbarch
)
70 const 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
, const struct target_so_ops
*new_ops
)
80 const 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
117 /* Returns the full pathname of the shared library file, or NULL if
118 not found. (The pathname is malloc'ed; it needs to be freed by the
119 caller.) *FD is set to either -1 or an open file handle for the
122 Global variable GDB_SYSROOT is used as a prefix directory
123 to search for shared libraries if they have an absolute path.
125 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
126 (or set of directories, as in LD_LIBRARY_PATH) to search for all
127 shared libraries if not found in GDB_SYSROOT.
130 * If there is a gdb_sysroot and path is absolute:
131 * Search for gdb_sysroot/path.
133 * Look for it literally (unmodified).
134 * Look in SOLIB_SEARCH_PATH.
135 * If available, use target defined search function.
136 * If gdb_sysroot is NOT set, perform the following two searches:
137 * Look in inferior's $PATH.
138 * Look in inferior's $LD_LIBRARY_PATH.
140 * The last check avoids doing this search when targetting remote
141 * machines since gdb_sysroot will almost always be set.
145 solib_find (char *in_pathname
, int *fd
)
147 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
149 char *temp_pathname
= NULL
;
150 int gdb_sysroot_is_empty
;
151 const char *solib_symbols_extension
152 = gdbarch_solib_symbols_extension (target_gdbarch ());
153 const char *fskind
= effective_target_file_system_kind ();
154 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
155 char *sysroot
= NULL
;
157 /* If solib_symbols_extension is set, replace the file's
159 if (solib_symbols_extension
)
161 char *p
= in_pathname
+ strlen (in_pathname
);
163 while (p
> in_pathname
&& *p
!= '.')
170 new_pathname
= alloca (p
- in_pathname
+ 1
171 + strlen (solib_symbols_extension
) + 1);
172 memcpy (new_pathname
, in_pathname
, p
- in_pathname
+ 1);
173 strcpy (new_pathname
+ (p
- in_pathname
) + 1,
174 solib_symbols_extension
);
176 in_pathname
= new_pathname
;
180 gdb_sysroot_is_empty
= (gdb_sysroot
== NULL
|| *gdb_sysroot
== 0);
182 if (!gdb_sysroot_is_empty
)
184 int prefix_len
= strlen (gdb_sysroot
);
186 /* Remove trailing slashes from absolute prefix. */
187 while (prefix_len
> 0
188 && IS_DIR_SEPARATOR (gdb_sysroot
[prefix_len
- 1]))
191 sysroot
= savestring (gdb_sysroot
, prefix_len
);
192 make_cleanup (xfree
, sysroot
);
195 /* If we're on a non-DOS-based system, backslashes won't be
196 understood as directory separator, so, convert them to forward
197 slashes, iff we're supposed to handle DOS-based file system
198 semantics for target paths. */
199 if (!DOS_BASED_FILE_SYSTEM
&& fskind
== file_system_kind_dos_based
)
203 /* Avoid clobbering our input. */
204 p
= alloca (strlen (in_pathname
) + 1);
205 strcpy (p
, in_pathname
);
215 /* Note, we're interested in IS_TARGET_ABSOLUTE_PATH, not
216 IS_ABSOLUTE_PATH. The latter is for host paths only, while
217 IN_PATHNAME is a target path. For example, if we're supposed to
218 be handling DOS-like semantics we want to consider a
219 'c:/foo/bar.dll' path as an absolute path, even on a Unix box.
220 With such a path, before giving up on the sysroot, we'll try:
222 1st attempt, c:/foo/bar.dll ==> /sysroot/c:/foo/bar.dll
223 2nd attempt, c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll
224 3rd attempt, c:/foo/bar.dll ==> /sysroot/foo/bar.dll
227 if (!IS_TARGET_ABSOLUTE_PATH (fskind
, in_pathname
) || gdb_sysroot_is_empty
)
228 temp_pathname
= xstrdup (in_pathname
);
231 int need_dir_separator
;
233 /* Concatenate the sysroot and the target reported filename. We
234 may need to glue them with a directory separator. Cases to
237 | sysroot | separator | in_pathname |
238 |-----------------+-----------+----------------|
239 | /some/dir | / | c:/foo/bar.dll |
240 | /some/dir | | /foo/bar.dll |
241 | remote: | | c:/foo/bar.dll |
242 | remote: | | /foo/bar.dll |
243 | remote:some/dir | / | c:/foo/bar.dll |
244 | remote:some/dir | | /foo/bar.dll |
246 IOW, we don't need to add a separator if IN_PATHNAME already
247 has one, or when the the sysroot is exactly "remote:".
248 There's no need to check for drive spec explicitly, as we only
249 get here if IN_PATHNAME is considered an absolute path. */
250 need_dir_separator
= !(IS_DIR_SEPARATOR (in_pathname
[0])
251 || strcmp (REMOTE_SYSROOT_PREFIX
, sysroot
) == 0);
253 /* Cat the prefixed pathname together. */
254 temp_pathname
= concat (sysroot
,
255 need_dir_separator
? SLASH_STRING
: "",
256 in_pathname
, (char *) NULL
);
259 /* Handle remote files. */
260 if (remote_filename_p (temp_pathname
))
263 do_cleanups (old_chain
);
264 return temp_pathname
;
267 /* Now see if we can open it. */
268 found_file
= gdb_open_cloexec (temp_pathname
, O_RDONLY
| O_BINARY
, 0);
270 xfree (temp_pathname
);
272 /* If the search in gdb_sysroot failed, and the path name has a
273 drive spec (e.g, c:/foo), try stripping ':' from the drive spec,
274 and retrying in the sysroot:
275 c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll. */
278 && !gdb_sysroot_is_empty
279 && HAS_TARGET_DRIVE_SPEC (fskind
, in_pathname
))
281 int need_dir_separator
= !IS_DIR_SEPARATOR (in_pathname
[2]);
282 char *drive
= savestring (in_pathname
, 1);
284 temp_pathname
= concat (sysroot
,
287 need_dir_separator
? SLASH_STRING
: "",
288 in_pathname
+ 2, (char *) NULL
);
291 found_file
= gdb_open_cloexec (temp_pathname
, O_RDONLY
| O_BINARY
, 0);
294 xfree (temp_pathname
);
296 /* If the search in gdb_sysroot still failed, try fully
297 stripping the drive spec, and trying once more in the
298 sysroot before giving up.
300 c:/foo/bar.dll ==> /sysroot/foo/bar.dll. */
302 temp_pathname
= concat (sysroot
,
303 need_dir_separator
? SLASH_STRING
: "",
304 in_pathname
+ 2, (char *) NULL
);
306 found_file
= gdb_open_cloexec (temp_pathname
, O_RDONLY
| O_BINARY
, 0);
308 xfree (temp_pathname
);
312 do_cleanups (old_chain
);
314 /* We try to find the library in various ways. After each attempt,
315 either found_file >= 0 and temp_pathname is a malloc'd string, or
316 found_file < 0 and temp_pathname does not point to storage that
317 needs to be freed. */
320 temp_pathname
= NULL
;
322 /* If the search in gdb_sysroot failed, and the path name is
323 absolute at this point, make it relative. (openp will try and open the
324 file according to its absolute path otherwise, which is not what we want.)
325 Affects subsequent searches for this solib. */
326 if (found_file
< 0 && IS_TARGET_ABSOLUTE_PATH (fskind
, in_pathname
))
328 /* First, get rid of any drive letters etc. */
329 while (!IS_TARGET_DIR_SEPARATOR (fskind
, *in_pathname
))
332 /* Next, get rid of all leading dir separators. */
333 while (IS_TARGET_DIR_SEPARATOR (fskind
, *in_pathname
))
337 /* If not found, search the solib_search_path (if any). */
338 if (found_file
< 0 && solib_search_path
!= NULL
)
339 found_file
= openp (solib_search_path
,
340 OPF_TRY_CWD_FIRST
| OPF_RETURN_REALPATH
,
341 in_pathname
, O_RDONLY
| O_BINARY
, &temp_pathname
);
343 /* If not found, next search the solib_search_path (if any) for the basename
344 only (ignoring the path). This is to allow reading solibs from a path
345 that differs from the opened path. */
346 if (found_file
< 0 && solib_search_path
!= NULL
)
347 found_file
= openp (solib_search_path
,
348 OPF_TRY_CWD_FIRST
| OPF_RETURN_REALPATH
,
349 target_lbasename (fskind
, in_pathname
),
350 O_RDONLY
| O_BINARY
, &temp_pathname
);
352 /* If not found, try to use target supplied solib search method. */
353 if (found_file
< 0 && ops
->find_and_open_solib
)
354 found_file
= ops
->find_and_open_solib (in_pathname
, O_RDONLY
| O_BINARY
,
357 /* If not found, next search the inferior's $PATH environment variable. */
358 if (found_file
< 0 && gdb_sysroot_is_empty
)
359 found_file
= openp (get_in_environ (current_inferior ()->environment
,
361 OPF_TRY_CWD_FIRST
| OPF_RETURN_REALPATH
, in_pathname
,
362 O_RDONLY
| O_BINARY
, &temp_pathname
);
364 /* If not found, next search the inferior's $LD_LIBRARY_PATH
365 environment variable. */
366 if (found_file
< 0 && gdb_sysroot_is_empty
)
367 found_file
= openp (get_in_environ (current_inferior ()->environment
,
369 OPF_TRY_CWD_FIRST
| OPF_RETURN_REALPATH
, in_pathname
,
370 O_RDONLY
| O_BINARY
, &temp_pathname
);
373 return temp_pathname
;
376 /* Open and return a BFD for the shared library PATHNAME. If FD is not -1,
377 it is used as file handle to open the file. Throws an error if the file
378 could not be opened. Handles both local and remote file access.
380 PATHNAME must be malloc'ed by the caller. It will be freed by this
381 function. If unsuccessful, the FD will be closed (unless FD was
385 solib_bfd_fopen (char *pathname
, int fd
)
389 if (remote_filename_p (pathname
))
391 gdb_assert (fd
== -1);
392 abfd
= remote_bfd_open (pathname
, gnutarget
);
396 abfd
= gdb_bfd_open (pathname
, gnutarget
, fd
);
399 bfd_set_cacheable (abfd
, 1);
404 make_cleanup (xfree
, pathname
);
405 error (_("Could not open `%s' as an executable file: %s"),
406 pathname
, bfd_errmsg (bfd_get_error ()));
414 /* Find shared library PATHNAME and open a BFD for it. */
417 solib_bfd_open (char *pathname
)
419 char *found_pathname
;
422 const struct bfd_arch_info
*b
;
424 /* Search for shared library file. */
425 found_pathname
= solib_find (pathname
, &found_file
);
426 if (found_pathname
== NULL
)
428 /* Return failure if the file could not be found, so that we can
429 accumulate messages about missing libraries. */
433 perror_with_name (pathname
);
436 /* Open bfd for shared library. */
437 abfd
= solib_bfd_fopen (found_pathname
, found_file
);
439 /* Check bfd format. */
440 if (!bfd_check_format (abfd
, bfd_object
))
442 make_cleanup_bfd_unref (abfd
);
443 error (_("`%s': not in executable format: %s"),
444 bfd_get_filename (abfd
), bfd_errmsg (bfd_get_error ()));
447 /* Check bfd arch. */
448 b
= gdbarch_bfd_arch_info (target_gdbarch ());
449 if (!b
->compatible (b
, bfd_get_arch_info (abfd
)))
450 warning (_("`%s': Shared library architecture %s is not compatible "
451 "with target architecture %s."), bfd_get_filename (abfd
),
452 bfd_get_arch_info (abfd
)->printable_name
, b
->printable_name
);
457 /* Given a pointer to one of the shared objects in our list of mapped
458 objects, use the recorded name to open a bfd descriptor for the
459 object, build a section table, relocate all the section addresses
460 by the base address at which the shared object was mapped, and then
461 add the sections to the target's section table.
463 FIXME: In most (all?) cases the shared object file name recorded in
464 the dynamic linkage tables will be a fully qualified pathname. For
465 cases where it isn't, do we really mimic the systems search
466 mechanism correctly in the below code (particularly the tilde
467 expansion stuff?). */
470 solib_map_sections (struct so_list
*so
)
472 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
474 struct target_section
*p
;
475 struct cleanup
*old_chain
;
478 filename
= tilde_expand (so
->so_name
);
479 old_chain
= make_cleanup (xfree
, filename
);
480 abfd
= ops
->bfd_open (filename
);
481 do_cleanups (old_chain
);
486 /* Leave bfd open, core_xfer_memory and "info files" need it. */
489 if (build_section_table (abfd
, &so
->sections
, &so
->sections_end
))
491 error (_("Can't find the file sections in `%s': %s"),
492 bfd_get_filename (abfd
), bfd_errmsg (bfd_get_error ()));
495 for (p
= so
->sections
; p
< so
->sections_end
; p
++)
497 /* Relocate the section binding addresses as recorded in the shared
498 object's file by the base address to which the object was actually
500 ops
->relocate_section_addresses (so
, p
);
502 /* If the target didn't provide information about the address
503 range of the shared object, assume we want the location of
504 the .text section. */
505 if (so
->addr_low
== 0 && so
->addr_high
== 0
506 && strcmp (p
->the_bfd_section
->name
, ".text") == 0)
508 so
->addr_low
= p
->addr
;
509 so
->addr_high
= p
->endaddr
;
513 /* Add the shared object's sections to the current set of file
514 section tables. Do this immediately after mapping the object so
515 that later nodes in the list can query this object, as is needed
517 add_target_sections (so
, so
->sections
, so
->sections_end
);
522 /* Free symbol-file related contents of SO and reset for possible reloading
523 of SO. If we have opened a BFD for SO, close it. If we have placed SO's
524 sections in some target's section table, the caller is responsible for
527 This function doesn't mess with objfiles at all. If there is an
528 objfile associated with SO that needs to be removed, the caller is
529 responsible for taking care of that. */
532 clear_so (struct so_list
*so
)
534 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
538 xfree (so
->sections
);
539 so
->sections
= so
->sections_end
= NULL
;
542 gdb_bfd_unref (so
->abfd
);
545 /* Our caller closed the objfile, possibly via objfile_purge_solibs. */
546 so
->symbols_loaded
= 0;
549 so
->addr_low
= so
->addr_high
= 0;
551 /* Restore the target-supplied file name. SO_NAME may be the path
552 of the symbol file. */
553 strcpy (so
->so_name
, so
->so_original_name
);
555 /* Do the same for target-specific data. */
556 if (ops
->clear_so
!= NULL
)
560 /* Free the storage associated with the `struct so_list' object SO.
561 If we have opened a BFD for SO, close it.
563 The caller is responsible for removing SO from whatever list it is
564 a member of. If we have placed SO's sections in some target's
565 section table, the caller is responsible for removing them.
567 This function doesn't mess with objfiles at all. If there is an
568 objfile associated with SO that needs to be removed, the caller is
569 responsible for taking care of that. */
572 free_so (struct so_list
*so
)
574 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
583 /* Return address of first so_list entry in master shared object list. */
585 master_so_list (void)
590 /* Read in symbols for shared object SO. If SYMFILE_VERBOSE is set in FLAGS,
591 be chatty about it. Return non-zero if any symbols were actually
595 solib_read_symbols (struct so_list
*so
, int flags
)
597 const int from_tty
= flags
& SYMFILE_VERBOSE
;
599 if (so
->symbols_loaded
)
601 /* If needed, we've already warned in our caller. */
603 else if (so
->abfd
== NULL
)
605 /* We've already warned about this library, when trying to open
610 volatile struct gdb_exception e
;
612 flags
|= current_inferior ()->symfile_flags
;
614 TRY_CATCH (e
, RETURN_MASK_ERROR
)
616 struct section_addr_info
*sap
;
618 /* Have we already loaded this shared object? */
619 ALL_OBJFILES (so
->objfile
)
621 if (filename_cmp (objfile_name (so
->objfile
), so
->so_name
) == 0
622 && so
->objfile
->addr_low
== so
->addr_low
)
625 if (so
->objfile
!= NULL
)
628 sap
= build_section_addr_info_from_section_table (so
->sections
,
630 so
->objfile
= symbol_file_add_from_bfd (so
->abfd
, so
->so_name
,
631 flags
, sap
, OBJF_SHARED
,
633 so
->objfile
->addr_low
= so
->addr_low
;
634 free_section_addr_info (sap
);
638 exception_fprintf (gdb_stderr
, e
, _("Error while reading shared"
639 " library symbols for %s:\n"),
643 if (from_tty
|| info_verbose
)
644 printf_unfiltered (_("Loaded symbols for %s\n"), so
->so_name
);
645 so
->symbols_loaded
= 1;
653 /* Return 1 if KNOWN->objfile is used by any other so_list object in the
654 SO_LIST_HEAD list. Return 0 otherwise. */
657 solib_used (const struct so_list
*const known
)
659 const struct so_list
*pivot
;
661 for (pivot
= so_list_head
; pivot
!= NULL
; pivot
= pivot
->next
)
662 if (pivot
!= known
&& pivot
->objfile
== known
->objfile
)
667 /* Synchronize GDB's shared object list with inferior's.
669 Extract the list of currently loaded shared objects from the
670 inferior, and compare it with the list of shared objects currently
671 in GDB's so_list_head list. Edit so_list_head to bring it in sync
672 with the inferior's new list.
674 If we notice that the inferior has unloaded some shared objects,
675 free any symbolic info GDB had read about those shared objects.
677 Don't load symbolic info for any new shared objects; just add them
678 to the list, and leave their symbols_loaded flag clear.
680 If FROM_TTY is non-null, feel free to print messages about what
683 If TARGET is non-null, add the sections of all new shared objects
684 to TARGET's section table. Note that this doesn't remove any
685 sections for shared objects that have been unloaded, and it
686 doesn't check to see if the new shared objects are already present in
687 the section table. But we only use this for core files and
688 processes we've just attached to, so that's okay. */
691 update_solib_list (int from_tty
, struct target_ops
*target
)
693 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
694 struct so_list
*inferior
= ops
->current_sos();
695 struct so_list
*gdb
, **gdb_link
;
697 /* We can reach here due to changing solib-search-path or the
698 sysroot, before having any inferior. */
699 if (target_has_execution
&& !ptid_equal (inferior_ptid
, null_ptid
))
701 struct inferior
*inf
= current_inferior ();
703 /* If we are attaching to a running process for which we
704 have not opened a symbol file, we may be able to get its
706 if (inf
->attach_flag
&& symfile_objfile
== NULL
)
707 catch_errors (ops
->open_symbol_file_object
, &from_tty
,
708 "Error reading attached process's symbol file.\n",
712 /* GDB and the inferior's dynamic linker each maintain their own
713 list of currently loaded shared objects; we want to bring the
714 former in sync with the latter. Scan both lists, seeing which
715 shared objects appear where. There are three cases:
717 - A shared object appears on both lists. This means that GDB
718 knows about it already, and it's still loaded in the inferior.
719 Nothing needs to happen.
721 - A shared object appears only on GDB's list. This means that
722 the inferior has unloaded it. We should remove the shared
723 object from GDB's tables.
725 - A shared object appears only on the inferior's list. This
726 means that it's just been loaded. We should add it to GDB's
729 So we walk GDB's list, checking each entry to see if it appears
730 in the inferior's list too. If it does, no action is needed, and
731 we remove it from the inferior's list. If it doesn't, the
732 inferior has unloaded it, and we remove it from GDB's list. By
733 the time we're done walking GDB's list, the inferior's list
734 contains only the new shared objects, which we then add. */
737 gdb_link
= &so_list_head
;
740 struct so_list
*i
= inferior
;
741 struct so_list
**i_link
= &inferior
;
743 /* Check to see whether the shared object *gdb also appears in
744 the inferior's current list. */
749 if (ops
->same (gdb
, i
))
754 if (! filename_cmp (gdb
->so_original_name
, i
->so_original_name
))
762 /* If the shared object appears on the inferior's list too, then
763 it's still loaded, so we don't need to do anything. Delete
764 it from the inferior's list, and leave it on GDB's list. */
769 gdb_link
= &gdb
->next
;
773 /* If it's not on the inferior's list, remove it from GDB's tables. */
776 /* Notify any observer that the shared object has been
777 unloaded before we remove it from GDB's tables. */
778 observer_notify_solib_unloaded (gdb
);
780 VEC_safe_push (char_ptr
, current_program_space
->deleted_solibs
,
781 xstrdup (gdb
->so_name
));
783 *gdb_link
= gdb
->next
;
785 /* Unless the user loaded it explicitly, free SO's objfile. */
786 if (gdb
->objfile
&& ! (gdb
->objfile
->flags
& OBJF_USERLOADED
)
787 && !solib_used (gdb
))
788 free_objfile (gdb
->objfile
);
790 /* Some targets' section tables might be referring to
791 sections from so->abfd; remove them. */
792 remove_target_sections (gdb
);
799 /* Now the inferior's list contains only shared objects that don't
800 appear in GDB's list --- those that are newly loaded. Add them
801 to GDB's shared object list. */
805 const char *not_found_filename
= NULL
;
809 /* Add the new shared objects to GDB's list. */
810 *gdb_link
= inferior
;
812 /* Fill in the rest of each of the `struct so_list' nodes. */
813 for (i
= inferior
; i
; i
= i
->next
)
815 volatile struct gdb_exception e
;
817 i
->pspace
= current_program_space
;
818 VEC_safe_push (so_list_ptr
, current_program_space
->added_solibs
, i
);
820 TRY_CATCH (e
, RETURN_MASK_ERROR
)
822 /* Fill in the rest of the `struct so_list' node. */
823 if (!solib_map_sections (i
))
826 if (not_found_filename
== NULL
)
827 not_found_filename
= i
->so_original_name
;
832 exception_fprintf (gdb_stderr
, e
,
833 _("Error while mapping shared "
834 "library sections:\n"));
836 /* Notify any observer that the shared object has been
837 loaded now that we've added it to GDB's tables. */
838 observer_notify_solib_loaded (i
);
841 /* If a library was not found, issue an appropriate warning
842 message. We have to use a single call to warning in case the
843 front end does something special with warnings, e.g., pop up
844 a dialog box. It Would Be Nice if we could get a "warning: "
845 prefix on each line in the CLI front end, though - it doesn't
849 warning (_("Could not load shared library symbols for %s.\n"
850 "Do you need \"set solib-search-path\" "
851 "or \"set sysroot\"?"),
853 else if (not_found
> 1)
855 Could not load shared library symbols for %d libraries, e.g. %s.\n\
856 Use the \"info sharedlibrary\" command to see the complete listing.\n\
857 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
858 not_found
, not_found_filename
);
863 /* Return non-zero if NAME is the libpthread shared library.
865 Uses a fairly simplistic heuristic approach where we check
866 the file name against "/libpthread". This can lead to false
867 positives, but this should be good enough in practice. */
870 libpthread_name_p (const char *name
)
872 return (strstr (name
, "/libpthread") != NULL
);
875 /* Return non-zero if SO is the libpthread shared library. */
878 libpthread_solib_p (struct so_list
*so
)
880 return libpthread_name_p (so
->so_name
);
883 /* Read in symbolic information for any shared objects whose names
884 match PATTERN. (If we've already read a shared object's symbol
885 info, leave it alone.) If PATTERN is zero, read them all.
887 If READSYMS is 0, defer reading symbolic information until later
888 but still do any needed low level processing.
890 FROM_TTY and TARGET are as described for update_solib_list, above. */
893 solib_add (char *pattern
, int from_tty
,
894 struct target_ops
*target
, int readsyms
)
898 current_program_space
->solib_add_generation
++;
902 char *re_err
= re_comp (pattern
);
905 error (_("Invalid regexp: %s"), re_err
);
908 update_solib_list (from_tty
, target
);
910 /* Walk the list of currently loaded shared libraries, and read
911 symbols for any that match the pattern --- or any whose symbols
912 aren't already loaded, if no pattern was given. */
915 int loaded_any_symbols
= 0;
917 SYMFILE_DEFER_BP_RESET
| (from_tty
? SYMFILE_VERBOSE
: 0);
919 for (gdb
= so_list_head
; gdb
; gdb
= gdb
->next
)
920 if (! pattern
|| re_exec (gdb
->so_name
))
922 /* Normally, we would read the symbols from that library
923 only if READSYMS is set. However, we're making a small
924 exception for the pthread library, because we sometimes
925 need the library symbols to be loaded in order to provide
926 thread support (x86-linux for instance). */
927 const int add_this_solib
=
928 (readsyms
|| libpthread_solib_p (gdb
));
933 if (gdb
->symbols_loaded
)
935 /* If no pattern was given, be quiet for shared
936 libraries we have already loaded. */
937 if (pattern
&& (from_tty
|| info_verbose
))
938 printf_unfiltered (_("Symbols already loaded for %s\n"),
941 else if (solib_read_symbols (gdb
, flags
))
942 loaded_any_symbols
= 1;
946 if (loaded_any_symbols
)
947 breakpoint_re_set ();
949 if (from_tty
&& pattern
&& ! any_matches
)
951 ("No loaded shared libraries match the pattern `%s'.\n", pattern
);
953 if (loaded_any_symbols
)
955 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
957 /* Getting new symbols may change our opinion about what is
959 reinit_frame_cache ();
961 ops
->special_symbol_handling ();
966 /* Implement the "info sharedlibrary" command. Walk through the
967 shared library list and print information about each attached
968 library matching PATTERN. If PATTERN is elided, print them
972 info_sharedlibrary_command (char *pattern
, int from_tty
)
974 struct so_list
*so
= NULL
; /* link map state variable */
975 int so_missing_debug_info
= 0;
978 struct cleanup
*table_cleanup
;
979 struct gdbarch
*gdbarch
= target_gdbarch ();
980 struct ui_out
*uiout
= current_uiout
;
984 char *re_err
= re_comp (pattern
);
987 error (_("Invalid regexp: %s"), re_err
);
990 /* "0x", a little whitespace, and two hex digits per byte of pointers. */
991 addr_width
= 4 + (gdbarch_ptr_bit (gdbarch
) / 4);
993 update_solib_list (from_tty
, 0);
995 /* make_cleanup_ui_out_table_begin_end needs to know the number of
996 rows, so we need to make two passes over the libs. */
998 for (nr_libs
= 0, so
= so_list_head
; so
; so
= so
->next
)
1002 if (pattern
&& ! re_exec (so
->so_name
))
1009 make_cleanup_ui_out_table_begin_end (uiout
, 4, nr_libs
,
1010 "SharedLibraryTable");
1012 /* The "- 1" is because ui_out adds one space between columns. */
1013 ui_out_table_header (uiout
, addr_width
- 1, ui_left
, "from", "From");
1014 ui_out_table_header (uiout
, addr_width
- 1, ui_left
, "to", "To");
1015 ui_out_table_header (uiout
, 12 - 1, ui_left
, "syms-read", "Syms Read");
1016 ui_out_table_header (uiout
, 0, ui_noalign
,
1017 "name", "Shared Object Library");
1019 ui_out_table_body (uiout
);
1021 for (so
= so_list_head
; so
; so
= so
->next
)
1023 struct cleanup
*lib_cleanup
;
1025 if (! so
->so_name
[0])
1027 if (pattern
&& ! re_exec (so
->so_name
))
1030 lib_cleanup
= make_cleanup_ui_out_tuple_begin_end (uiout
, "lib");
1032 if (so
->addr_high
!= 0)
1034 ui_out_field_core_addr (uiout
, "from", gdbarch
, so
->addr_low
);
1035 ui_out_field_core_addr (uiout
, "to", gdbarch
, so
->addr_high
);
1039 ui_out_field_skip (uiout
, "from");
1040 ui_out_field_skip (uiout
, "to");
1043 if (! ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ()))
1044 && so
->symbols_loaded
1045 && !objfile_has_symbols (so
->objfile
))
1047 so_missing_debug_info
= 1;
1048 ui_out_field_string (uiout
, "syms-read", "Yes (*)");
1051 ui_out_field_string (uiout
, "syms-read",
1052 so
->symbols_loaded
? "Yes" : "No");
1054 ui_out_field_string (uiout
, "name", so
->so_name
);
1056 ui_out_text (uiout
, "\n");
1058 do_cleanups (lib_cleanup
);
1061 do_cleanups (table_cleanup
);
1066 ui_out_message (uiout
, 0,
1067 _("No shared libraries matched.\n"));
1069 ui_out_message (uiout
, 0,
1070 _("No shared libraries loaded at this time.\n"));
1074 if (so_missing_debug_info
)
1075 ui_out_message (uiout
, 0,
1076 _("(*): Shared library is missing "
1077 "debugging information.\n"));
1081 /* Return 1 if ADDRESS lies within SOLIB. */
1084 solib_contains_address_p (const struct so_list
*const solib
,
1087 struct target_section
*p
;
1089 for (p
= solib
->sections
; p
< solib
->sections_end
; p
++)
1090 if (p
->addr
<= address
&& address
< p
->endaddr
)
1096 /* If ADDRESS is in a shared lib in program space PSPACE, return its
1099 Provides a hook for other gdb routines to discover whether or not a
1100 particular address is within the mapped address space of a shared
1103 For example, this routine is called at one point to disable
1104 breakpoints which are in shared libraries that are not currently
1108 solib_name_from_address (struct program_space
*pspace
, CORE_ADDR address
)
1110 struct so_list
*so
= NULL
;
1112 for (so
= pspace
->so_list
; so
; so
= so
->next
)
1113 if (solib_contains_address_p (so
, address
))
1114 return (so
->so_name
);
1119 /* Return whether the data starting at VADDR, size SIZE, must be kept
1120 in a core file for shared libraries loaded before "gcore" is used
1121 to be handled correctly when the core file is loaded. This only
1122 applies when the section would otherwise not be kept in the core
1123 file (in particular, for readonly sections). */
1126 solib_keep_data_in_core (CORE_ADDR vaddr
, unsigned long size
)
1128 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1130 if (ops
->keep_data_in_core
)
1131 return ops
->keep_data_in_core (vaddr
, size
);
1136 /* Called by free_all_symtabs */
1141 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1143 /* This function is expected to handle ELF shared libraries. It is
1144 also used on Solaris, which can run either ELF or a.out binaries
1145 (for compatibility with SunOS 4), both of which can use shared
1146 libraries. So we don't know whether we have an ELF executable or
1147 an a.out executable until the user chooses an executable file.
1149 ELF shared libraries don't get mapped into the address space
1150 until after the program starts, so we'd better not try to insert
1151 breakpoints in them immediately. We have to wait until the
1152 dynamic linker has loaded them; we'll hit a bp_shlib_event
1153 breakpoint (look for calls to create_solib_event_breakpoint) when
1156 SunOS shared libraries seem to be different --- they're present
1157 as soon as the process begins execution, so there's no need to
1158 put off inserting breakpoints. There's also nowhere to put a
1159 bp_shlib_event breakpoint, so if we put it off, we'll never get
1162 So: disable breakpoints only if we're using ELF shared libs. */
1163 if (exec_bfd
!= NULL
1164 && bfd_get_flavour (exec_bfd
) != bfd_target_aout_flavour
)
1165 disable_breakpoints_in_shlibs ();
1167 while (so_list_head
)
1169 struct so_list
*so
= so_list_head
;
1171 so_list_head
= so
->next
;
1172 observer_notify_solib_unloaded (so
);
1173 remove_target_sections (so
);
1177 ops
->clear_solib ();
1180 /* Shared library startup support. When GDB starts up the inferior,
1181 it nurses it along (through the shell) until it is ready to execute
1182 its first instruction. At this point, this function gets
1186 solib_create_inferior_hook (int from_tty
)
1188 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1190 ops
->solib_create_inferior_hook (from_tty
);
1193 /* Check to see if an address is in the dynamic loader's dynamic
1194 symbol resolution code. Return 1 if so, 0 otherwise. */
1197 in_solib_dynsym_resolve_code (CORE_ADDR pc
)
1199 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1201 return ops
->in_dynsym_resolve_code (pc
);
1204 /* Implements the "sharedlibrary" command. */
1207 sharedlibrary_command (char *args
, int from_tty
)
1210 solib_add (args
, from_tty
, (struct target_ops
*) 0, 1);
1213 /* Implements the command "nosharedlibrary", which discards symbols
1214 that have been auto-loaded from shared libraries. Symbols from
1215 shared libraries that were added by explicit request of the user
1216 are not discarded. Also called from remote.c. */
1219 no_shared_libraries (char *ignored
, int from_tty
)
1221 /* The order of the two routines below is important: clear_solib notifies
1222 the solib_unloaded observers, and some of these observers might need
1223 access to their associated objfiles. Therefore, we can not purge the
1224 solibs' objfiles before clear_solib has been called. */
1227 objfile_purge_solibs ();
1233 update_solib_breakpoints (void)
1235 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1237 if (ops
->update_breakpoints
!= NULL
)
1238 ops
->update_breakpoints ();
1244 handle_solib_event (void)
1246 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1248 if (ops
->handle_event
!= NULL
)
1249 ops
->handle_event ();
1251 clear_program_space_solib_cache (current_inferior ()->pspace
);
1253 /* Check for any newly added shared libraries if we're supposed to
1254 be adding them automatically. Switch terminal for any messages
1255 produced by breakpoint_re_set. */
1256 target_terminal_ours_for_output ();
1257 solib_add (NULL
, 0, ¤t_target
, auto_solib_add
);
1258 target_terminal_inferior ();
1261 /* Reload shared libraries, but avoid reloading the same symbol file
1262 we already have loaded. */
1265 reload_shared_libraries_1 (int from_tty
)
1268 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
1270 for (so
= so_list_head
; so
!= NULL
; so
= so
->next
)
1272 char *filename
, *found_pathname
= NULL
;
1274 int was_loaded
= so
->symbols_loaded
;
1276 SYMFILE_DEFER_BP_RESET
| (from_tty
? SYMFILE_VERBOSE
: 0);
1278 filename
= tilde_expand (so
->so_original_name
);
1279 make_cleanup (xfree
, filename
);
1280 abfd
= solib_bfd_open (filename
);
1283 found_pathname
= xstrdup (bfd_get_filename (abfd
));
1284 make_cleanup (xfree
, found_pathname
);
1285 gdb_bfd_unref (abfd
);
1288 /* If this shared library is no longer associated with its previous
1289 symbol file, close that. */
1290 if ((found_pathname
== NULL
&& was_loaded
)
1291 || (found_pathname
!= NULL
1292 && filename_cmp (found_pathname
, so
->so_name
) != 0))
1294 if (so
->objfile
&& ! (so
->objfile
->flags
& OBJF_USERLOADED
)
1295 && !solib_used (so
))
1296 free_objfile (so
->objfile
);
1297 remove_target_sections (so
);
1301 /* If this shared library is now associated with a new symbol
1303 if (found_pathname
!= NULL
1305 || filename_cmp (found_pathname
, so
->so_name
) != 0))
1307 volatile struct gdb_exception e
;
1309 TRY_CATCH (e
, RETURN_MASK_ERROR
)
1310 solib_map_sections (so
);
1313 exception_fprintf (gdb_stderr
, e
,
1314 _("Error while mapping "
1315 "shared library sections:\n"));
1316 else if (auto_solib_add
|| was_loaded
|| libpthread_solib_p (so
))
1317 solib_read_symbols (so
, flags
);
1321 do_cleanups (old_chain
);
1325 reload_shared_libraries (char *ignored
, int from_tty
,
1326 struct cmd_list_element
*e
)
1328 const struct target_so_ops
*ops
;
1330 reload_shared_libraries_1 (from_tty
);
1332 ops
= solib_ops (target_gdbarch ());
1334 /* Creating inferior hooks here has two purposes. First, if we reload
1335 shared libraries then the address of solib breakpoint we've computed
1336 previously might be no longer valid. For example, if we forgot to set
1337 solib-absolute-prefix and are setting it right now, then the previous
1338 breakpoint address is plain wrong. Second, installing solib hooks
1339 also implicitly figures were ld.so is and loads symbols for it.
1340 Absent this call, if we've just connected to a target and set
1341 solib-absolute-prefix or solib-search-path, we'll lose all information
1343 if (target_has_execution
)
1345 /* Reset or free private data structures not associated with
1347 ops
->clear_solib ();
1349 /* Remove any previous solib event breakpoint. This is usually
1350 done in common code, at breakpoint_init_inferior time, but
1351 we're not really starting up the inferior here. */
1352 remove_solib_event_breakpoints ();
1354 solib_create_inferior_hook (from_tty
);
1357 /* Sometimes the platform-specific hook loads initial shared
1358 libraries, and sometimes it doesn't. If it doesn't FROM_TTY will be
1359 incorrectly 0 but such solib targets should be fixed anyway. If we
1360 made all the inferior hook methods consistent, this call could be
1361 removed. Call it only after the solib target has been initialized by
1362 solib_create_inferior_hook. */
1364 solib_add (NULL
, 0, NULL
, auto_solib_add
);
1366 breakpoint_re_set ();
1368 /* We may have loaded or unloaded debug info for some (or all)
1369 shared libraries. However, frames may still reference them. For
1370 example, a frame's unwinder might still point at DWARF FDE
1371 structures that are now freed. Also, getting new symbols may
1372 change our opinion about what is frameless. */
1373 reinit_frame_cache ();
1375 ops
->special_symbol_handling ();
1379 show_auto_solib_add (struct ui_file
*file
, int from_tty
,
1380 struct cmd_list_element
*c
, const char *value
)
1382 fprintf_filtered (file
, _("Autoloading of shared library symbols is %s.\n"),
1387 /* Handler for library-specific lookup of global symbol NAME in OBJFILE. Call
1388 the library-specific handler if it is installed for the current target. */
1391 solib_global_lookup (const struct objfile
*objfile
,
1393 const domain_enum domain
)
1395 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1397 if (ops
->lookup_lib_global_symbol
!= NULL
)
1398 return ops
->lookup_lib_global_symbol (objfile
, name
, domain
);
1402 /* Lookup the value for a specific symbol from dynamic symbol table. Look
1403 up symbol from ABFD. MATCH_SYM is a callback function to determine
1404 whether to pick up a symbol. DATA is the input of this callback
1405 function. Return NULL if symbol is not found. */
1408 gdb_bfd_lookup_symbol_from_symtab (bfd
*abfd
,
1409 int (*match_sym
) (asymbol
*, void *),
1412 long storage_needed
= bfd_get_symtab_upper_bound (abfd
);
1413 CORE_ADDR symaddr
= 0;
1415 if (storage_needed
> 0)
1419 asymbol
**symbol_table
= (asymbol
**) xmalloc (storage_needed
);
1420 struct cleanup
*back_to
= make_cleanup (xfree
, symbol_table
);
1421 unsigned int number_of_symbols
=
1422 bfd_canonicalize_symtab (abfd
, symbol_table
);
1424 for (i
= 0; i
< number_of_symbols
; i
++)
1426 asymbol
*sym
= *symbol_table
++;
1428 if (match_sym (sym
, data
))
1430 /* BFD symbols are section relative. */
1431 symaddr
= sym
->value
+ sym
->section
->vma
;
1435 do_cleanups (back_to
);
1441 /* Lookup the value for a specific symbol from symbol table. Look up symbol
1442 from ABFD. MATCH_SYM is a callback function to determine whether to pick
1443 up a symbol. DATA is the input of this callback function. Return NULL
1444 if symbol is not found. */
1447 bfd_lookup_symbol_from_dyn_symtab (bfd
*abfd
,
1448 int (*match_sym
) (asymbol
*, void *),
1451 long storage_needed
= bfd_get_dynamic_symtab_upper_bound (abfd
);
1452 CORE_ADDR symaddr
= 0;
1454 if (storage_needed
> 0)
1457 asymbol
**symbol_table
= (asymbol
**) xmalloc (storage_needed
);
1458 struct cleanup
*back_to
= make_cleanup (xfree
, symbol_table
);
1459 unsigned int number_of_symbols
=
1460 bfd_canonicalize_dynamic_symtab (abfd
, symbol_table
);
1462 for (i
= 0; i
< number_of_symbols
; i
++)
1464 asymbol
*sym
= *symbol_table
++;
1466 if (match_sym (sym
, data
))
1468 /* BFD symbols are section relative. */
1469 symaddr
= sym
->value
+ sym
->section
->vma
;
1473 do_cleanups (back_to
);
1478 /* Lookup the value for a specific symbol from symbol table and dynamic
1479 symbol table. Look up symbol from ABFD. MATCH_SYM is a callback
1480 function to determine whether to pick up a symbol. DATA is the
1481 input of this callback function. Return NULL if symbol is not
1485 gdb_bfd_lookup_symbol (bfd
*abfd
,
1486 int (*match_sym
) (asymbol
*, void *),
1489 CORE_ADDR symaddr
= gdb_bfd_lookup_symbol_from_symtab (abfd
, match_sym
, data
);
1491 /* On FreeBSD, the dynamic linker is stripped by default. So we'll
1492 have to check the dynamic string table too. */
1494 symaddr
= bfd_lookup_symbol_from_dyn_symtab (abfd
, match_sym
, data
);
1499 extern initialize_file_ftype _initialize_solib
; /* -Wmissing-prototypes */
1502 _initialize_solib (void)
1504 solib_data
= gdbarch_data_register_pre_init (solib_init
);
1506 add_com ("sharedlibrary", class_files
, sharedlibrary_command
,
1507 _("Load shared object library symbols for files matching REGEXP."));
1508 add_info ("sharedlibrary", info_sharedlibrary_command
,
1509 _("Status of loaded shared object libraries."));
1510 add_com ("nosharedlibrary", class_files
, no_shared_libraries
,
1511 _("Unload all shared object library symbols."));
1513 add_setshow_boolean_cmd ("auto-solib-add", class_support
,
1514 &auto_solib_add
, _("\
1515 Set autoloading of shared library symbols."), _("\
1516 Show autoloading of shared library symbols."), _("\
1517 If \"on\", symbols from all shared object libraries will be loaded\n\
1518 automatically when the inferior begins execution, when the dynamic linker\n\
1519 informs gdb that a new library has been loaded, or when attaching to the\n\
1520 inferior. Otherwise, symbols must be loaded manually, using \
1523 show_auto_solib_add
,
1524 &setlist
, &showlist
);
1526 add_setshow_filename_cmd ("sysroot", class_support
,
1528 Set an alternate system root."), _("\
1529 Show the current system root."), _("\
1530 The system root is used to load absolute shared library symbol files.\n\
1531 For other (relative) files, you can add directories using\n\
1532 `set solib-search-path'."),
1533 reload_shared_libraries
,
1535 &setlist
, &showlist
);
1537 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support
, 0,
1539 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support
, 0,
1542 add_setshow_optional_filename_cmd ("solib-search-path", class_support
,
1543 &solib_search_path
, _("\
1544 Set the search path for loading non-absolute shared library symbol files."),
1546 Show the search path for loading non-absolute shared library symbol files."),
1548 This takes precedence over the environment variables \
1549 PATH and LD_LIBRARY_PATH."),
1550 reload_shared_libraries
,
1551 show_solib_search_path
,
1552 &setlist
, &showlist
);