binutils-gdb/gdb/gdbcore.h

/* Machine independent variables that describe the core file under GDB.

   Copyright (C) 1986-2025 Free Software Foundation, Inc.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

/* Interface routines for core, executable, etc.  */

#ifndef GDB_GDBCORE_H
#define GDB_GDBCORE_H

struct type;
struct regcache;

#include "bfd.h"
#include "exec.h"
#include "target.h"

/* Nonzero if there is a core file.  */

extern int have_core_file_p (void);

/* Report a memory error with error().  */

extern void memory_error (enum target_xfer_status status, CORE_ADDR memaddr);

/* The string 'memory_error' would use as exception message.  */

extern std::string memory_error_message (enum target_xfer_status err,
					 struct gdbarch *gdbarch,
					 CORE_ADDR memaddr);

/* Like target_read_memory, but report an error if can't read.  */

extern void read_memory (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);

/* Like target_read_stack, but report an error if can't read.  */

extern void read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);

/* Like target_read_code, but report an error if can't read.  */

extern void read_code (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);

/* Read an integer from debugged memory, given address and number of
   bytes.  */

extern LONGEST read_memory_integer (CORE_ADDR memaddr,
				    int len, enum bfd_endian byte_order);
extern int safe_read_memory_integer (CORE_ADDR memaddr, int len,
				     enum bfd_endian byte_order,
				     LONGEST *return_value);

/* Read an unsigned integer from debugged memory, given address and
   number of bytes.  */

extern ULONGEST read_memory_unsigned_integer (CORE_ADDR memaddr,
					      int len,
					      enum bfd_endian byte_order);
extern int safe_read_memory_unsigned_integer (CORE_ADDR memaddr, int len,
					      enum bfd_endian byte_order,
					      ULONGEST *return_value);

/* Read an integer from debugged code memory, given address,
   number of bytes, and byte order for code.  */

extern LONGEST read_code_integer (CORE_ADDR memaddr, int len,
				  enum bfd_endian byte_order);

/* Read an unsigned integer from debugged code memory, given address,
   number of bytes, and byte order for code.  */

extern ULONGEST read_code_unsigned_integer (CORE_ADDR memaddr,
					    int len,
					    enum bfd_endian byte_order);

/* Read the pointer of type TYPE at ADDR, and return the address it
   represents.  */

CORE_ADDR read_memory_typed_address (CORE_ADDR addr, struct type *type);

/* Same as target_write_memory, but report an error if can't
   write.  */

extern void write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
			  ssize_t len);

/* Same as write_memory, but notify 'memory_changed' observers.  */

extern void write_memory_with_notification (CORE_ADDR memaddr,
					    const bfd_byte *myaddr,
					    ssize_t len);

/* Store VALUE at ADDR in the inferior as a LEN-byte unsigned integer.  */
extern void write_memory_unsigned_integer (CORE_ADDR addr, int len,
					   enum bfd_endian byte_order,
					   ULONGEST value);

/* Store VALUE at ADDR in the inferior as a LEN-byte unsigned integer.  */
extern void write_memory_signed_integer (CORE_ADDR addr, int len,
					 enum bfd_endian byte_order,
					 LONGEST value);


/* Hook for "file_command", which is more useful than above
   (because it is invoked AFTER symbols are read, not before).  */

extern void (*deprecated_file_changed_hook) (const char *filename);

/* Whether to open exec and core files read-only or read-write.  */

extern bool write_files;

extern void core_file_command (const char *filename, int from_tty);

extern void exec_file_attach (const char *filename, int from_tty);

/* If the filename of the main executable is unknown, attempt to
   determine it.  If a filename is determined, proceed as though
   it was just specified with the "file" command.  Do nothing if
   the filename of the main executable is already known.
   DEFER_BP_RESET uses SYMFILE_DEFER_BP_RESET for the main symbol file.  */

extern void exec_file_locate_attach (int pid, int defer_bp_reset, int from_tty);

extern void validate_files (void);

/* Give the user a message if the current exec file does not match the exec
   file determined from the target.  In case of mismatch, ask the user
   if the exec file determined from target must be loaded.  */
extern void validate_exec_file (int from_tty);

/* The current default bfd target.  */

extern const char *gnutarget;

extern void set_gnutarget (const char *);

/* Build either a single-thread or multi-threaded section name for
   PTID.

   If ptid's lwp member is zero, we want to do the single-threaded
   thing: look for a section named NAME (as passed to the
   constructor).  If ptid's lwp member is non-zero, we'll want do the
   multi-threaded thing: look for a section named "NAME/LWP", where
   LWP is the shortest ASCII decimal representation of ptid's lwp
   member.  */

