gdb: Update my email address in MAINTAINERS
[binutils-gdb.git] / gdb / solib.c
1 /* Handle shared libraries for GDB, the GNU Debugger.
2
3 Copyright (C) 1990-2022 Free Software Foundation, Inc.
4
5 This file is part of GDB.
6
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.
11
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.
16
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/>. */
19
20 #include "defs.h"
21
22 #include <sys/types.h>
23 #include <fcntl.h>
24 #include "symtab.h"
25 #include "bfd.h"
26 #include "build-id.h"
27 #include "symfile.h"
28 #include "objfiles.h"
29 #include "gdbcore.h"
30 #include "command.h"
31 #include "target.h"
32 #include "frame.h"
33 #include "gdbsupport/gdb_regex.h"
34 #include "inferior.h"
35 #include "gdbsupport/environ.h"
36 #include "language.h"
37 #include "gdbcmd.h"
38 #include "completer.h"
39 #include "elf/external.h"
40 #include "elf/common.h"
41 #include "filenames.h" /* for DOSish file names */
42 #include "exec.h"
43 #include "solist.h"
44 #include "observable.h"
45 #include "readline/tilde.h"
46 #include "remote.h"
47 #include "solib.h"
48 #include "interps.h"
49 #include "filesystem.h"
50 #include "gdb_bfd.h"
51 #include "gdbsupport/filestuff.h"
52 #include "gdbsupport/scoped_fd.h"
53 #include "debuginfod-support.h"
54 #include "source.h"
55 #include "cli/cli-style.h"
56 #include "solib-target.h"
57
58 /* See solib.h. */
59
60 bool debug_solib;
61
62 /* If non-empty, this is a search path for loading non-absolute shared library
63 symbol files. This takes precedence over the environment variables PATH
64 and LD_LIBRARY_PATH. */
65 static std::string solib_search_path;
66 static void
67 show_solib_search_path (struct ui_file *file, int from_tty,
68 struct cmd_list_element *c, const char *value)
69 {
70 gdb_printf (file, _("The search path for loading non-absolute "
71 "shared library symbol files is %s.\n"),
72 value);
73 }
74
75 /* Same as HAVE_DOS_BASED_FILE_SYSTEM, but useable as an rvalue. */
76 #if (HAVE_DOS_BASED_FILE_SYSTEM)
77 # define DOS_BASED_FILE_SYSTEM 1
78 #else
79 # define DOS_BASED_FILE_SYSTEM 0
80 #endif
81
82 /* Return the full pathname of a binary file (the main executable or a
83 shared library file), or NULL if not found. If FD is non-NULL, *FD
84 is set to either -1 or an open file handle for the binary file.
85
86 Global variable GDB_SYSROOT is used as a prefix directory
87 to search for binary files if they have an absolute path.
88 If GDB_SYSROOT starts with "target:" and target filesystem
89 is the local filesystem then the "target:" prefix will be
90 stripped before the search starts. This ensures that the
91 same search algorithm is used for local files regardless of
92 whether a "target:" prefix was used.
93
94 Global variable SOLIB_SEARCH_PATH is used as a prefix directory
95 (or set of directories, as in LD_LIBRARY_PATH) to search for all
96 shared libraries if not found in either the sysroot (if set) or
97 the local filesystem. SOLIB_SEARCH_PATH is not used when searching
98 for the main executable.
99
100 Search algorithm:
101 * If a sysroot is set and path is absolute:
102 * Search for sysroot/path.
103 * else
104 * Look for it literally (unmodified).
105 * If IS_SOLIB is non-zero:
106 * Look in SOLIB_SEARCH_PATH.
107 * If available, use target defined search function.
108 * If NO sysroot is set, perform the following two searches:
109 * Look in inferior's $PATH.
110 * If IS_SOLIB is non-zero:
111 * Look in inferior's $LD_LIBRARY_PATH.
112 *
113 * The last check avoids doing this search when targeting remote
114 * machines since a sysroot will almost always be set.
115 */
116
117 static gdb::unique_xmalloc_ptr<char>
118 solib_find_1 (const char *in_pathname, int *fd, bool is_solib)
119 {
120 const struct target_so_ops *ops = gdbarch_so_ops (target_gdbarch ());
121 int found_file = -1;
122 gdb::unique_xmalloc_ptr<char> temp_pathname;
123 const char *fskind = effective_target_file_system_kind ();
124 const char *sysroot = gdb_sysroot.c_str ();
125 int prefix_len, orig_prefix_len;
126
127 /* If the absolute prefix starts with "target:" but the filesystem
128 accessed by the target_fileio_* methods is the local filesystem
129 then we strip the "target:" prefix now and work with the local
130 filesystem. This ensures that the same search algorithm is used
131 for all local files regardless of whether a "target:" prefix was
132 used. */
133 if (is_target_filename (sysroot) && target_filesystem_is_local ())
134 sysroot += strlen (TARGET_SYSROOT_PREFIX);
135
136 /* Strip any trailing slashes from the absolute prefix. */
137 prefix_len = orig_prefix_len = strlen (sysroot);
138
139 while (prefix_len > 0 && IS_DIR_SEPARATOR (sysroot[prefix_len - 1]))
140 prefix_len--;
141
142 std::string sysroot_holder;
143 if (prefix_len == 0)
144 sysroot = NULL;
145 else if (prefix_len != orig_prefix_len)
146 {
147 sysroot_holder = std::string (sysroot, prefix_len);
148 sysroot = sysroot_holder.c_str ();
149 }
150
151 /* If we're on a non-DOS-based system, backslashes won't be
152 understood as directory separator, so, convert them to forward
153 slashes, iff we're supposed to handle DOS-based file system
154 semantics for target paths. */
155 if (!DOS_BASED_FILE_SYSTEM && fskind == file_system_kind_dos_based)
156 {
157 char *p;
158
159 /* Avoid clobbering our input. */
160 p = (char *) alloca (strlen (in_pathname) + 1);
161 strcpy (p, in_pathname);
162 in_pathname = p;
163
164 for (; *p; p++)
165 {
166 if (*p == '\\')
167 *p = '/';
168 }
169 }
170
171 /* Note, we're interested in IS_TARGET_ABSOLUTE_PATH, not
172 IS_ABSOLUTE_PATH. The latter is for host paths only, while
173 IN_PATHNAME is a target path. For example, if we're supposed to
174 be handling DOS-like semantics we want to consider a
175 'c:/foo/bar.dll' path as an absolute path, even on a Unix box.
176 With such a path, before giving up on the sysroot, we'll try:
177
178 1st attempt, c:/foo/bar.dll ==> /sysroot/c:/foo/bar.dll
179 2nd attempt, c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll
180 3rd attempt, c:/foo/bar.dll ==> /sysroot/foo/bar.dll
181 */
182
183 if (!IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname) || sysroot == NULL)
184 temp_pathname.reset (xstrdup (in_pathname));
185 else
186 {
187 bool need_dir_separator;
188
189 /* Concatenate the sysroot and the target reported filename. We
190 may need to glue them with a directory separator. Cases to
191 consider:
192
193 | sysroot | separator | in_pathname |
194 |-----------------+-----------+----------------|
195 | /some/dir | / | c:/foo/bar.dll |
196 | /some/dir | | /foo/bar.dll |
197 | target: | | c:/foo/bar.dll |
198 | target: | | /foo/bar.dll |
199 | target:some/dir | / | c:/foo/bar.dll |
200 | target:some/dir | | /foo/bar.dll |
201
202 IOW, we don't need to add a separator if IN_PATHNAME already
203 has one, or when the sysroot is exactly "target:".
204 There's no need to check for drive spec explicitly, as we only
205 get here if IN_PATHNAME is considered an absolute path. */
206 need_dir_separator = !(IS_DIR_SEPARATOR (in_pathname[0])
207 || strcmp (TARGET_SYSROOT_PREFIX, sysroot) == 0);
208
209 /* Cat the prefixed pathname together. */
210 temp_pathname.reset (concat (sysroot,
211 need_dir_separator ? SLASH_STRING : "",
212 in_pathname, (char *) NULL));
213 }
214
215 /* Handle files to be accessed via the target. */
216 if (is_target_filename (temp_pathname.get ()))
217 {
218 if (fd != NULL)
219 *fd = -1;
220 return temp_pathname;
221 }
222
223 /* Now see if we can open it. */
224 found_file = gdb_open_cloexec (temp_pathname.get (),
225 O_RDONLY | O_BINARY, 0).release ();
226
227 /* If the search in gdb_sysroot failed, and the path name has a
228 drive spec (e.g, c:/foo), try stripping ':' from the drive spec,
229 and retrying in the sysroot:
230 c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll. */
231
232 if (found_file < 0
233 && sysroot != NULL
234 && HAS_TARGET_DRIVE_SPEC (fskind, in_pathname))
235 {
236 bool need_dir_separator = !IS_DIR_SEPARATOR (in_pathname[2]);
237 char drive[2] = { in_pathname[0], '\0' };
238
239 temp_pathname.reset (concat (sysroot,
240 SLASH_STRING,
241 drive,
242 need_dir_separator ? SLASH_STRING : "",
243 in_pathname + 2, (char *) NULL));
244
245 found_file = gdb_open_cloexec (temp_pathname.get (),
246 O_RDONLY | O_BINARY, 0).release ();
247 if (found_file < 0)
248 {
249 /* If the search in gdb_sysroot still failed, try fully
250 stripping the drive spec, and trying once more in the
251 sysroot before giving up.
252
253 c:/foo/bar.dll ==> /sysroot/foo/bar.dll. */
254
255 temp_pathname.reset (concat (sysroot,
256 need_dir_separator ? SLASH_STRING : "",
257 in_pathname + 2, (char *) NULL));
258
259 found_file = gdb_open_cloexec (temp_pathname.get (),
260 O_RDONLY | O_BINARY, 0).release ();
261 }
262 }
263
264 /* We try to find the library in various ways. After each attempt,
265 either found_file >= 0 and temp_pathname is a malloc'd string, or
266 found_file < 0 and temp_pathname does not point to storage that
267 needs to be freed. */
268
269 if (found_file < 0)
270 temp_pathname.reset (NULL);
271
272 /* If the search in gdb_sysroot failed, and the path name is
273 absolute at this point, make it relative. (openp will try and open the
274 file according to its absolute path otherwise, which is not what we want.)
275 Affects subsequent searches for this solib. */
276 if (found_file < 0 && IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname))
277 {
278 /* First, get rid of any drive letters etc. */
279 while (!IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
280 in_pathname++;
281
282 /* Next, get rid of all leading dir separators. */
283 while (IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
284 in_pathname++;
285 }
286
287 /* If not found, and we're looking for a solib, search the
288 solib_search_path (if any). */
289 if (is_solib && found_file < 0 && !solib_search_path.empty ())
290 found_file = openp (solib_search_path.c_str (),
291 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
292 in_pathname, O_RDONLY | O_BINARY, &temp_pathname);
293
294 /* If not found, and we're looking for a solib, next search the
295 solib_search_path (if any) for the basename only (ignoring the
296 path). This is to allow reading solibs from a path that differs
297 from the opened path. */
298 if (is_solib && found_file < 0 && !solib_search_path.empty ())
299 found_file = openp (solib_search_path.c_str (),
300 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
301 target_lbasename (fskind, in_pathname),
302 O_RDONLY | O_BINARY, &temp_pathname);
303
304 /* If not found, and we're looking for a solib, try to use target
305 supplied solib search method. */
306 if (is_solib && found_file < 0 && ops->find_and_open_solib)
307 found_file = ops->find_and_open_solib (in_pathname, O_RDONLY | O_BINARY,
308 &temp_pathname);
309
310 /* If not found, next search the inferior's $PATH environment variable. */
311 if (found_file < 0 && sysroot == NULL)
312 found_file = openp (current_inferior ()->environment.get ("PATH"),
313 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
314 O_RDONLY | O_BINARY, &temp_pathname);
315
316 /* If not found, and we're looking for a solib, next search the
317 inferior's $LD_LIBRARY_PATH environment variable. */
318 if (is_solib && found_file < 0 && sysroot == NULL)
319 found_file = openp (current_inferior ()->environment.get
320 ("LD_LIBRARY_PATH"),
321 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
322 O_RDONLY | O_BINARY, &temp_pathname);
323
324 if (fd == NULL)
325 {
326 if (found_file >= 0)
327 close (found_file);
328 }
329 else
330 *fd = found_file;
331
332 return temp_pathname;
333 }
334
335 /* Return the full pathname of the main executable, or NULL if not
336 found. If FD is non-NULL, *FD is set to either -1 or an open file
337 handle for the main executable. */
338
339 gdb::unique_xmalloc_ptr<char>
340 exec_file_find (const char *in_pathname, int *fd)
341 {
342 gdb::unique_xmalloc_ptr<char> result;
343 const char *fskind = effective_target_file_system_kind ();
344
345 if (in_pathname == NULL)
346 return NULL;
347
348 if (!gdb_sysroot.empty () && IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname))
349 {
350 result = solib_find_1 (in_pathname, fd, false);
351
352 if (result == NULL && fskind == file_system_kind_dos_based)
353 {
354 char *new_pathname;
355
356 new_pathname = (char *) alloca (strlen (in_pathname) + 5);
357 strcpy (new_pathname, in_pathname);
358 strcat (new_pathname, ".exe");
359
360 result = solib_find_1 (new_pathname, fd, false);
361 }
362 }
363 else
364 {
365 /* It's possible we don't have a full path, but rather just a
366 filename. Some targets, such as HP-UX, don't provide the
367 full path, sigh.
368
369 Attempt to qualify the filename against the source path.
370 (If that fails, we'll just fall back on the original
371 filename. Not much more we can do...) */
372
373 if (!source_full_path_of (in_pathname, &result))
374 result.reset (xstrdup (in_pathname));
375 if (fd != NULL)
376 *fd = -1;
377 }
378
379 return result;
380 }
381
382 /* Return the full pathname of a shared library file, or NULL if not
383 found. If FD is non-NULL, *FD is set to either -1 or an open file
384 handle for the shared library.
385
386 The search algorithm used is described in solib_find_1's comment
387 above. */
388
389 gdb::unique_xmalloc_ptr<char>
390 solib_find (const char *in_pathname, int *fd)
391 {
392 const char *solib_symbols_extension
393 = gdbarch_solib_symbols_extension (target_gdbarch ());
394
395 /* If solib_symbols_extension is set, replace the file's
396 extension. */
397 if (solib_symbols_extension != NULL)
398 {
399 const char *p = in_pathname + strlen (in_pathname);
400
401 while (p > in_pathname && *p != '.')
402 p--;
403
404 if (*p == '.')
405 {
406 char *new_pathname;
407
408 new_pathname
409 = (char *) alloca (p - in_pathname + 1
410 + strlen (solib_symbols_extension) + 1);
411 memcpy (new_pathname, in_pathname, p - in_pathname + 1);
412 strcpy (new_pathname + (p - in_pathname) + 1,
413 solib_symbols_extension);
414
415 in_pathname = new_pathname;
416 }
417 }
418
419 return solib_find_1 (in_pathname, fd, true);
420 }
421
422 /* Open and return a BFD for the shared library PATHNAME. If FD is not -1,
423 it is used as file handle to open the file. Throws an error if the file
424 could not be opened. Handles both local and remote file access.
425
426 If unsuccessful, the FD will be closed (unless FD was -1). */
427
428 gdb_bfd_ref_ptr
429 solib_bfd_fopen (const char *pathname, int fd)
430 {
431 gdb_bfd_ref_ptr abfd (gdb_bfd_open (pathname, gnutarget, fd));
432
433 if (abfd != NULL && !gdb_bfd_has_target_filename (abfd.get ()))
434 bfd_set_cacheable (abfd.get (), 1);
435
436 if (abfd == NULL)
437 {
438 /* Arrange to free PATHNAME when the error is thrown. */
439 error (_("Could not open `%s' as an executable file: %s"),
440 pathname, bfd_errmsg (bfd_get_error ()));
441 }
442
443 return abfd;
444 }
445
446 /* Find shared library PATHNAME and open a BFD for it. */
447
448 gdb_bfd_ref_ptr
449 solib_bfd_open (const char *pathname)
450 {
451 int found_file;
452 const struct bfd_arch_info *b;
453
454 /* Search for shared library file. */
455 gdb::unique_xmalloc_ptr<char> found_pathname
456 = solib_find (pathname, &found_file);
457 if (found_pathname == NULL)
458 {
459 /* Return failure if the file could not be found, so that we can
460 accumulate messages about missing libraries. */
461 if (errno == ENOENT)
462 return NULL;
463
464 perror_with_name (pathname);
465 }
466
467 /* Open bfd for shared library. */
468 gdb_bfd_ref_ptr abfd (solib_bfd_fopen (found_pathname.get (), found_file));
469
470 /* Check bfd format. */
471 if (!bfd_check_format (abfd.get (), bfd_object))
472 error (_("`%s': not in executable format: %s"),
473 bfd_get_filename (abfd.get ()), bfd_errmsg (bfd_get_error ()));
474
475 /* Check bfd arch. */
476 b = gdbarch_bfd_arch_info (target_gdbarch ());
477 if (!b->compatible (b, bfd_get_arch_info (abfd.get ())))
478 error (_("`%s': Shared library architecture %s is not compatible "
479 "with target architecture %s."), bfd_get_filename (abfd.get ()),
480 bfd_get_arch_info (abfd.get ())->printable_name,
481 b->printable_name);
482
483 return abfd;
484 }
485
486 /* Mapping of a core file's shared library sonames to their respective
487 build-ids. Added to the registries of core file bfds. */
488
489 typedef std::unordered_map<std::string, std::string> soname_build_id_map;
490
491 /* Key used to associate a soname_build_id_map to a core file bfd. */
492
493 static const struct registry<bfd>::key<soname_build_id_map>
494 cbfd_soname_build_id_data_key;
495
496 /* See solib.h. */
497
498 void
499 set_cbfd_soname_build_id (gdb_bfd_ref_ptr abfd,
500 const char *soname,
501 const bfd_build_id *build_id)
502 {
503 gdb_assert (abfd.get () != nullptr);
504 gdb_assert (soname != nullptr);
505 gdb_assert (build_id != nullptr);
506
507 soname_build_id_map *mapptr = cbfd_soname_build_id_data_key.get (abfd.get ());
508
509 if (mapptr == nullptr)
510 mapptr = cbfd_soname_build_id_data_key.emplace (abfd.get ());
511
512 (*mapptr)[soname] = build_id_to_string (build_id);
513 }
514
515 /* See solib.h. */
516
517 gdb::unique_xmalloc_ptr<char>
518 get_cbfd_soname_build_id (gdb_bfd_ref_ptr abfd, const char *soname)
519 {
520 if (abfd.get () == nullptr || soname == nullptr)
521 return {};
522
523 soname_build_id_map *mapptr
524 = cbfd_soname_build_id_data_key.get (abfd.get ());
525
526 if (mapptr == nullptr)
527 return {};
528
529 auto it = mapptr->find (lbasename (soname));
530 if (it == mapptr->end ())
531 return {};
532
533 return make_unique_xstrdup (it->second.c_str ());
534 }
535
536 /* Given a pointer to one of the shared objects in our list of mapped
537 objects, use the recorded name to open a bfd descriptor for the
538 object, build a section table, relocate all the section addresses
539 by the base address at which the shared object was mapped, and then
540 add the sections to the target's section table.
541
542 FIXME: In most (all?) cases the shared object file name recorded in
543 the dynamic linkage tables will be a fully qualified pathname. For
544 cases where it isn't, do we really mimic the systems search
545 mechanism correctly in the below code (particularly the tilde
546 expansion stuff?). */
547
548 static int
549 solib_map_sections (struct so_list *so)
550 {
551 const struct target_so_ops *ops = gdbarch_so_ops (target_gdbarch ());
552
553 gdb::unique_xmalloc_ptr<char> filename (tilde_expand (so->so_name));
554 gdb_bfd_ref_ptr abfd (ops->bfd_open (filename.get ()));
555 gdb::unique_xmalloc_ptr<char> build_id_hexstr
556 = get_cbfd_soname_build_id (current_program_space->cbfd, so->so_name);
557
558 /* If we already know the build-id of this solib from a core file, verify
559 it matches ABFD's build-id. If there is a mismatch or the solib wasn't
560 found, attempt to query debuginfod for the correct solib. */
561 if (build_id_hexstr.get () != nullptr)
562 {
563 bool mismatch = false;
564
565 if (abfd != nullptr && abfd->build_id != nullptr)
566 {
567 std::string build_id = build_id_to_string (abfd->build_id);
568
569 if (build_id != build_id_hexstr.get ())
570 mismatch = true;
571 }
572 if (abfd == nullptr || mismatch)
573 {
574 scoped_fd fd = debuginfod_exec_query ((const unsigned char*)
575 build_id_hexstr.get (),
576 0, so->so_name, &filename);
577
578 if (fd.get () >= 0)
579 abfd = ops->bfd_open (filename.get ());
580 else if (mismatch)
581 warning (_("Build-id of %ps does not match core file."),
582 styled_string (file_name_style.style (), filename.get ()));
583 }
584 }
585
586 if (abfd == NULL)
587 return 0;
588
589 /* Leave bfd open, core_xfer_memory and "info files" need it. */
590 so->abfd = abfd.release ();
591
592 /* Copy the full path name into so_name, allowing symbol_file_add
593 to find it later. This also affects the =library-loaded GDB/MI
594 event, and in particular the part of that notification providing
595 the library's host-side path. If we let the target dictate
596 that objfile's path, and the target is different from the host,
597 GDB/MI will not provide the correct host-side path. */
598 if (strlen (bfd_get_filename (so->abfd)) >= SO_NAME_MAX_PATH_SIZE)
599 error (_("Shared library file name is too long."));
600 strcpy (so->so_name, bfd_get_filename (so->abfd));
601
602 if (so->sections == nullptr)
603 so->sections = new target_section_table;
604 *so->sections = build_section_table (so->abfd);
605
606 for (target_section &p : *so->sections)
607 {
608 /* Relocate the section binding addresses as recorded in the shared
609 object's file by the base address to which the object was actually
610 mapped. */
611 ops->relocate_section_addresses (so, &p);
612
613 /* If the target didn't provide information about the address
614 range of the shared object, assume we want the location of
615 the .text section. */
616 if (so->addr_low == 0 && so->addr_high == 0
617 && strcmp (p.the_bfd_section->name, ".text") == 0)
618 {
619 so->addr_low = p.addr;
620 so->addr_high = p.endaddr;
621 }
622 }
623
624 /* Add the shared object's sections to the current set of file
625 section tables. Do this immediately after mapping the object so
626 that later nodes in the list can query this object, as is needed
627 in solib-osf.c. */
628 current_program_space->add_target_sections (so, *so->sections);
629
630 return 1;
631 }
632
633 /* Free symbol-file related contents of SO and reset for possible reloading
634 of SO. If we have opened a BFD for SO, close it. If we have placed SO's
635 sections in some target's section table, the caller is responsible for
636 removing them.
637
638 This function doesn't mess with objfiles at all. If there is an
639 objfile associated with SO that needs to be removed, the caller is
640 responsible for taking care of that. */
641
642 static void
643 clear_so (struct so_list *so)
644 {
645 const struct target_so_ops *ops = gdbarch_so_ops (target_gdbarch ());
646
647 delete so->sections;
648 so->sections = NULL;
649
650 gdb_bfd_unref (so->abfd);
651 so->abfd = NULL;
652
653 /* Our caller closed the objfile, possibly via objfile_purge_solibs. */
654 so->symbols_loaded = 0;
655 so->objfile = NULL;
656
657 so->addr_low = so->addr_high = 0;
658
659 /* Restore the target-supplied file name. SO_NAME may be the path
660 of the symbol file. */
661 strcpy (so->so_name, so->so_original_name);
662
663 /* Do the same for target-specific data. */
664 if (ops->clear_so != NULL)
665 ops->clear_so (so);
666 }
667
668 /* Free the storage associated with the `struct so_list' object SO.
669 If we have opened a BFD for SO, close it.
670
671 The caller is responsible for removing SO from whatever list it is
672 a member of. If we have placed SO's sections in some target's
673 section table, the caller is responsible for removing them.
674
675 This function doesn't mess with objfiles at all. If there is an
676 objfile associated with SO that needs to be removed, the caller is
677 responsible for taking care of that. */
678
679 void
680 free_so (struct so_list *so)
681 {
682 const struct target_so_ops *ops = gdbarch_so_ops (target_gdbarch ());
683
684 clear_so (so);
685 ops->free_so (so);
686
687 xfree (so);
688 }
689
690
691 /* Read in symbols for shared object SO. If SYMFILE_VERBOSE is set in FLAGS,
692 be chatty about it. Return true if any symbols were actually loaded. */
693
694 bool
695 solib_read_symbols (struct so_list *so, symfile_add_flags flags)
696 {
697 if (so->symbols_loaded)
698 {
699 /* If needed, we've already warned in our caller. */
700 }
701 else if (so->abfd == NULL)
702 {
703 /* We've already warned about this library, when trying to open
704 it. */
705 }
706 else
707 {
708
709 flags |= current_inferior ()->symfile_flags;
710
711 try
712 {
713 /* Have we already loaded this shared object? */
714 so->objfile = nullptr;
715 for (objfile *objfile : current_program_space->objfiles ())
716 {
717 if (filename_cmp (objfile_name (objfile), so->so_name) == 0
718 && objfile->addr_low == so->addr_low)
719 {
720 so->objfile = objfile;
721 break;
722 }
723 }
724 if (so->objfile == NULL)
725 {
726 section_addr_info sap
727 = build_section_addr_info_from_section_table (*so->sections);
728 gdb_bfd_ref_ptr tmp_bfd
729 (gdb_bfd_ref_ptr::new_reference (so->abfd));
730 so->objfile = symbol_file_add_from_bfd (tmp_bfd, so->so_name,
731 flags, &sap,
732 OBJF_SHARED, NULL);
733 so->objfile->addr_low = so->addr_low;
734 }
735
736 so->symbols_loaded = 1;
737 }
738 catch (const gdb_exception_error &e)
739 {
740 exception_fprintf (gdb_stderr, e, _("Error while reading shared"
741 " library symbols for %s:\n"),
742 so->so_name);
743 }
744
745 return true;
746 }
747
748 return false;
749 }
750
751 /* Return true if KNOWN->objfile is used by any other so_list object
752 in the list of shared libraries. Return false otherwise. */
753
754 static bool
755 solib_used (const struct so_list *const known)
756 {
757 for (const struct so_list *pivot : current_program_space->solibs ())
758 if (pivot != known && pivot->objfile == known->objfile)
759 return true;
760 return false;
761 }
762
763 /* See solib.h. */
764
765 void
766 update_solib_list (int from_tty)
767 {
768 const struct target_so_ops *ops = gdbarch_so_ops (target_gdbarch ());
769 struct so_list *inferior = ops->current_sos();
770 struct so_list *gdb, **gdb_link;
771
772 /* We can reach here due to changing solib-search-path or the
773 sysroot, before having any inferior. */
774 if (target_has_execution () && inferior_ptid != null_ptid)
775 {
776 struct inferior *inf = current_inferior ();
777
778 /* If we are attaching to a running process for which we
779 have not opened a symbol file, we may be able to get its
780 symbols now! */
781 if (inf->attach_flag
782 && current_program_space->symfile_object_file == NULL)
783 {
784 try
785 {
786 ops->open_symbol_file_object (from_tty);
787 }
788 catch (const gdb_exception &ex)
789 {
790 exception_fprintf (gdb_stderr, ex,
791 "Error reading attached "
792 "process's symbol file.\n");
793 }
794 }
795 }
796
797 /* GDB and the inferior's dynamic linker each maintain their own
798 list of currently loaded shared objects; we want to bring the
799 former in sync with the latter. Scan both lists, seeing which
800 shared objects appear where. There are three cases:
801
802 - A shared object appears on both lists. This means that GDB
803 knows about it already, and it's still loaded in the inferior.
804 Nothing needs to happen.
805
806 - A shared object appears only on GDB's list. This means that
807 the inferior has unloaded it. We should remove the shared
808 object from GDB's tables.
809
810 - A shared object appears only on the inferior's list. This
811 means that it's just been loaded. We should add it to GDB's
812 tables.
813
814 So we walk GDB's list, checking each entry to see if it appears
815 in the inferior's list too. If it does, no action is needed, and
816 we remove it from the inferior's list. If it doesn't, the
817 inferior has unloaded it, and we remove it from GDB's list. By
818 the time we're done walking GDB's list, the inferior's list
819 contains only the new shared objects, which we then add. */
820
821 gdb = current_program_space->so_list;
822 gdb_link = &current_program_space->so_list;
823 while (gdb)
824 {
825 struct so_list *i = inferior;
826 struct so_list **i_link = &inferior;
827
828 /* Check to see whether the shared object *gdb also appears in
829 the inferior's current list. */
830 while (i)
831 {
832 if (ops->same)
833 {
834 if (ops->same (gdb, i))
835 break;
836 }
837 else
838 {
839 if (! filename_cmp (gdb->so_original_name, i->so_original_name))
840 break;
841 }
842
843 i_link = &i->next;
844 i = *i_link;
845 }
846
847 /* If the shared object appears on the inferior's list too, then
848 it's still loaded, so we don't need to do anything. Delete
849 it from the inferior's list, and leave it on GDB's list. */
850 if (i)
851 {
852 *i_link = i->next;
853 free_so (i);
854 gdb_link = &gdb->next;
855 gdb = *gdb_link;
856 }
857
858 /* If it's not on the inferior's list, remove it from GDB's tables. */
859 else
860 {
861 /* Notify any observer that the shared object has been
862 unloaded before we remove it from GDB's tables. */
863 gdb::observers::solib_unloaded.notify (gdb);
864
865 current_program_space->deleted_solibs.push_back (gdb->so_name);
866
867 *gdb_link = gdb->next;
868
869 /* Unless the user loaded it explicitly, free SO's objfile. */
870 if (gdb->objfile && ! (gdb->objfile->flags & OBJF_USERLOADED)
871 && !solib_used (gdb))
872 gdb->objfile->unlink ();
873
874 /* Some targets' section tables might be referring to
875 sections from so->abfd; remove them. */
876 current_program_space->remove_target_sections (gdb);
877
878 free_so (gdb);
879 gdb = *gdb_link;
880 }
881 }
882
883 /* Now the inferior's list contains only shared objects that don't
884 appear in GDB's list --- those that are newly loaded. Add them
885 to GDB's shared object list. */
886 if (inferior)
887 {
888 int not_found = 0;
889 const char *not_found_filename = NULL;
890
891 struct so_list *i;
892
893 /* Add the new shared objects to GDB's list. */
894 *gdb_link = inferior;
895
896 /* Fill in the rest of each of the `struct so_list' nodes. */
897 for (i = inferior; i; i = i->next)
898 {
899
900 i->pspace = current_program_space;
901 current_program_space->added_solibs.push_back (i);
902
903 try
904 {
905 /* Fill in the rest of the `struct so_list' node. */
906 if (!solib_map_sections (i))
907 {
908 not_found++;
909 if (not_found_filename == NULL)
910 not_found_filename = i->so_original_name;
911 }
912 }
913
914 catch (const gdb_exception_error &e)
915 {
916 exception_fprintf (gdb_stderr, e,
917 _("Error while mapping shared "
918 "library sections:\n"));
919 }
920
921 /* Notify any observer that the shared object has been
922 loaded now that we've added it to GDB's tables. */
923 gdb::observers::solib_loaded.notify (i);
924 }
925
926 /* If a library was not found, issue an appropriate warning
927 message. We have to use a single call to warning in case the
928 front end does something special with warnings, e.g., pop up
929 a dialog box. It Would Be Nice if we could get a "warning: "
930 prefix on each line in the CLI front end, though - it doesn't
931 stand out well. */
932
933 if (not_found == 1)
934 warning (_("Could not load shared library symbols for %s.\n"
935 "Do you need \"set solib-search-path\" "
936 "or \"set sysroot\"?"),
937 not_found_filename);
938 else if (not_found > 1)
939 warning (_("\
940 Could not load shared library symbols for %d libraries, e.g. %s.\n\
941 Use the \"info sharedlibrary\" command to see the complete listing.\n\
942 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
943 not_found, not_found_filename);
944 }
945 }
946
947
948 /* Return non-zero if NAME is the libpthread shared library.
949
950 Uses a fairly simplistic heuristic approach where we check
951 the file name against "/libpthread". This can lead to false
952 positives, but this should be good enough in practice.
953
954 As of glibc-2.34, functions formerly residing in libpthread have
955 been moved to libc, so "/libc." needs to be checked too. (Matching
956 the "." will avoid matching libraries such as libcrypt.) */
957
958 bool
959 libpthread_name_p (const char *name)
960 {
961 return (strstr (name, "/libpthread") != NULL
962 || strstr (name, "/libc.") != NULL );
963 }
964
965 /* Return non-zero if SO is the libpthread shared library. */
966
967 static bool
968 libpthread_solib_p (struct so_list *so)
969 {
970 return libpthread_name_p (so->so_name);
971 }
972
973 /* Read in symbolic information for any shared objects whose names
974 match PATTERN. (If we've already read a shared object's symbol
975 info, leave it alone.) If PATTERN is zero, read them all.
976
977 If READSYMS is 0, defer reading symbolic information until later
978 but still do any needed low level processing.
979
980 FROM_TTY is described for update_solib_list, above. */
981
982 void
983 solib_add (const char *pattern, int from_tty, int readsyms)
984 {
985 if (print_symbol_loading_p (from_tty, 0, 0))
986 {
987 if (pattern != NULL)
988 {
989 gdb_printf (_("Loading symbols for shared libraries: %s\n"),
990 pattern);
991 }
992 else
993 gdb_printf (_("Loading symbols for shared libraries.\n"));
994 }
995
996 current_program_space->solib_add_generation++;
997
998 if (pattern)
999 {
1000 char *re_err = re_comp (pattern);
1001
1002 if (re_err)
1003 error (_("Invalid regexp: %s"), re_err);
1004 }
1005
1006 update_solib_list (from_tty);
1007
1008 /* Walk the list of currently loaded shared libraries, and read
1009 symbols for any that match the pattern --- or any whose symbols
1010 aren't already loaded, if no pattern was given. */
1011 {
1012 bool any_matches = false;
1013 bool loaded_any_symbols = false;
1014 symfile_add_flags add_flags = SYMFILE_DEFER_BP_RESET;
1015
1016 if (from_tty)
1017 add_flags |= SYMFILE_VERBOSE;
1018
1019 for (struct so_list *gdb : current_program_space->solibs ())
1020 if (! pattern || re_exec (gdb->so_name))
1021 {
1022 /* Normally, we would read the symbols from that library
1023 only if READSYMS is set. However, we're making a small
1024 exception for the pthread library, because we sometimes
1025 need the library symbols to be loaded in order to provide
1026 thread support (x86-linux for instance). */
1027 const int add_this_solib =
1028 (readsyms || libpthread_solib_p (gdb));
1029
1030 any_matches = true;
1031 if (add_this_solib)
1032 {
1033 if (gdb->symbols_loaded)
1034 {
1035 /* If no pattern was given, be quiet for shared
1036 libraries we have already loaded. */
1037 if (pattern && (from_tty || info_verbose))
1038 gdb_printf (_("Symbols already loaded for %s\n"),
1039 gdb->so_name);
1040 }
1041 else if (solib_read_symbols (gdb, add_flags))
1042 loaded_any_symbols = true;
1043 }
1044 }
1045
1046 if (loaded_any_symbols)
1047 breakpoint_re_set ();
1048
1049 if (from_tty && pattern && ! any_matches)
1050 gdb_printf
1051 ("No loaded shared libraries match the pattern `%s'.\n", pattern);
1052
1053 if (loaded_any_symbols)
1054 {
1055 /* Getting new symbols may change our opinion about what is
1056 frameless. */
1057 reinit_frame_cache ();
1058 }
1059 }
1060 }
1061
1062 /* Implement the "info sharedlibrary" command. Walk through the
1063 shared library list and print information about each attached
1064 library matching PATTERN. If PATTERN is elided, print them
1065 all. */
1066
1067 static void
1068 info_sharedlibrary_command (const char *pattern, int from_tty)
1069 {
1070 bool so_missing_debug_info = false;
1071 int addr_width;
1072 int nr_libs;
1073 struct gdbarch *gdbarch = target_gdbarch ();
1074 struct ui_out *uiout = current_uiout;
1075
1076 if (pattern)
1077 {
1078 char *re_err = re_comp (pattern);
1079
1080 if (re_err)
1081 error (_("Invalid regexp: %s"), re_err);
1082 }
1083
1084 /* "0x", a little whitespace, and two hex digits per byte of pointers. */
1085 addr_width = 4 + (gdbarch_ptr_bit (gdbarch) / 4);
1086
1087 update_solib_list (from_tty);
1088
1089 /* ui_out_emit_table table_emitter needs to know the number of rows,
1090 so we need to make two passes over the libs. */
1091
1092 nr_libs = 0;
1093 for (struct so_list *so : current_program_space->solibs ())
1094 {
1095 if (so->so_name[0])
1096 {
1097 if (pattern && ! re_exec (so->so_name))
1098 continue;
1099 ++nr_libs;
1100 }
1101 }
1102
1103 {
1104 ui_out_emit_table table_emitter (uiout, 4, nr_libs, "SharedLibraryTable");
1105
1106 /* The "- 1" is because ui_out adds one space between columns. */
1107 uiout->table_header (addr_width - 1, ui_left, "from", "From");
1108 uiout->table_header (addr_width - 1, ui_left, "to", "To");
1109 uiout->table_header (12 - 1, ui_left, "syms-read", "Syms Read");
1110 uiout->table_header (0, ui_noalign, "name", "Shared Object Library");
1111
1112 uiout->table_body ();
1113
1114 for (struct so_list *so : current_program_space->solibs ())
1115 {
1116 if (! so->so_name[0])
1117 continue;
1118 if (pattern && ! re_exec (so->so_name))
1119 continue;
1120
1121 ui_out_emit_tuple tuple_emitter (uiout, "lib");
1122
1123 if (so->addr_high != 0)
1124 {
1125 uiout->field_core_addr ("from", gdbarch, so->addr_low);
1126 uiout->field_core_addr ("to", gdbarch, so->addr_high);
1127 }
1128 else
1129 {
1130 uiout->field_skip ("from");
1131 uiout->field_skip ("to");
1132 }
1133
1134 if (! top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ()
1135 && so->symbols_loaded
1136 && !objfile_has_symbols (so->objfile))
1137 {
1138 so_missing_debug_info = true;
1139 uiout->field_string ("syms-read", "Yes (*)");
1140 }
1141 else
1142 uiout->field_string ("syms-read", so->symbols_loaded ? "Yes" : "No");
1143
1144 uiout->field_string ("name", so->so_name, file_name_style.style ());
1145
1146 uiout->text ("\n");
1147 }
1148 }
1149
1150 if (nr_libs == 0)
1151 {
1152 if (pattern)
1153 uiout->message (_("No shared libraries matched.\n"));
1154 else
1155 uiout->message (_("No shared libraries loaded at this time.\n"));
1156 }
1157 else
1158 {
1159 if (so_missing_debug_info)
1160 uiout->message (_("(*): Shared library is missing "
1161 "debugging information.\n"));
1162 }
1163 }
1164
1165 /* See solib.h. */
1166
1167 bool
1168 solib_contains_address_p (const struct so_list *const solib,
1169 CORE_ADDR address)
1170 {
1171 if (solib->sections == nullptr)
1172 return false;
1173
1174 for (target_section &p : *solib->sections)
1175 if (p.addr <= address && address < p.endaddr)
1176 return true;
1177
1178 return false;
1179 }
1180
1181 /* If ADDRESS is in a shared lib in program space PSPACE, return its
1182 name.
1183
1184 Provides a hook for other gdb routines to discover whether or not a
1185 particular address is within the mapped address space of a shared
1186 library.
1187
1188 For example, this routine is called at one point to disable
1189 breakpoints which are in shared libraries that are not currently
1190 mapped in. */
1191
1192 const char *
1193 solib_name_from_address (struct program_space *pspace, CORE_ADDR address)
1194 {
1195 struct so_list *so = NULL;
1196
1197 for (so = pspace->so_list; so; so = so->next)
1198 if (solib_contains_address_p (so, address))
1199 return (so->so_name);
1200
1201 return (0);
1202 }
1203
1204 /* See solib.h. */
1205
1206 bool
1207 solib_keep_data_in_core (CORE_ADDR vaddr, unsigned long size)
1208 {
1209 const struct target_so_ops *ops = gdbarch_so_ops (target_gdbarch ());
1210
1211 if (ops->keep_data_in_core)
1212 return ops->keep_data_in_core (vaddr, size) != 0;
1213 else
1214 return false;
1215 }
1216
1217 /* Called by free_all_symtabs */
1218
1219 void
1220 clear_solib (void)
1221 {
1222 const struct target_so_ops *ops = gdbarch_so_ops (target_gdbarch ());
1223
1224 disable_breakpoints_in_shlibs ();
1225
1226 while (current_program_space->so_list)
1227 {
1228 struct so_list *so = current_program_space->so_list;
1229
1230 current_program_space->so_list = so->next;
1231 gdb::observers::solib_unloaded.notify (so);
1232 current_program_space->remove_target_sections (so);
1233 free_so (so);
1234 }
1235
1236 ops->clear_solib ();
1237 }
1238
1239 /* Shared library startup support. When GDB starts up the inferior,
1240 it nurses it along (through the shell) until it is ready to execute
1241 its first instruction. At this point, this function gets
1242 called. */
1243
1244 void
1245 solib_create_inferior_hook (int from_tty)
1246 {
1247 const struct target_so_ops *ops = gdbarch_so_ops (target_gdbarch ());
1248
1249 ops->solib_create_inferior_hook (from_tty);
1250 }
1251
1252 /* See solib.h. */
1253
1254 bool
1255 in_solib_dynsym_resolve_code (CORE_ADDR pc)
1256 {
1257 const struct target_so_ops *ops = gdbarch_so_ops (target_gdbarch ());
1258
1259 return ops->in_dynsym_resolve_code (pc) != 0;
1260 }
1261
1262 /* Implements the "sharedlibrary" command. */
1263
1264 static void
1265 sharedlibrary_command (const char *args, int from_tty)
1266 {
1267 dont_repeat ();
1268 solib_add (args, from_tty, 1);
1269 }
1270
1271 /* Implements the command "nosharedlibrary", which discards symbols
1272 that have been auto-loaded from shared libraries. Symbols from
1273 shared libraries that were added by explicit request of the user
1274 are not discarded. Also called from remote.c. */
1275
1276 void
1277 no_shared_libraries (const char *ignored, int from_tty)
1278 {
1279 /* The order of the two routines below is important: clear_solib notifies
1280 the solib_unloaded observers, and some of these observers might need
1281 access to their associated objfiles. Therefore, we can not purge the
1282 solibs' objfiles before clear_solib has been called. */
1283
1284 clear_solib ();
1285 objfile_purge_solibs ();
1286 }
1287
1288 /* See solib.h. */
1289
1290 void
1291 update_solib_breakpoints (void)
1292 {
1293 const struct target_so_ops *ops = gdbarch_so_ops (target_gdbarch ());
1294
1295 if (ops->update_breakpoints != NULL)
1296 ops->update_breakpoints ();
1297 }
1298
1299 /* See solib.h. */
1300
1301 void
1302 handle_solib_event (void)
1303 {
1304 const struct target_so_ops *ops = gdbarch_so_ops (target_gdbarch ());
1305
1306 if (ops->handle_event != NULL)
1307 ops->handle_event ();
1308
1309 current_inferior ()->pspace->clear_solib_cache ();
1310
1311 /* Check for any newly added shared libraries if we're supposed to
1312 be adding them automatically. Switch terminal for any messages
1313 produced by breakpoint_re_set. */
1314 target_terminal::ours_for_output ();
1315 solib_add (NULL, 0, auto_solib_add);
1316 target_terminal::inferior ();
1317 }
1318
1319 /* Reload shared libraries, but avoid reloading the same symbol file
1320 we already have loaded. */
1321
1322 static void
1323 reload_shared_libraries_1 (int from_tty)
1324 {
1325 if (print_symbol_loading_p (from_tty, 0, 0))
1326 gdb_printf (_("Loading symbols for shared libraries.\n"));
1327
1328 for (struct so_list *so : current_program_space->solibs ())
1329 {
1330 const char *found_pathname = NULL;
1331 bool was_loaded = so->symbols_loaded != 0;
1332 symfile_add_flags add_flags = SYMFILE_DEFER_BP_RESET;
1333
1334 if (from_tty)
1335 add_flags |= SYMFILE_VERBOSE;
1336
1337 gdb::unique_xmalloc_ptr<char> filename
1338 (tilde_expand (so->so_original_name));
1339 gdb_bfd_ref_ptr abfd (solib_bfd_open (filename.get ()));
1340 if (abfd != NULL)
1341 found_pathname = bfd_get_filename (abfd.get ());
1342
1343 /* If this shared library is no longer associated with its previous
1344 symbol file, close that. */
1345 if ((found_pathname == NULL && was_loaded)
1346 || (found_pathname != NULL
1347 && filename_cmp (found_pathname, so->so_name) != 0))
1348 {
1349 if (so->objfile && ! (so->objfile->flags & OBJF_USERLOADED)
1350 && !solib_used (so))
1351 so->objfile->unlink ();
1352 current_program_space->remove_target_sections (so);
1353 clear_so (so);
1354 }
1355
1356 /* If this shared library is now associated with a new symbol
1357 file, open it. */
1358 if (found_pathname != NULL
1359 && (!was_loaded
1360 || filename_cmp (found_pathname, so->so_name) != 0))
1361 {
1362 bool got_error = false;
1363
1364 try
1365 {
1366 solib_map_sections (so);
1367 }
1368
1369 catch (const gdb_exception_error &e)
1370 {
1371 exception_fprintf (gdb_stderr, e,
1372 _("Error while mapping "
1373 "shared library sections:\n"));
1374 got_error = true;
1375 }
1376
1377 if (!got_error
1378 && (auto_solib_add || was_loaded || libpthread_solib_p (so)))
1379 solib_read_symbols (so, add_flags);
1380 }
1381 }
1382 }
1383
1384 static void
1385 reload_shared_libraries (const char *ignored, int from_tty,
1386 struct cmd_list_element *e)
1387 {
1388 const struct target_so_ops *ops;
1389
1390 reload_shared_libraries_1 (from_tty);
1391
1392 ops = gdbarch_so_ops (target_gdbarch ());
1393
1394 /* Creating inferior hooks here has two purposes. First, if we reload
1395 shared libraries then the address of solib breakpoint we've computed
1396 previously might be no longer valid. For example, if we forgot to set
1397 solib-absolute-prefix and are setting it right now, then the previous
1398 breakpoint address is plain wrong. Second, installing solib hooks
1399 also implicitly figures were ld.so is and loads symbols for it.
1400 Absent this call, if we've just connected to a target and set
1401 solib-absolute-prefix or solib-search-path, we'll lose all information
1402 about ld.so. */
1403 if (target_has_execution ())
1404 {
1405 /* Reset or free private data structures not associated with
1406 so_list entries. */
1407 ops->clear_solib ();
1408
1409 /* Remove any previous solib event breakpoint. This is usually
1410 done in common code, at breakpoint_init_inferior time, but
1411 we're not really starting up the inferior here. */
1412 remove_solib_event_breakpoints ();
1413
1414 solib_create_inferior_hook (from_tty);
1415 }
1416
1417 /* Sometimes the platform-specific hook loads initial shared
1418 libraries, and sometimes it doesn't. If it doesn't FROM_TTY will be
1419 incorrectly 0 but such solib targets should be fixed anyway. If we
1420 made all the inferior hook methods consistent, this call could be
1421 removed. Call it only after the solib target has been initialized by
1422 solib_create_inferior_hook. */
1423
1424 solib_add (NULL, 0, auto_solib_add);
1425
1426 breakpoint_re_set ();
1427
1428 /* We may have loaded or unloaded debug info for some (or all)
1429 shared libraries. However, frames may still reference them. For
1430 example, a frame's unwinder might still point at DWARF FDE
1431 structures that are now freed. Also, getting new symbols may
1432 change our opinion about what is frameless. */
1433 reinit_frame_cache ();
1434 }
1435
1436 /* Wrapper for reload_shared_libraries that replaces "remote:"
1437 at the start of gdb_sysroot with "target:". */
1438
1439 static void
1440 gdb_sysroot_changed (const char *ignored, int from_tty,
1441 struct cmd_list_element *e)
1442 {
1443 const char *old_prefix = "remote:";
1444 const char *new_prefix = TARGET_SYSROOT_PREFIX;
1445
1446 if (startswith (gdb_sysroot.c_str (), old_prefix))
1447 {
1448 static bool warning_issued = false;
1449
1450 gdb_assert (strlen (old_prefix) == strlen (new_prefix));
1451 gdb_sysroot = new_prefix + gdb_sysroot.substr (strlen (old_prefix));
1452
1453 if (!warning_issued)
1454 {
1455 warning (_("\"%s\" is deprecated, use \"%s\" instead."),
1456 old_prefix, new_prefix);
1457 warning (_("sysroot set to \"%s\"."), gdb_sysroot.c_str ());
1458
1459 warning_issued = true;
1460 }
1461 }
1462
1463 reload_shared_libraries (ignored, from_tty, e);
1464 }
1465
1466 static void
1467 show_auto_solib_add (struct ui_file *file, int from_tty,
1468 struct cmd_list_element *c, const char *value)
1469 {
1470 gdb_printf (file, _("Autoloading of shared library symbols is %s.\n"),
1471 value);
1472 }
1473
1474
1475 /* Lookup the value for a specific symbol from dynamic symbol table. Look
1476 up symbol from ABFD. MATCH_SYM is a callback function to determine
1477 whether to pick up a symbol. DATA is the input of this callback
1478 function. Return NULL if symbol is not found. */
1479
1480 CORE_ADDR
1481 gdb_bfd_lookup_symbol_from_symtab (bfd *abfd,
1482 int (*match_sym) (const asymbol *,
1483 const void *),
1484 const void *data)
1485 {
1486 long storage_needed = bfd_get_symtab_upper_bound (abfd);
1487 CORE_ADDR symaddr = 0;
1488
1489 if (storage_needed > 0)
1490 {
1491 unsigned int i;
1492
1493 gdb::def_vector<asymbol *> storage (storage_needed / sizeof (asymbol *));
1494 asymbol **symbol_table = storage.data ();
1495 unsigned int number_of_symbols =
1496 bfd_canonicalize_symtab (abfd, symbol_table);
1497
1498 for (i = 0; i < number_of_symbols; i++)
1499 {
1500 asymbol *sym = *symbol_table++;
1501
1502 if (match_sym (sym, data))
1503 {
1504 struct gdbarch *gdbarch = target_gdbarch ();
1505 symaddr = sym->value;
1506
1507 /* Some ELF targets fiddle with addresses of symbols they
1508 consider special. They use minimal symbols to do that
1509 and this is needed for correct breakpoint placement,
1510 but we do not have full data here to build a complete
1511 minimal symbol, so just set the address and let the
1512 targets cope with that. */
1513 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour
1514 && gdbarch_elf_make_msymbol_special_p (gdbarch))
1515 {
1516 struct minimal_symbol msym {};
1517
1518 msym.set_value_address (symaddr);
1519 gdbarch_elf_make_msymbol_special (gdbarch, sym, &msym);
1520 symaddr = msym.value_raw_address ();
1521 }
1522
1523 /* BFD symbols are section relative. */
1524 symaddr += sym->section->vma;
1525 break;
1526 }
1527 }
1528 }
1529
1530 return symaddr;
1531 }
1532
1533 /* See solib.h. */
1534
1535 int
1536 gdb_bfd_scan_elf_dyntag (const int desired_dyntag, bfd *abfd, CORE_ADDR *ptr,
1537 CORE_ADDR *ptr_addr)
1538 {
1539 int arch_size, step, sect_size;
1540 long current_dyntag;
1541 CORE_ADDR dyn_ptr, dyn_addr;
1542 gdb_byte *bufend, *bufstart, *buf;
1543 Elf32_External_Dyn *x_dynp_32;
1544 Elf64_External_Dyn *x_dynp_64;
1545 struct bfd_section *sect;
1546
1547 if (abfd == NULL)
1548 return 0;
1549
1550 if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1551 return 0;
1552
1553 arch_size = bfd_get_arch_size (abfd);
1554 if (arch_size == -1)
1555 return 0;
1556
1557 /* Find the start address of the .dynamic section. */
1558 sect = bfd_get_section_by_name (abfd, ".dynamic");
1559 if (sect == NULL)
1560 return 0;
1561
1562 bool found = false;
1563 for (const target_section &target_section
1564 : current_program_space->target_sections ())
1565 if (sect == target_section.the_bfd_section)
1566 {
1567 dyn_addr = target_section.addr;
1568 found = true;
1569 break;
1570 }
1571 if (!found)
1572 {
1573 /* ABFD may come from OBJFILE acting only as a symbol file without being
1574 loaded into the target (see add_symbol_file_command). This case is
1575 such fallback to the file VMA address without the possibility of
1576 having the section relocated to its actual in-memory address. */
1577
1578 dyn_addr = bfd_section_vma (sect);
1579 }
1580
1581 /* Read in .dynamic from the BFD. We will get the actual value
1582 from memory later. */
1583 sect_size = bfd_section_size (sect);
1584 buf = bufstart = (gdb_byte *) alloca (sect_size);
1585 if (!bfd_get_section_contents (abfd, sect,
1586 buf, 0, sect_size))
1587 return 0;
1588
1589 /* Iterate over BUF and scan for DYNTAG. If found, set PTR and return. */
1590 step = (arch_size == 32) ? sizeof (Elf32_External_Dyn)
1591 : sizeof (Elf64_External_Dyn);
1592 for (bufend = buf + sect_size;
1593 buf < bufend;
1594 buf += step)
1595 {
1596 if (arch_size == 32)
1597 {
1598 x_dynp_32 = (Elf32_External_Dyn *) buf;
1599 current_dyntag = bfd_h_get_32 (abfd, (bfd_byte *) x_dynp_32->d_tag);
1600 dyn_ptr = bfd_h_get_32 (abfd, (bfd_byte *) x_dynp_32->d_un.d_ptr);
1601 }
1602 else
1603 {
1604 x_dynp_64 = (Elf64_External_Dyn *) buf;
1605 current_dyntag = bfd_h_get_64 (abfd, (bfd_byte *) x_dynp_64->d_tag);
1606 dyn_ptr = bfd_h_get_64 (abfd, (bfd_byte *) x_dynp_64->d_un.d_ptr);
1607 }
1608 if (current_dyntag == DT_NULL)
1609 return 0;
1610 if (current_dyntag == desired_dyntag)
1611 {
1612 /* If requested, try to read the runtime value of this .dynamic
1613 entry. */
1614 if (ptr)
1615 {
1616 struct type *ptr_type;
1617 gdb_byte ptr_buf[8];
1618 CORE_ADDR ptr_addr_1;
1619
1620 ptr_type = builtin_type (target_gdbarch ())->builtin_data_ptr;
1621 ptr_addr_1 = dyn_addr + (buf - bufstart) + arch_size / 8;
1622 if (target_read_memory (ptr_addr_1, ptr_buf, arch_size / 8) == 0)
1623 dyn_ptr = extract_typed_address (ptr_buf, ptr_type);
1624 *ptr = dyn_ptr;
1625 if (ptr_addr)
1626 *ptr_addr = dyn_addr + (buf - bufstart);
1627 }
1628 return 1;
1629 }
1630 }
1631
1632 return 0;
1633 }
1634
1635 /* See solib.h. */
1636
1637 gdb::unique_xmalloc_ptr<char>
1638 gdb_bfd_read_elf_soname (const char *filename)
1639 {
1640 gdb_bfd_ref_ptr abfd = gdb_bfd_open (filename, gnutarget);
1641
1642 if (abfd == nullptr)
1643 return {};
1644
1645 /* Check that ABFD is an ET_DYN ELF file. */
1646 if (!bfd_check_format (abfd.get (), bfd_object)
1647 || !(bfd_get_file_flags (abfd.get ()) & DYNAMIC))
1648 return {};
1649
1650 CORE_ADDR idx;
1651 if (!gdb_bfd_scan_elf_dyntag (DT_SONAME, abfd.get (), &idx, nullptr))
1652 return {};
1653
1654 struct bfd_section *dynstr = bfd_get_section_by_name (abfd.get (), ".dynstr");
1655 int sect_size = bfd_section_size (dynstr);
1656 if (dynstr == nullptr || sect_size <= idx)
1657 return {};
1658
1659 /* Read soname from the string table. */
1660 gdb::byte_vector dynstr_buf;
1661 if (!gdb_bfd_get_full_section_contents (abfd.get (), dynstr, &dynstr_buf))
1662 return {};
1663
1664 /* Ensure soname is null-terminated before returning a copy. */
1665 char *soname = (char *) dynstr_buf.data () + idx;
1666 if (strnlen (soname, sect_size - idx) == sect_size - idx)
1667 return {};
1668
1669 return make_unique_xstrdup (soname);
1670 }
1671
1672 /* Lookup the value for a specific symbol from symbol table. Look up symbol
1673 from ABFD. MATCH_SYM is a callback function to determine whether to pick
1674 up a symbol. DATA is the input of this callback function. Return NULL
1675 if symbol is not found. */
1676
1677 static CORE_ADDR
1678 bfd_lookup_symbol_from_dyn_symtab (bfd *abfd,
1679 int (*match_sym) (const asymbol *,
1680 const void *),
1681 const void *data)
1682 {
1683 long storage_needed = bfd_get_dynamic_symtab_upper_bound (abfd);
1684 CORE_ADDR symaddr = 0;
1685
1686 if (storage_needed > 0)
1687 {
1688 unsigned int i;
1689 gdb::def_vector<asymbol *> storage (storage_needed / sizeof (asymbol *));
1690 asymbol **symbol_table = storage.data ();
1691 unsigned int number_of_symbols =
1692 bfd_canonicalize_dynamic_symtab (abfd, symbol_table);
1693
1694 for (i = 0; i < number_of_symbols; i++)
1695 {
1696 asymbol *sym = *symbol_table++;
1697
1698 if (match_sym (sym, data))
1699 {
1700 /* BFD symbols are section relative. */
1701 symaddr = sym->value + sym->section->vma;
1702 break;
1703 }
1704 }
1705 }
1706 return symaddr;
1707 }
1708
1709 /* Lookup the value for a specific symbol from symbol table and dynamic
1710 symbol table. Look up symbol from ABFD. MATCH_SYM is a callback
1711 function to determine whether to pick up a symbol. DATA is the
1712 input of this callback function. Return NULL if symbol is not
1713 found. */
1714
1715 CORE_ADDR
1716 gdb_bfd_lookup_symbol (bfd *abfd,
1717 int (*match_sym) (const asymbol *, const void *),
1718 const void *data)
1719 {
1720 CORE_ADDR symaddr = gdb_bfd_lookup_symbol_from_symtab (abfd, match_sym, data);
1721
1722 /* On FreeBSD, the dynamic linker is stripped by default. So we'll
1723 have to check the dynamic string table too. */
1724 if (symaddr == 0)
1725 symaddr = bfd_lookup_symbol_from_dyn_symtab (abfd, match_sym, data);
1726
1727 return symaddr;
1728 }
1729
1730 /* The shared library list may contain user-loaded object files that
1731 can be removed out-of-band by the user. So upon notification of
1732 free_objfile remove all references to any user-loaded file that is
1733 about to be freed. */
1734
1735 static void
1736 remove_user_added_objfile (struct objfile *objfile)
1737 {
1738 if (objfile != 0 && objfile->flags & OBJF_USERLOADED)
1739 {
1740 for (struct so_list *so : current_program_space->solibs ())
1741 if (so->objfile == objfile)
1742 so->objfile = NULL;
1743 }
1744 }
1745
1746 void _initialize_solib ();
1747 void
1748 _initialize_solib ()
1749 {
1750 gdb::observers::free_objfile.attach (remove_user_added_objfile,
1751 "solib");
1752 gdb::observers::inferior_execd.attach ([] (inferior *inf)
1753 {
1754 solib_create_inferior_hook (0);
1755 }, "solib");
1756
1757 add_com ("sharedlibrary", class_files, sharedlibrary_command,
1758 _("Load shared object library symbols for files matching REGEXP."));
1759 cmd_list_element *info_sharedlibrary_cmd
1760 = add_info ("sharedlibrary", info_sharedlibrary_command,
1761 _("Status of loaded shared object libraries."));
1762 add_info_alias ("dll", info_sharedlibrary_cmd, 1);
1763 add_com ("nosharedlibrary", class_files, no_shared_libraries,
1764 _("Unload all shared object library symbols."));
1765
1766 add_setshow_boolean_cmd ("auto-solib-add", class_support,
1767 &auto_solib_add, _("\
1768 Set autoloading of shared library symbols."), _("\
1769 Show autoloading of shared library symbols."), _("\
1770 If \"on\", symbols from all shared object libraries will be loaded\n\
1771 automatically when the inferior begins execution, when the dynamic linker\n\
1772 informs gdb that a new library has been loaded, or when attaching to the\n\
1773 inferior. Otherwise, symbols must be loaded manually, using \
1774 `sharedlibrary'."),
1775 NULL,
1776 show_auto_solib_add,
1777 &setlist, &showlist);
1778
1779 set_show_commands sysroot_cmds
1780 = add_setshow_optional_filename_cmd ("sysroot", class_support,
1781 &gdb_sysroot, _("\
1782 Set an alternate system root."), _("\
1783 Show the current system root."), _("\
1784 The system root is used to load absolute shared library symbol files.\n\
1785 For other (relative) files, you can add directories using\n\
1786 `set solib-search-path'."),
1787 gdb_sysroot_changed,
1788 NULL,
1789 &setlist, &showlist);
1790
1791 add_alias_cmd ("solib-absolute-prefix", sysroot_cmds.set, class_support, 0,
1792 &setlist);
1793 add_alias_cmd ("solib-absolute-prefix", sysroot_cmds.show, class_support, 0,
1794 &showlist);
1795
1796 add_setshow_optional_filename_cmd ("solib-search-path", class_support,
1797 &solib_search_path, _("\
1798 Set the search path for loading non-absolute shared library symbol files."),
1799 _("\
1800 Show the search path for loading non-absolute shared library symbol files."),
1801 _("\
1802 This takes precedence over the environment variables \
1803 PATH and LD_LIBRARY_PATH."),
1804 reload_shared_libraries,
1805 show_solib_search_path,
1806 &setlist, &showlist);
1807
1808 add_setshow_boolean_cmd ("solib", class_maintenance,
1809 &debug_solib, _("\
1810 Set solib debugging."), _("\
1811 Show solib debugging."), _("\
1812 When true, solib-related debugging output is enabled."),
1813 nullptr, nullptr,
1814 &setdebuglist, &showdebuglist);
1815 }