1 /* Handle shared libraries for GDB, the GNU Debugger.
3 Copyright (C) 1990-2020 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include <sys/types.h>
32 #include "gdb_regex.h"
34 #include "gdbsupport/environ.h"
37 #include "completer.h"
38 #include "filenames.h" /* for DOSish file names */
41 #include "observable.h"
42 #include "readline/tilde.h"
46 #include "filesystem.h"
48 #include "gdbsupport/filestuff.h"
50 #include "cli/cli-style.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
71 = (const struct target_so_ops
**) gdbarch_data (gdbarch
, solib_data
);
76 /* Set the solib operations for GDBARCH to NEW_OPS. */
79 set_solib_ops (struct gdbarch
*gdbarch
, const struct target_so_ops
*new_ops
)
81 const struct target_so_ops
**ops
82 = (const struct target_so_ops
**) gdbarch_data (gdbarch
, solib_data
);
88 /* external data declarations */
90 /* FIXME: gdbarch needs to control this variable, or else every
91 configuration needs to call set_solib_ops. */
92 struct target_so_ops
*current_target_so_ops
;
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 /* Return the full pathname of a binary file (the main executable or a
117 shared library file), or NULL if not found. If FD is non-NULL, *FD
118 is set to either -1 or an open file handle for the binary file.
120 Global variable GDB_SYSROOT is used as a prefix directory
121 to search for binary files if they have an absolute path.
122 If GDB_SYSROOT starts with "target:" and target filesystem
123 is the local filesystem then the "target:" prefix will be
124 stripped before the search starts. This ensures that the
125 same search algorithm is used for local files regardless of
126 whether a "target:" prefix was used.
128 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
129 (or set of directories, as in LD_LIBRARY_PATH) to search for all
130 shared libraries if not found in either the sysroot (if set) or
131 the local filesystem. SOLIB_SEARCH_PATH is not used when searching
132 for the main executable.
135 * If a sysroot is set and path is absolute:
136 * Search for sysroot/path.
138 * Look for it literally (unmodified).
139 * If IS_SOLIB is non-zero:
140 * Look in SOLIB_SEARCH_PATH.
141 * If available, use target defined search function.
142 * If NO sysroot is set, perform the following two searches:
143 * Look in inferior's $PATH.
144 * If IS_SOLIB is non-zero:
145 * Look in inferior's $LD_LIBRARY_PATH.
147 * The last check avoids doing this search when targeting remote
148 * machines since a sysroot will almost always be set.
151 static gdb::unique_xmalloc_ptr
<char>
152 solib_find_1 (const char *in_pathname
, int *fd
, bool is_solib
)
154 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
156 gdb::unique_xmalloc_ptr
<char> temp_pathname
;
157 const char *fskind
= effective_target_file_system_kind ();
158 const char *sysroot
= gdb_sysroot
;
159 int prefix_len
, orig_prefix_len
;
161 /* If the absolute prefix starts with "target:" but the filesystem
162 accessed by the target_fileio_* methods is the local filesystem
163 then we strip the "target:" prefix now and work with the local
164 filesystem. This ensures that the same search algorithm is used
165 for all local files regardless of whether a "target:" prefix was
167 if (is_target_filename (sysroot
) && target_filesystem_is_local ())
168 sysroot
+= strlen (TARGET_SYSROOT_PREFIX
);
170 /* Strip any trailing slashes from the absolute prefix. */
171 prefix_len
= orig_prefix_len
= strlen (sysroot
);
173 while (prefix_len
> 0 && IS_DIR_SEPARATOR (sysroot
[prefix_len
- 1]))
176 std::string sysroot_holder
;
179 else if (prefix_len
!= orig_prefix_len
)
181 sysroot_holder
= std::string (sysroot
, prefix_len
);
182 sysroot
= sysroot_holder
.c_str ();
185 /* If we're on a non-DOS-based system, backslashes won't be
186 understood as directory separator, so, convert them to forward
187 slashes, iff we're supposed to handle DOS-based file system
188 semantics for target paths. */
189 if (!DOS_BASED_FILE_SYSTEM
&& fskind
== file_system_kind_dos_based
)
193 /* Avoid clobbering our input. */
194 p
= (char *) alloca (strlen (in_pathname
) + 1);
195 strcpy (p
, in_pathname
);
205 /* Note, we're interested in IS_TARGET_ABSOLUTE_PATH, not
206 IS_ABSOLUTE_PATH. The latter is for host paths only, while
207 IN_PATHNAME is a target path. For example, if we're supposed to
208 be handling DOS-like semantics we want to consider a
209 'c:/foo/bar.dll' path as an absolute path, even on a Unix box.
210 With such a path, before giving up on the sysroot, we'll try:
212 1st attempt, c:/foo/bar.dll ==> /sysroot/c:/foo/bar.dll
213 2nd attempt, c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll
214 3rd attempt, c:/foo/bar.dll ==> /sysroot/foo/bar.dll
217 if (!IS_TARGET_ABSOLUTE_PATH (fskind
, in_pathname
) || sysroot
== NULL
)
218 temp_pathname
.reset (xstrdup (in_pathname
));
221 bool need_dir_separator
;
223 /* Concatenate the sysroot and the target reported filename. We
224 may need to glue them with a directory separator. Cases to
227 | sysroot | separator | in_pathname |
228 |-----------------+-----------+----------------|
229 | /some/dir | / | c:/foo/bar.dll |
230 | /some/dir | | /foo/bar.dll |
231 | target: | | c:/foo/bar.dll |
232 | target: | | /foo/bar.dll |
233 | target:some/dir | / | c:/foo/bar.dll |
234 | target:some/dir | | /foo/bar.dll |
236 IOW, we don't need to add a separator if IN_PATHNAME already
237 has one, or when the sysroot is exactly "target:".
238 There's no need to check for drive spec explicitly, as we only
239 get here if IN_PATHNAME is considered an absolute path. */
240 need_dir_separator
= !(IS_DIR_SEPARATOR (in_pathname
[0])
241 || strcmp (TARGET_SYSROOT_PREFIX
, sysroot
) == 0);
243 /* Cat the prefixed pathname together. */
244 temp_pathname
.reset (concat (sysroot
,
245 need_dir_separator
? SLASH_STRING
: "",
246 in_pathname
, (char *) NULL
));
249 /* Handle files to be accessed via the target. */
250 if (is_target_filename (temp_pathname
.get ()))
254 return temp_pathname
;
257 /* Now see if we can open it. */
258 found_file
= gdb_open_cloexec (temp_pathname
.get (), O_RDONLY
| O_BINARY
, 0);
260 /* If the search in gdb_sysroot failed, and the path name has a
261 drive spec (e.g, c:/foo), try stripping ':' from the drive spec,
262 and retrying in the sysroot:
263 c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll. */
267 && HAS_TARGET_DRIVE_SPEC (fskind
, in_pathname
))
269 bool need_dir_separator
= !IS_DIR_SEPARATOR (in_pathname
[2]);
270 char drive
[2] = { in_pathname
[0], '\0' };
272 temp_pathname
.reset (concat (sysroot
,
275 need_dir_separator
? SLASH_STRING
: "",
276 in_pathname
+ 2, (char *) NULL
));
278 found_file
= gdb_open_cloexec (temp_pathname
.get (),
279 O_RDONLY
| O_BINARY
, 0);
282 /* If the search in gdb_sysroot still failed, try fully
283 stripping the drive spec, and trying once more in the
284 sysroot before giving up.
286 c:/foo/bar.dll ==> /sysroot/foo/bar.dll. */
288 temp_pathname
.reset (concat (sysroot
,
289 need_dir_separator
? SLASH_STRING
: "",
290 in_pathname
+ 2, (char *) NULL
));
292 found_file
= gdb_open_cloexec (temp_pathname
.get (),
293 O_RDONLY
| O_BINARY
, 0);
297 /* We try to find the library in various ways. After each attempt,
298 either found_file >= 0 and temp_pathname is a malloc'd string, or
299 found_file < 0 and temp_pathname does not point to storage that
300 needs to be freed. */
303 temp_pathname
.reset (NULL
);
305 /* If the search in gdb_sysroot failed, and the path name is
306 absolute at this point, make it relative. (openp will try and open the
307 file according to its absolute path otherwise, which is not what we want.)
308 Affects subsequent searches for this solib. */
309 if (found_file
< 0 && IS_TARGET_ABSOLUTE_PATH (fskind
, in_pathname
))
311 /* First, get rid of any drive letters etc. */
312 while (!IS_TARGET_DIR_SEPARATOR (fskind
, *in_pathname
))
315 /* Next, get rid of all leading dir separators. */
316 while (IS_TARGET_DIR_SEPARATOR (fskind
, *in_pathname
))
320 /* If not found, and we're looking for a solib, search the
321 solib_search_path (if any). */
322 if (is_solib
&& found_file
< 0 && solib_search_path
!= NULL
)
323 found_file
= openp (solib_search_path
,
324 OPF_TRY_CWD_FIRST
| OPF_RETURN_REALPATH
,
325 in_pathname
, O_RDONLY
| O_BINARY
, &temp_pathname
);
327 /* If not found, and we're looking for a solib, next search the
328 solib_search_path (if any) for the basename only (ignoring the
329 path). This is to allow reading solibs from a path that differs
330 from the opened path. */
331 if (is_solib
&& found_file
< 0 && solib_search_path
!= NULL
)
332 found_file
= openp (solib_search_path
,
333 OPF_TRY_CWD_FIRST
| OPF_RETURN_REALPATH
,
334 target_lbasename (fskind
, in_pathname
),
335 O_RDONLY
| O_BINARY
, &temp_pathname
);
337 /* If not found, and we're looking for a solib, try to use target
338 supplied solib search method. */
339 if (is_solib
&& found_file
< 0 && ops
->find_and_open_solib
)
340 found_file
= ops
->find_and_open_solib (in_pathname
, O_RDONLY
| O_BINARY
,
343 /* If not found, next search the inferior's $PATH environment variable. */
344 if (found_file
< 0 && sysroot
== NULL
)
345 found_file
= openp (current_inferior ()->environment
.get ("PATH"),
346 OPF_TRY_CWD_FIRST
| OPF_RETURN_REALPATH
, in_pathname
,
347 O_RDONLY
| O_BINARY
, &temp_pathname
);
349 /* If not found, and we're looking for a solib, next search the
350 inferior's $LD_LIBRARY_PATH environment variable. */
351 if (is_solib
&& found_file
< 0 && sysroot
== NULL
)
352 found_file
= openp (current_inferior ()->environment
.get
354 OPF_TRY_CWD_FIRST
| OPF_RETURN_REALPATH
, in_pathname
,
355 O_RDONLY
| O_BINARY
, &temp_pathname
);
365 return temp_pathname
;
368 /* Return the full pathname of the main executable, or NULL if not
369 found. If FD is non-NULL, *FD is set to either -1 or an open file
370 handle for the main executable. */
372 gdb::unique_xmalloc_ptr
<char>
373 exec_file_find (const char *in_pathname
, int *fd
)
375 gdb::unique_xmalloc_ptr
<char> result
;
376 const char *fskind
= effective_target_file_system_kind ();
378 if (in_pathname
== NULL
)
381 if (*gdb_sysroot
!= '\0' && IS_TARGET_ABSOLUTE_PATH (fskind
, in_pathname
))
383 result
= solib_find_1 (in_pathname
, fd
, false);
385 if (result
== NULL
&& fskind
== file_system_kind_dos_based
)
389 new_pathname
= (char *) alloca (strlen (in_pathname
) + 5);
390 strcpy (new_pathname
, in_pathname
);
391 strcat (new_pathname
, ".exe");
393 result
= solib_find_1 (new_pathname
, fd
, false);
398 /* It's possible we don't have a full path, but rather just a
399 filename. Some targets, such as HP-UX, don't provide the
402 Attempt to qualify the filename against the source path.
403 (If that fails, we'll just fall back on the original
404 filename. Not much more we can do...) */
406 if (!source_full_path_of (in_pathname
, &result
))
407 result
.reset (xstrdup (in_pathname
));
415 /* Return the full pathname of a shared library file, or NULL if not
416 found. If FD is non-NULL, *FD is set to either -1 or an open file
417 handle for the shared library.
419 The search algorithm used is described in solib_find_1's comment
422 gdb::unique_xmalloc_ptr
<char>
423 solib_find (const char *in_pathname
, int *fd
)
425 const char *solib_symbols_extension
426 = gdbarch_solib_symbols_extension (target_gdbarch ());
428 /* If solib_symbols_extension is set, replace the file's
430 if (solib_symbols_extension
!= NULL
)
432 const char *p
= in_pathname
+ strlen (in_pathname
);
434 while (p
> in_pathname
&& *p
!= '.')
442 = (char *) alloca (p
- in_pathname
+ 1
443 + strlen (solib_symbols_extension
) + 1);
444 memcpy (new_pathname
, in_pathname
, p
- in_pathname
+ 1);
445 strcpy (new_pathname
+ (p
- in_pathname
) + 1,
446 solib_symbols_extension
);
448 in_pathname
= new_pathname
;
452 return solib_find_1 (in_pathname
, fd
, true);
455 /* Open and return a BFD for the shared library PATHNAME. If FD is not -1,
456 it is used as file handle to open the file. Throws an error if the file
457 could not be opened. Handles both local and remote file access.
459 If unsuccessful, the FD will be closed (unless FD was -1). */
462 solib_bfd_fopen (const char *pathname
, int fd
)
464 gdb_bfd_ref_ptr
abfd (gdb_bfd_open (pathname
, gnutarget
, fd
));
466 if (abfd
!= NULL
&& !gdb_bfd_has_target_filename (abfd
.get ()))
467 bfd_set_cacheable (abfd
.get (), 1);
471 /* Arrange to free PATHNAME when the error is thrown. */
472 error (_("Could not open `%s' as an executable file: %s"),
473 pathname
, bfd_errmsg (bfd_get_error ()));
479 /* Find shared library PATHNAME and open a BFD for it. */
482 solib_bfd_open (const char *pathname
)
485 const struct bfd_arch_info
*b
;
487 /* Search for shared library file. */
488 gdb::unique_xmalloc_ptr
<char> found_pathname
489 = solib_find (pathname
, &found_file
);
490 if (found_pathname
== NULL
)
492 /* Return failure if the file could not be found, so that we can
493 accumulate messages about missing libraries. */
497 perror_with_name (pathname
);
500 /* Open bfd for shared library. */
501 gdb_bfd_ref_ptr
abfd (solib_bfd_fopen (found_pathname
.get (), found_file
));
503 /* Check bfd format. */
504 if (!bfd_check_format (abfd
.get (), bfd_object
))
505 error (_("`%s': not in executable format: %s"),
506 bfd_get_filename (abfd
.get ()), bfd_errmsg (bfd_get_error ()));
508 /* Check bfd arch. */
509 b
= gdbarch_bfd_arch_info (target_gdbarch ());
510 if (!b
->compatible (b
, bfd_get_arch_info (abfd
.get ())))
511 warning (_("`%s': Shared library architecture %s is not compatible "
512 "with target architecture %s."), bfd_get_filename (abfd
.get ()),
513 bfd_get_arch_info (abfd
.get ())->printable_name
,
519 /* Given a pointer to one of the shared objects in our list of mapped
520 objects, use the recorded name to open a bfd descriptor for the
521 object, build a section table, relocate all the section addresses
522 by the base address at which the shared object was mapped, and then
523 add the sections to the target's section table.
525 FIXME: In most (all?) cases the shared object file name recorded in
526 the dynamic linkage tables will be a fully qualified pathname. For
527 cases where it isn't, do we really mimic the systems search
528 mechanism correctly in the below code (particularly the tilde
529 expansion stuff?). */
532 solib_map_sections (struct so_list
*so
)
534 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
536 gdb::unique_xmalloc_ptr
<char> filename (tilde_expand (so
->so_name
));
537 gdb_bfd_ref_ptr
abfd (ops
->bfd_open (filename
.get ()));
542 /* Leave bfd open, core_xfer_memory and "info files" need it. */
543 so
->abfd
= abfd
.release ();
545 /* Copy the full path name into so_name, allowing symbol_file_add
546 to find it later. This also affects the =library-loaded GDB/MI
547 event, and in particular the part of that notification providing
548 the library's host-side path. If we let the target dictate
549 that objfile's path, and the target is different from the host,
550 GDB/MI will not provide the correct host-side path. */
551 if (strlen (bfd_get_filename (so
->abfd
)) >= SO_NAME_MAX_PATH_SIZE
)
552 error (_("Shared library file name is too long."));
553 strcpy (so
->so_name
, bfd_get_filename (so
->abfd
));
555 if (so
->sections
== nullptr)
556 so
->sections
= new target_section_table
;
557 *so
->sections
= build_section_table (so
->abfd
);
559 for (target_section
&p
: *so
->sections
)
561 /* Relocate the section binding addresses as recorded in the shared
562 object's file by the base address to which the object was actually
564 ops
->relocate_section_addresses (so
, &p
);
566 /* If the target didn't provide information about the address
567 range of the shared object, assume we want the location of
568 the .text section. */
569 if (so
->addr_low
== 0 && so
->addr_high
== 0
570 && strcmp (p
.the_bfd_section
->name
, ".text") == 0)
572 so
->addr_low
= p
.addr
;
573 so
->addr_high
= p
.endaddr
;
577 /* Add the shared object's sections to the current set of file
578 section tables. Do this immediately after mapping the object so
579 that later nodes in the list can query this object, as is needed
581 add_target_sections (so
, *so
->sections
);
586 /* Free symbol-file related contents of SO and reset for possible reloading
587 of SO. If we have opened a BFD for SO, close it. If we have placed SO's
588 sections in some target's section table, the caller is responsible for
591 This function doesn't mess with objfiles at all. If there is an
592 objfile associated with SO that needs to be removed, the caller is
593 responsible for taking care of that. */
596 clear_so (struct so_list
*so
)
598 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
603 gdb_bfd_unref (so
->abfd
);
606 /* Our caller closed the objfile, possibly via objfile_purge_solibs. */
607 so
->symbols_loaded
= 0;
610 so
->addr_low
= so
->addr_high
= 0;
612 /* Restore the target-supplied file name. SO_NAME may be the path
613 of the symbol file. */
614 strcpy (so
->so_name
, so
->so_original_name
);
616 /* Do the same for target-specific data. */
617 if (ops
->clear_so
!= NULL
)
621 /* Free the storage associated with the `struct so_list' object SO.
622 If we have opened a BFD for SO, close it.
624 The caller is responsible for removing SO from whatever list it is
625 a member of. If we have placed SO's sections in some target's
626 section table, the caller is responsible for removing them.
628 This function doesn't mess with objfiles at all. If there is an
629 objfile associated with SO that needs to be removed, the caller is
630 responsible for taking care of that. */
633 free_so (struct so_list
*so
)
635 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
644 /* Read in symbols for shared object SO. If SYMFILE_VERBOSE is set in FLAGS,
645 be chatty about it. Return true if any symbols were actually loaded. */
648 solib_read_symbols (struct so_list
*so
, symfile_add_flags flags
)
650 if (so
->symbols_loaded
)
652 /* If needed, we've already warned in our caller. */
654 else if (so
->abfd
== NULL
)
656 /* We've already warned about this library, when trying to open
662 flags
|= current_inferior ()->symfile_flags
;
666 /* Have we already loaded this shared object? */
667 so
->objfile
= nullptr;
668 for (objfile
*objfile
: current_program_space
->objfiles ())
670 if (filename_cmp (objfile_name (objfile
), so
->so_name
) == 0
671 && objfile
->addr_low
== so
->addr_low
)
673 so
->objfile
= objfile
;
677 if (so
->objfile
== NULL
)
679 section_addr_info sap
680 = build_section_addr_info_from_section_table (*so
->sections
);
681 so
->objfile
= symbol_file_add_from_bfd (so
->abfd
, so
->so_name
,
684 so
->objfile
->addr_low
= so
->addr_low
;
687 so
->symbols_loaded
= 1;
689 catch (const gdb_exception_error
&e
)
691 exception_fprintf (gdb_stderr
, e
, _("Error while reading shared"
692 " library symbols for %s:\n"),
702 /* Return true if KNOWN->objfile is used by any other so_list object
703 in the list of shared libraries. Return false otherwise. */
706 solib_used (const struct so_list
*const known
)
708 for (const struct so_list
*pivot
: current_program_space
->solibs ())
709 if (pivot
!= known
&& pivot
->objfile
== known
->objfile
)
717 update_solib_list (int from_tty
)
719 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
720 struct so_list
*inferior
= ops
->current_sos();
721 struct so_list
*gdb
, **gdb_link
;
723 /* We can reach here due to changing solib-search-path or the
724 sysroot, before having any inferior. */
725 if (target_has_execution () && inferior_ptid
!= null_ptid
)
727 struct inferior
*inf
= current_inferior ();
729 /* If we are attaching to a running process for which we
730 have not opened a symbol file, we may be able to get its
732 if (inf
->attach_flag
&& symfile_objfile
== NULL
)
736 ops
->open_symbol_file_object (from_tty
);
738 catch (const gdb_exception
&ex
)
740 exception_fprintf (gdb_stderr
, ex
,
741 "Error reading attached "
742 "process's symbol file.\n");
747 /* GDB and the inferior's dynamic linker each maintain their own
748 list of currently loaded shared objects; we want to bring the
749 former in sync with the latter. Scan both lists, seeing which
750 shared objects appear where. There are three cases:
752 - A shared object appears on both lists. This means that GDB
753 knows about it already, and it's still loaded in the inferior.
754 Nothing needs to happen.
756 - A shared object appears only on GDB's list. This means that
757 the inferior has unloaded it. We should remove the shared
758 object from GDB's tables.
760 - A shared object appears only on the inferior's list. This
761 means that it's just been loaded. We should add it to GDB's
764 So we walk GDB's list, checking each entry to see if it appears
765 in the inferior's list too. If it does, no action is needed, and
766 we remove it from the inferior's list. If it doesn't, the
767 inferior has unloaded it, and we remove it from GDB's list. By
768 the time we're done walking GDB's list, the inferior's list
769 contains only the new shared objects, which we then add. */
771 gdb
= current_program_space
->so_list
;
772 gdb_link
= ¤t_program_space
->so_list
;
775 struct so_list
*i
= inferior
;
776 struct so_list
**i_link
= &inferior
;
778 /* Check to see whether the shared object *gdb also appears in
779 the inferior's current list. */
784 if (ops
->same (gdb
, i
))
789 if (! filename_cmp (gdb
->so_original_name
, i
->so_original_name
))
797 /* If the shared object appears on the inferior's list too, then
798 it's still loaded, so we don't need to do anything. Delete
799 it from the inferior's list, and leave it on GDB's list. */
804 gdb_link
= &gdb
->next
;
808 /* If it's not on the inferior's list, remove it from GDB's tables. */
811 /* Notify any observer that the shared object has been
812 unloaded before we remove it from GDB's tables. */
813 gdb::observers::solib_unloaded
.notify (gdb
);
815 current_program_space
->deleted_solibs
.push_back (gdb
->so_name
);
817 *gdb_link
= gdb
->next
;
819 /* Unless the user loaded it explicitly, free SO's objfile. */
820 if (gdb
->objfile
&& ! (gdb
->objfile
->flags
& OBJF_USERLOADED
)
821 && !solib_used (gdb
))
822 gdb
->objfile
->unlink ();
824 /* Some targets' section tables might be referring to
825 sections from so->abfd; remove them. */
826 remove_target_sections (gdb
);
833 /* Now the inferior's list contains only shared objects that don't
834 appear in GDB's list --- those that are newly loaded. Add them
835 to GDB's shared object list. */
839 const char *not_found_filename
= NULL
;
843 /* Add the new shared objects to GDB's list. */
844 *gdb_link
= inferior
;
846 /* Fill in the rest of each of the `struct so_list' nodes. */
847 for (i
= inferior
; i
; i
= i
->next
)
850 i
->pspace
= current_program_space
;
851 current_program_space
->added_solibs
.push_back (i
);
855 /* Fill in the rest of the `struct so_list' node. */
856 if (!solib_map_sections (i
))
859 if (not_found_filename
== NULL
)
860 not_found_filename
= i
->so_original_name
;
864 catch (const gdb_exception_error
&e
)
866 exception_fprintf (gdb_stderr
, e
,
867 _("Error while mapping shared "
868 "library sections:\n"));
871 /* Notify any observer that the shared object has been
872 loaded now that we've added it to GDB's tables. */
873 gdb::observers::solib_loaded
.notify (i
);
876 /* If a library was not found, issue an appropriate warning
877 message. We have to use a single call to warning in case the
878 front end does something special with warnings, e.g., pop up
879 a dialog box. It Would Be Nice if we could get a "warning: "
880 prefix on each line in the CLI front end, though - it doesn't
884 warning (_("Could not load shared library symbols for %s.\n"
885 "Do you need \"set solib-search-path\" "
886 "or \"set sysroot\"?"),
888 else if (not_found
> 1)
890 Could not load shared library symbols for %d libraries, e.g. %s.\n\
891 Use the \"info sharedlibrary\" command to see the complete listing.\n\
892 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
893 not_found
, not_found_filename
);
898 /* Return non-zero if NAME is the libpthread shared library.
900 Uses a fairly simplistic heuristic approach where we check
901 the file name against "/libpthread". This can lead to false
902 positives, but this should be good enough in practice. */
905 libpthread_name_p (const char *name
)
907 return (strstr (name
, "/libpthread") != NULL
);
910 /* Return non-zero if SO is the libpthread shared library. */
913 libpthread_solib_p (struct so_list
*so
)
915 return libpthread_name_p (so
->so_name
);
918 /* Read in symbolic information for any shared objects whose names
919 match PATTERN. (If we've already read a shared object's symbol
920 info, leave it alone.) If PATTERN is zero, read them all.
922 If READSYMS is 0, defer reading symbolic information until later
923 but still do any needed low level processing.
925 FROM_TTY is described for update_solib_list, above. */
928 solib_add (const char *pattern
, int from_tty
, int readsyms
)
930 if (print_symbol_loading_p (from_tty
, 0, 0))
934 printf_unfiltered (_("Loading symbols for shared libraries: %s\n"),
938 printf_unfiltered (_("Loading symbols for shared libraries.\n"));
941 current_program_space
->solib_add_generation
++;
945 char *re_err
= re_comp (pattern
);
948 error (_("Invalid regexp: %s"), re_err
);
951 update_solib_list (from_tty
);
953 /* Walk the list of currently loaded shared libraries, and read
954 symbols for any that match the pattern --- or any whose symbols
955 aren't already loaded, if no pattern was given. */
957 bool any_matches
= false;
958 bool loaded_any_symbols
= false;
959 symfile_add_flags add_flags
= SYMFILE_DEFER_BP_RESET
;
962 add_flags
|= SYMFILE_VERBOSE
;
964 for (struct so_list
*gdb
: current_program_space
->solibs ())
965 if (! pattern
|| re_exec (gdb
->so_name
))
967 /* Normally, we would read the symbols from that library
968 only if READSYMS is set. However, we're making a small
969 exception for the pthread library, because we sometimes
970 need the library symbols to be loaded in order to provide
971 thread support (x86-linux for instance). */
972 const int add_this_solib
=
973 (readsyms
|| libpthread_solib_p (gdb
));
978 if (gdb
->symbols_loaded
)
980 /* If no pattern was given, be quiet for shared
981 libraries we have already loaded. */
982 if (pattern
&& (from_tty
|| info_verbose
))
983 printf_unfiltered (_("Symbols already loaded for %s\n"),
986 else if (solib_read_symbols (gdb
, add_flags
))
987 loaded_any_symbols
= true;
991 if (loaded_any_symbols
)
992 breakpoint_re_set ();
994 if (from_tty
&& pattern
&& ! any_matches
)
996 ("No loaded shared libraries match the pattern `%s'.\n", pattern
);
998 if (loaded_any_symbols
)
1000 /* Getting new symbols may change our opinion about what is
1002 reinit_frame_cache ();
1007 /* Implement the "info sharedlibrary" command. Walk through the
1008 shared library list and print information about each attached
1009 library matching PATTERN. If PATTERN is elided, print them
1013 info_sharedlibrary_command (const char *pattern
, int from_tty
)
1015 bool so_missing_debug_info
= false;
1018 struct gdbarch
*gdbarch
= target_gdbarch ();
1019 struct ui_out
*uiout
= current_uiout
;
1023 char *re_err
= re_comp (pattern
);
1026 error (_("Invalid regexp: %s"), re_err
);
1029 /* "0x", a little whitespace, and two hex digits per byte of pointers. */
1030 addr_width
= 4 + (gdbarch_ptr_bit (gdbarch
) / 4);
1032 update_solib_list (from_tty
);
1034 /* ui_out_emit_table table_emitter needs to know the number of rows,
1035 so we need to make two passes over the libs. */
1038 for (struct so_list
*so
: current_program_space
->solibs ())
1042 if (pattern
&& ! re_exec (so
->so_name
))
1049 ui_out_emit_table
table_emitter (uiout
, 4, nr_libs
, "SharedLibraryTable");
1051 /* The "- 1" is because ui_out adds one space between columns. */
1052 uiout
->table_header (addr_width
- 1, ui_left
, "from", "From");
1053 uiout
->table_header (addr_width
- 1, ui_left
, "to", "To");
1054 uiout
->table_header (12 - 1, ui_left
, "syms-read", "Syms Read");
1055 uiout
->table_header (0, ui_noalign
, "name", "Shared Object Library");
1057 uiout
->table_body ();
1059 for (struct so_list
*so
: current_program_space
->solibs ())
1061 if (! so
->so_name
[0])
1063 if (pattern
&& ! re_exec (so
->so_name
))
1066 ui_out_emit_tuple
tuple_emitter (uiout
, "lib");
1068 if (so
->addr_high
!= 0)
1070 uiout
->field_core_addr ("from", gdbarch
, so
->addr_low
);
1071 uiout
->field_core_addr ("to", gdbarch
, so
->addr_high
);
1075 uiout
->field_skip ("from");
1076 uiout
->field_skip ("to");
1079 if (! top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ()
1080 && so
->symbols_loaded
1081 && !objfile_has_symbols (so
->objfile
))
1083 so_missing_debug_info
= true;
1084 uiout
->field_string ("syms-read", "Yes (*)");
1087 uiout
->field_string ("syms-read", so
->symbols_loaded
? "Yes" : "No");
1089 uiout
->field_string ("name", so
->so_name
, file_name_style
.style ());
1098 uiout
->message (_("No shared libraries matched.\n"));
1100 uiout
->message (_("No shared libraries loaded at this time.\n"));
1104 if (so_missing_debug_info
)
1105 uiout
->message (_("(*): Shared library is missing "
1106 "debugging information.\n"));
1113 solib_contains_address_p (const struct so_list
*const solib
,
1116 if (solib
->sections
== nullptr)
1119 for (target_section
&p
: *solib
->sections
)
1120 if (p
.addr
<= address
&& address
< p
.endaddr
)
1126 /* If ADDRESS is in a shared lib in program space PSPACE, return its
1129 Provides a hook for other gdb routines to discover whether or not a
1130 particular address is within the mapped address space of a shared
1133 For example, this routine is called at one point to disable
1134 breakpoints which are in shared libraries that are not currently
1138 solib_name_from_address (struct program_space
*pspace
, CORE_ADDR address
)
1140 struct so_list
*so
= NULL
;
1142 for (so
= pspace
->so_list
; so
; so
= so
->next
)
1143 if (solib_contains_address_p (so
, address
))
1144 return (so
->so_name
);
1152 solib_keep_data_in_core (CORE_ADDR vaddr
, unsigned long size
)
1154 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1156 if (ops
->keep_data_in_core
)
1157 return ops
->keep_data_in_core (vaddr
, size
) != 0;
1162 /* Called by free_all_symtabs */
1167 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1169 disable_breakpoints_in_shlibs ();
1171 while (current_program_space
->so_list
)
1173 struct so_list
*so
= current_program_space
->so_list
;
1175 current_program_space
->so_list
= so
->next
;
1176 gdb::observers::solib_unloaded
.notify (so
);
1177 remove_target_sections (so
);
1181 ops
->clear_solib ();
1184 /* Shared library startup support. When GDB starts up the inferior,
1185 it nurses it along (through the shell) until it is ready to execute
1186 its first instruction. At this point, this function gets
1190 solib_create_inferior_hook (int from_tty
)
1192 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1194 ops
->solib_create_inferior_hook (from_tty
);
1200 in_solib_dynsym_resolve_code (CORE_ADDR pc
)
1202 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1204 return ops
->in_dynsym_resolve_code (pc
) != 0;
1207 /* Implements the "sharedlibrary" command. */
1210 sharedlibrary_command (const char *args
, int from_tty
)
1213 solib_add (args
, from_tty
, 1);
1216 /* Implements the command "nosharedlibrary", which discards symbols
1217 that have been auto-loaded from shared libraries. Symbols from
1218 shared libraries that were added by explicit request of the user
1219 are not discarded. Also called from remote.c. */
1222 no_shared_libraries (const char *ignored
, int from_tty
)
1224 /* The order of the two routines below is important: clear_solib notifies
1225 the solib_unloaded observers, and some of these observers might need
1226 access to their associated objfiles. Therefore, we can not purge the
1227 solibs' objfiles before clear_solib has been called. */
1230 objfile_purge_solibs ();
1236 update_solib_breakpoints (void)
1238 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1240 if (ops
->update_breakpoints
!= NULL
)
1241 ops
->update_breakpoints ();
1247 handle_solib_event (void)
1249 const struct target_so_ops
*ops
= solib_ops (target_gdbarch ());
1251 if (ops
->handle_event
!= NULL
)
1252 ops
->handle_event ();
1254 clear_program_space_solib_cache (current_inferior ()->pspace
);
1256 /* Check for any newly added shared libraries if we're supposed to
1257 be adding them automatically. Switch terminal for any messages
1258 produced by breakpoint_re_set. */
1259 target_terminal::ours_for_output ();
1260 solib_add (NULL
, 0, auto_solib_add
);
1261 target_terminal::inferior ();
1264 /* Reload shared libraries, but avoid reloading the same symbol file
1265 we already have loaded. */
1268 reload_shared_libraries_1 (int from_tty
)
1270 if (print_symbol_loading_p (from_tty
, 0, 0))
1271 printf_unfiltered (_("Loading symbols for shared libraries.\n"));
1273 for (struct so_list
*so
: current_program_space
->solibs ())
1275 const char *found_pathname
= NULL
;
1276 bool was_loaded
= so
->symbols_loaded
!= 0;
1277 symfile_add_flags add_flags
= SYMFILE_DEFER_BP_RESET
;
1280 add_flags
|= SYMFILE_VERBOSE
;
1282 gdb::unique_xmalloc_ptr
<char> filename
1283 (tilde_expand (so
->so_original_name
));
1284 gdb_bfd_ref_ptr
abfd (solib_bfd_open (filename
.get ()));
1286 found_pathname
= bfd_get_filename (abfd
.get ());
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 so
->objfile
->unlink ();
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 bool got_error
= false;
1311 solib_map_sections (so
);
1314 catch (const gdb_exception_error
&e
)
1316 exception_fprintf (gdb_stderr
, e
,
1317 _("Error while mapping "
1318 "shared library sections:\n"));
1323 && (auto_solib_add
|| was_loaded
|| libpthread_solib_p (so
)))
1324 solib_read_symbols (so
, add_flags
);
1330 reload_shared_libraries (const char *ignored
, int from_tty
,
1331 struct cmd_list_element
*e
)
1333 const struct target_so_ops
*ops
;
1335 reload_shared_libraries_1 (from_tty
);
1337 ops
= solib_ops (target_gdbarch ());
1339 /* Creating inferior hooks here has two purposes. First, if we reload
1340 shared libraries then the address of solib breakpoint we've computed
1341 previously might be no longer valid. For example, if we forgot to set
1342 solib-absolute-prefix and are setting it right now, then the previous
1343 breakpoint address is plain wrong. Second, installing solib hooks
1344 also implicitly figures were ld.so is and loads symbols for it.
1345 Absent this call, if we've just connected to a target and set
1346 solib-absolute-prefix or solib-search-path, we'll lose all information
1348 if (target_has_execution ())
1350 /* Reset or free private data structures not associated with
1352 ops
->clear_solib ();
1354 /* Remove any previous solib event breakpoint. This is usually
1355 done in common code, at breakpoint_init_inferior time, but
1356 we're not really starting up the inferior here. */
1357 remove_solib_event_breakpoints ();
1359 solib_create_inferior_hook (from_tty
);
1362 /* Sometimes the platform-specific hook loads initial shared
1363 libraries, and sometimes it doesn't. If it doesn't FROM_TTY will be
1364 incorrectly 0 but such solib targets should be fixed anyway. If we
1365 made all the inferior hook methods consistent, this call could be
1366 removed. Call it only after the solib target has been initialized by
1367 solib_create_inferior_hook. */
1369 solib_add (NULL
, 0, auto_solib_add
);
1371 breakpoint_re_set ();
1373 /* We may have loaded or unloaded debug info for some (or all)
1374 shared libraries. However, frames may still reference them. For
1375 example, a frame's unwinder might still point at DWARF FDE
1376 structures that are now freed. Also, getting new symbols may
1377 change our opinion about what is frameless. */
1378 reinit_frame_cache ();
1381 /* Wrapper for reload_shared_libraries that replaces "remote:"
1382 at the start of gdb_sysroot with "target:". */
1385 gdb_sysroot_changed (const char *ignored
, int from_tty
,
1386 struct cmd_list_element
*e
)
1388 const char *old_prefix
= "remote:";
1389 const char *new_prefix
= TARGET_SYSROOT_PREFIX
;
1391 if (startswith (gdb_sysroot
, old_prefix
))
1393 static bool warning_issued
= false;
1395 gdb_assert (strlen (old_prefix
) == strlen (new_prefix
));
1396 memcpy (gdb_sysroot
, new_prefix
, strlen (new_prefix
));
1398 if (!warning_issued
)
1400 warning (_("\"%s\" is deprecated, use \"%s\" instead."),
1401 old_prefix
, new_prefix
);
1402 warning (_("sysroot set to \"%s\"."), gdb_sysroot
);
1404 warning_issued
= true;
1408 reload_shared_libraries (ignored
, from_tty
, e
);
1412 show_auto_solib_add (struct ui_file
*file
, int from_tty
,
1413 struct cmd_list_element
*c
, const char *value
)
1415 fprintf_filtered (file
, _("Autoloading of shared library symbols is %s.\n"),
1420 /* Lookup the value for a specific symbol from dynamic symbol table. Look
1421 up symbol from ABFD. MATCH_SYM is a callback function to determine
1422 whether to pick up a symbol. DATA is the input of this callback
1423 function. Return NULL if symbol is not found. */
1426 gdb_bfd_lookup_symbol_from_symtab (bfd
*abfd
,
1427 int (*match_sym
) (const asymbol
*,
1431 long storage_needed
= bfd_get_symtab_upper_bound (abfd
);
1432 CORE_ADDR symaddr
= 0;
1434 if (storage_needed
> 0)
1438 gdb::def_vector
<asymbol
*> storage (storage_needed
/ sizeof (asymbol
*));
1439 asymbol
**symbol_table
= storage
.data ();
1440 unsigned int number_of_symbols
=
1441 bfd_canonicalize_symtab (abfd
, symbol_table
);
1443 for (i
= 0; i
< number_of_symbols
; i
++)
1445 asymbol
*sym
= *symbol_table
++;
1447 if (match_sym (sym
, data
))
1449 struct gdbarch
*gdbarch
= target_gdbarch ();
1450 symaddr
= sym
->value
;
1452 /* Some ELF targets fiddle with addresses of symbols they
1453 consider special. They use minimal symbols to do that
1454 and this is needed for correct breakpoint placement,
1455 but we do not have full data here to build a complete
1456 minimal symbol, so just set the address and let the
1457 targets cope with that. */
1458 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
1459 && gdbarch_elf_make_msymbol_special_p (gdbarch
))
1461 struct minimal_symbol msym
{};
1463 SET_MSYMBOL_VALUE_ADDRESS (&msym
, symaddr
);
1464 gdbarch_elf_make_msymbol_special (gdbarch
, sym
, &msym
);
1465 symaddr
= MSYMBOL_VALUE_RAW_ADDRESS (&msym
);
1468 /* BFD symbols are section relative. */
1469 symaddr
+= sym
->section
->vma
;
1478 /* Lookup the value for a specific symbol from symbol table. Look up symbol
1479 from ABFD. MATCH_SYM is a callback function to determine whether to pick
1480 up a symbol. DATA is the input of this callback function. Return NULL
1481 if symbol is not found. */
1484 bfd_lookup_symbol_from_dyn_symtab (bfd
*abfd
,
1485 int (*match_sym
) (const asymbol
*,
1489 long storage_needed
= bfd_get_dynamic_symtab_upper_bound (abfd
);
1490 CORE_ADDR symaddr
= 0;
1492 if (storage_needed
> 0)
1495 gdb::def_vector
<asymbol
*> storage (storage_needed
/ sizeof (asymbol
*));
1496 asymbol
**symbol_table
= storage
.data ();
1497 unsigned int number_of_symbols
=
1498 bfd_canonicalize_dynamic_symtab (abfd
, symbol_table
);
1500 for (i
= 0; i
< number_of_symbols
; i
++)
1502 asymbol
*sym
= *symbol_table
++;
1504 if (match_sym (sym
, data
))
1506 /* BFD symbols are section relative. */
1507 symaddr
= sym
->value
+ sym
->section
->vma
;
1515 /* Lookup the value for a specific symbol from symbol table and dynamic
1516 symbol table. Look up symbol from ABFD. MATCH_SYM is a callback
1517 function to determine whether to pick up a symbol. DATA is the
1518 input of this callback function. Return NULL if symbol is not
1522 gdb_bfd_lookup_symbol (bfd
*abfd
,
1523 int (*match_sym
) (const asymbol
*, const void *),
1526 CORE_ADDR symaddr
= gdb_bfd_lookup_symbol_from_symtab (abfd
, match_sym
, data
);
1528 /* On FreeBSD, the dynamic linker is stripped by default. So we'll
1529 have to check the dynamic string table too. */
1531 symaddr
= bfd_lookup_symbol_from_dyn_symtab (abfd
, match_sym
, data
);
1536 /* The shared library list may contain user-loaded object files that
1537 can be removed out-of-band by the user. So upon notification of
1538 free_objfile remove all references to any user-loaded file that is
1539 about to be freed. */
1542 remove_user_added_objfile (struct objfile
*objfile
)
1544 if (objfile
!= 0 && objfile
->flags
& OBJF_USERLOADED
)
1546 for (struct so_list
*so
: current_program_space
->solibs ())
1547 if (so
->objfile
== objfile
)
1552 void _initialize_solib ();
1554 _initialize_solib ()
1556 solib_data
= gdbarch_data_register_pre_init (solib_init
);
1558 gdb::observers::free_objfile
.attach (remove_user_added_objfile
);
1560 add_com ("sharedlibrary", class_files
, sharedlibrary_command
,
1561 _("Load shared object library symbols for files matching REGEXP."));
1562 add_info ("sharedlibrary", info_sharedlibrary_command
,
1563 _("Status of loaded shared object libraries."));
1564 add_info_alias ("dll", "sharedlibrary", 1);
1565 add_com ("nosharedlibrary", class_files
, no_shared_libraries
,
1566 _("Unload all shared object library symbols."));
1568 add_setshow_boolean_cmd ("auto-solib-add", class_support
,
1569 &auto_solib_add
, _("\
1570 Set autoloading of shared library symbols."), _("\
1571 Show autoloading of shared library symbols."), _("\
1572 If \"on\", symbols from all shared object libraries will be loaded\n\
1573 automatically when the inferior begins execution, when the dynamic linker\n\
1574 informs gdb that a new library has been loaded, or when attaching to the\n\
1575 inferior. Otherwise, symbols must be loaded manually, using \
1578 show_auto_solib_add
,
1579 &setlist
, &showlist
);
1581 add_setshow_optional_filename_cmd ("sysroot", class_support
,
1583 Set an alternate system root."), _("\
1584 Show the current system root."), _("\
1585 The system root is used to load absolute shared library symbol files.\n\
1586 For other (relative) files, you can add directories using\n\
1587 `set solib-search-path'."),
1588 gdb_sysroot_changed
,
1590 &setlist
, &showlist
);
1592 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support
, 0,
1594 add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support
, 0,
1597 add_setshow_optional_filename_cmd ("solib-search-path", class_support
,
1598 &solib_search_path
, _("\
1599 Set the search path for loading non-absolute shared library symbol files."),
1601 Show the search path for loading non-absolute shared library symbol files."),
1603 This takes precedence over the environment variables \
1604 PATH and LD_LIBRARY_PATH."),
1605 reload_shared_libraries
,
1606 show_solib_search_path
,
1607 &setlist
, &showlist
);