class thread_section_name
{
public:
  /* NAME is the single-threaded section name.  If PTID represents an
     LWP, then the build section name is "NAME/LWP", otherwise it's
     just "NAME" unmodified.  */
  thread_section_name (const char *name, ptid_t ptid)
  {
    if (ptid.lwp_p ())
      {
	m_storage = string_printf ("%s/%ld", name, ptid.lwp ());
	m_section_name = m_storage.c_str ();
      }
    else
      m_section_name = name;
  }

  /* Return the computed section name.  The result is valid as long as
     this thread_section_name object is live.  */
  const char *c_str () const
  { return m_section_name; }

  DISABLE_COPY_AND_ASSIGN (thread_section_name);

private:
  /* Either a pointer into M_STORAGE, or a pointer to the name passed
     as parameter to the constructor.  */
  const char *m_section_name;
  /* If we need to build a new section name, this is where we store
     it.  */
  std::string m_storage;
};

/* Type returned from core_target_find_mapped_file.  Holds information
   about a mapped file that was processed when a core file was initially
   loaded.  */
struct core_target_mapped_file_info
{
  /* Constructor.  BUILD_ID is not nullptr, and is the build-id for the
     mapped file.  FILENAME is the location of the file that GDB loaded to
     provide the mapped file.  This might be different from the name of the
     mapped file mentioned in the core file, e.g. if GDB downloads a file
     from debuginfod then FILENAME would point into the debuginfod client
     cache.  The FILENAME can be the empty string if GDB was unable to find
     a file to provide the mapped file.  */

  core_target_mapped_file_info (const bfd_build_id *build_id,
				const std::string filename)
    : m_build_id (build_id),
      m_filename (filename)
  {
    gdb_assert (m_build_id != nullptr);
  }

  /* The build-id for this mapped file.  */

  const bfd_build_id *
  build_id () const
  {
    return m_build_id;
  }

  /* The file GDB used to provide this mapped file.  */

  const std::string &
  filename () const
  {
    return m_filename;
  }

private:
  const bfd_build_id *m_build_id = nullptr;
  const std::string m_filename;
};

/* If the current inferior has a core_target for its process target, then
   lookup information about a mapped file that was discovered when the
   core file was loaded.

   The FILENAME is the file we're looking for.  The ADDR, if provided, is a
   mapped address within the inferior which is known to be part of the file
   we are looking for.

   As an example, when loading shared libraries this function can be
   called, in that case FILENAME will be the name of the shared library
   that GDB is trying to load and ADDR will be an inferior address which is
   part of the shared library we are looking for.

   This function looks for a mapped file which matches FILENAME and/or
   which covers ADDR and returns information about that file.

   The returned information includes the name of the mapped file if known
   and the build-id for the mapped file if known.

   */
std::optional<core_target_mapped_file_info>
core_target_find_mapped_file (const char *filename,
			      std::optional<CORE_ADDR> addr);

/* Type holding information about a single file mapped into the inferior
   at the point when the core file was created.  Associates a build-id
   with the list of regions the file is mapped into.  */
struct core_mapped_file
{
  /* Type for a region of a file that was mapped into the inferior when
     the core file was generated.  */
  struct region
  {
    /* Constructor.   See member variables for argument descriptions.  */
    region (CORE_ADDR start_, CORE_ADDR end_, CORE_ADDR file_ofs_)
      : start (start_),
	end (end_),
	file_ofs (file_ofs_)
    { /* Nothing.  */ }

    /* The inferior address for the start of the mapped region.  */
    CORE_ADDR start;

    /* The inferior address immediately after the mapped region.  */
    CORE_ADDR end;

    /* The offset within the mapped file for this content.  */
    CORE_ADDR file_ofs;
  };

  /* The filename as recorded in the core file.  */
  std::string filename;

  /* If not nullptr, then this is the build-id associated with this
     file.  */
  const bfd_build_id *build_id = nullptr;

  /* All the mapped regions of this file.  */
  std::vector<region> regions;

  /* True if this is the main executable.  */
  bool is_main_exec = false;
};

extern std::vector<core_mapped_file> gdb_read_core_file_mappings
  (struct gdbarch *gdbarch, struct bfd *cbfd);

/* Return the core file bfd for inferior INF, if that inferior has a core
   file loaded.  Otherwise, return NULL.  */

extern bfd *get_inferior_core_bfd (inferior *inf);

#endif /* GDB_GDBCORE_H */