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 and open a BFD for an executable file given a build-id.  If no BFD
  44    can be found, return NULL.  The returned reference to the BFD must be
  45    released by the caller.  */
  46
  47 extern gdb_bfd_ref_ptr build_id_to_exec_bfd (size_t build_id_len,
  48                                              const bfd_byte *build_id);
  49
  50 /* Find the separate debug file for OBJFILE, by using the build-id
  51    associated with OBJFILE's BFD.  If successful, returns the file name for the
  52    separate debug file, otherwise, return an empty string.
  53
  54    Any warnings that are generated by the lookup process should be added to
  55    WARNINGS.  If some other mechanism can be used to lookup the debug
  56    information then the warning will not be shown, however, if GDB fails to
  57    find suitable debug information using any approach, then any warnings
  58    will be printed.  */
  59
  60 extern std::string find_separate_debug_file_by_buildid
  61   (struct objfile *objfile, deferred_warnings *warnings);
  62
  63 /* Return an hex-string representation of BUILD_ID.  */
  64
  65 static inline std::string
  66 build_id_to_string (const bfd_build_id *build_id)
  67 {
  68   gdb_assert (build_id != NULL);
  69
  70   return bin2hex (build_id->data, build_id->size);
  71 }
  72
  73 /* Compare the content of two build-ids.  One build-id (A) is passed as a
  74    build-id pointer, while the second is passed using BUILD_ID_LEN and
  75    BUILD_ID_DATA.  Return true if the build-ids match, otherwise false.  */
  76
  77 static inline bool
  78 build_id_equal (const bfd_build_id *a, const bfd_size_type build_id_len,
  79                 const bfd_byte *build_id_data)
  80 {
  81   gdb_assert (a != nullptr);
  82   gdb_assert (build_id_data != nullptr);
  83
  84   return (a->size == build_id_len
  85           && memcmp (a->data, build_id_data, a->size) == 0);
  86 }
  87
  88 /* Like the above, but take two build-id pointers A and B.  */
  89
  90 static inline bool
  91 build_id_equal (const bfd_build_id *a, const bfd_build_id *b)
  92 {
  93   gdb_assert (a != nullptr);
  94   gdb_assert (b != nullptr);
  95
  96   return build_id_equal (a, b->size, b->data);
  97 }
  98
  99 #endif /* BUILD_ID_H */