gdb/build-id.h

   1 /* build-id-related functions.
   2
   3    Copyright (C) 1991-2024 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 #ifndef BUILD_ID_H
  21 #define BUILD_ID_H
  22
  23 #include "gdb_bfd.h"
  24 #include "gdbsupport/rsp-low.h"
  25
  26 /* Locate NT_GNU_BUILD_ID from ABFD and return its content.  */
  27
  28 extern const struct bfd_build_id *build_id_bfd_get (bfd *abfd);
  29
  30 /* Return true if ABFD has NT_GNU_BUILD_ID matching the CHECK value.
  31    Otherwise, issue a warning and return false.  */
  32
  33 extern int build_id_verify (bfd *abfd,
  34                             size_t check_len, const bfd_byte *check);
  35
  36
  37 /* Find and open a BFD for a debuginfo file  given a build-id.  If no BFD
  38    can be found, return NULL.  */
  39
  40 extern gdb_bfd_ref_ptr build_id_to_debug_bfd (size_t build_id_len,
  41                                               const bfd_byte *build_id);
  42
  43 /* Find the separate debug file for OBJFILE, by using the build-id
  44    associated with OBJFILE's BFD.  If successful, returns the file name for the
  45    separate debug file, otherwise, return an empty string.
  46
  47    Any warnings that are generated by the lookup process should be added to
  48    WARNINGS.  If some other mechanism can be used to lookup the debug
  49    information then the warning will not be shown, however, if GDB fails to
  50    find suitable debug information using any approach, then any warnings
  51    will be printed.  */
  52
  53 extern std::string find_separate_debug_file_by_buildid
  54   (struct objfile *objfile, deferred_warnings *warnings);
  55
  56 /* Find an objfile (executable or shared library) that matches BUILD_ID.
  57    This is done by first checking in the debug-file-directory for a
  58    suitable .build-id/ sub-directory, and looking for a file with the
  59    required build-id (usually a symbolic link or hard link to the actual
  60    file).
  61
  62    If that doesn't find us a file then we call to debuginfod to see if it
  63    can provide the required file.
  64
  65    EXPECTED_FILENAME is used in output messages from debuginfod, this
  66    should be the file we were looking for but couldn't find.  */
  67
  68 extern gdb_bfd_ref_ptr find_objfile_by_build_id
  69   (const bfd_build_id *build_id, const char *expected_filename);
  70
  71 /* Return an hex-string representation of BUILD_ID.  */
  72
  73 static inline std::string
  74 build_id_to_string (const bfd_build_id *build_id)
  75 {
  76   gdb_assert (build_id != NULL);
  77
  78   return bin2hex (build_id->data, build_id->size);
  79 }
  80
  81 /* Compare the content of two build-ids.  One build-id (A) is passed as a
  82    build-id pointer, while the second is passed using BUILD_ID_LEN and
  83    BUILD_ID_DATA.  Return true if the build-ids match, otherwise false.  */
  84
  85 static inline bool
  86 build_id_equal (const bfd_build_id *a, const bfd_size_type build_id_len,
  87                 const bfd_byte *build_id_data)
  88 {
  89   gdb_assert (a != nullptr);
  90   gdb_assert (build_id_data != nullptr);
  91
  92   return (a->size == build_id_len
  93           && memcmp (a->data, build_id_data, a->size) == 0);
  94 }
  95
  96 /* Like the above, but take two build-id pointers A and B.  */
  97
  98 static inline bool
  99 build_id_equal (const bfd_build_id *a, const bfd_build_id *b)
 100 {
 101   gdb_assert (a != nullptr);
 102   gdb_assert (b != nullptr);
 103
 104   return build_id_equal (a, b->size, b->data);
 105 }
 106
 107 #endif /* BUILD_ID_H */