Change regcache list to be an hash map
[deliverable/binutils-gdb.git] / gdb / gdbcore.h
index 6501e3098b969fa37cbb1bb63546c1473f7382da..cac91c097bab310693788d5de69a6f9d3931d41d 100644 (file)
 /* Machine independent variables that describe the core file under GDB.
-   Copyright 1986, 1987, 1989, 1990, 1992, 1995 Free Software Foundation, Inc.
 
-This file is part of GDB.
+   Copyright (C) 1986-2019 Free Software Foundation, Inc.
 
-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 2 of the License, or
-(at your option) any later version.
+   This file is part of GDB.
 
-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.
+   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.
 
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
+   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.  */
 
 #if !defined (GDBCORE_H)
 #define GDBCORE_H 1
 
-#include "bfd.h"
-
-/* Return the name of the executable file as a string.
-   ERR nonzero means get error if there is none specified;
-   otherwise return 0 in that case.  */
+struct type;
+struct regcache;
 
-extern char *get_exec_file PARAMS ((int err));
+#include "bfd.h"
+#include "exec.h"
+#include "target.h"
 
 /* Nonzero if there is a core file.  */
 
-extern int have_core_file_p PARAMS ((void));
+extern int have_core_file_p (void);
 
-/* Read "memory data" from whatever target or inferior we have.
-   Returns zero if successful, errno value if not.  EIO is used for
-   address out of bounds.  If breakpoints are inserted, returns shadow
-   contents, not the breakpoints themselves.  From breakpoint.c.  */
+/* Report a memory error with error().  */
 
-extern int read_memory_nobpt PARAMS ((CORE_ADDR memaddr, char *myaddr,
-                                     unsigned len));
+extern void memory_error (enum target_xfer_status status, CORE_ADDR memaddr);
 
-/* Report a memory error with error().  */
+/* The string 'memory_error' would use as exception message.  */
 
-extern void memory_error PARAMS ((int status, CORE_ADDR memaddr));
+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 PARAMS ((CORE_ADDR memaddr, char *myaddr, int len));
+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_memory_section PARAMS ((CORE_ADDR memaddr, char *myaddr,
-                                        int len, asection *bfd_section));
+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 PARAMS ((CORE_ADDR memaddr, int len));
+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 PARAMS ((CORE_ADDR memaddr, int len));
-
-/* Read a null-terminated string from the debuggee's memory, given address,
- * a buffer into which to place the string, and the maximum available space */ 
-extern void read_memory_string PARAMS ((CORE_ADDR, char *, int));
-
-/* This takes a char *, not void *.  This is probably right, because
-   passing in an int * or whatever is wrong with respect to
-   byteswapping, alignment, different sizes for host vs. target types,
-   etc.  */
+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);
 
-extern void write_memory PARAMS ((CORE_ADDR memaddr, char *myaddr, int len));
-
-extern void generic_search PARAMS ((int len, char *data, char *mask,
-                                   CORE_ADDR startaddr, int increment,
-                                   CORE_ADDR lorange, CORE_ADDR hirange,
-                                   CORE_ADDR *addr_found, char *data_found));
-\f
-/* Hook for `exec_file_command' command to call.  */
+/* Read an integer from debugged code memory, given address,
+   number of bytes, and byte order for code.  */
 
-extern void (*exec_file_display_hook) PARAMS ((char *filename));
+extern LONGEST read_code_integer (CORE_ADDR memaddr, int len,
+                                 enum bfd_endian byte_order);
 
-/* Hook for "file_command", which is more useful than above
-   (because it is invoked AFTER symbols are read, not before) */
+/* Read an unsigned integer from debugged code memory, given address,
+   number of bytes, and byte order for code.  */
 
-extern void (*file_changed_hook) PARAMS ((char *filename));
+extern ULONGEST read_code_unsigned_integer (CORE_ADDR memaddr,
+                                           int len,
+                                           enum bfd_endian byte_order);
 
-extern void specify_exec_file_hook PARAMS ((void (*hook) (char *filename)));
+/* Read a null-terminated string from the debuggee's memory, given
+   address, a buffer into which to place the string, and the maximum
+   available space.  */
 
-/* Binary File Diddlers for the exec and core files */
+extern void read_memory_string (CORE_ADDR, char *, int);
 
-extern bfd *core_bfd;
-extern bfd *exec_bfd;
+/* Read the pointer of type TYPE at ADDR, and return the address it
+   represents.  */
 
-/* Whether to open exec and core files read-only or read-write.  */
+CORE_ADDR read_memory_typed_address (CORE_ADDR addr, struct type *type);
 
-extern int write_files;
+/* Same as target_write_memory, but report an error if can't
+   write.  */
 
-extern void core_file_command PARAMS ((char *filename, int from_tty));
+extern void write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
+                         ssize_t len);
 
-extern void exec_file_attach PARAMS ((char *filename, int from_tty));
+/* Same as write_memory, but notify 'memory_changed' observers.  */
 
-extern void exec_file_command PARAMS ((char *filename, int from_tty));
+extern void write_memory_with_notification (CORE_ADDR memaddr,
+                                           const bfd_byte *myaddr,
+                                           ssize_t len);
 
-extern void validate_files PARAMS ((void));
+/* 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);
 
-extern CORE_ADDR register_addr PARAMS ((int regno, CORE_ADDR blockend));
+/* 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);
+\f
+/* Hook for `exec_file_command' command to call.  */
 
-extern void registers_fetched PARAMS ((void));
+extern void (*deprecated_exec_file_display_hook) (const char *filename);
 
-#if !defined (KERNEL_U_ADDR)
-extern CORE_ADDR kernel_u_addr;
-#define KERNEL_U_ADDR kernel_u_addr
-#endif
+/* Hook for "file_command", which is more useful than above
+   (because it is invoked AFTER symbols are read, not before).  */
 
-/* The target vector for core files. */
+extern void (*deprecated_file_changed_hook) (const char *filename);
 
-extern struct target_ops core_ops;
+extern void specify_exec_file_hook (void (*hook) (const char *filename));
 
-/* The current default bfd target.  */
+/* Binary File Diddler for the core file.  */
 
-extern char *gnutarget;
+#define core_bfd (current_program_space->cbfd.get ())
 
-extern void set_gnutarget PARAMS ((char *));
+/* Whether to open exec and core files read-only or read-write.  */
 
-/* Structure to keep track of core register reading functions for
-   various core file types.  */
+extern bool write_files;
 
-struct core_fns {
+/* Open and set up the core file bfd.  */
 
-  /* BFD flavour that we handle.  Note that bfd_target_unknown_flavour matches
-     anything, and if there is no better match, this function will be called
-     as the default. */
+extern void core_target_open (const char *arg, int from_tty);
 
-  enum bfd_flavour core_flavour;
+extern void core_file_command (const char *filename, int from_tty);
 
-  /* Extract the register values out of the core file and store them where
-     `read_register' will find them.
+extern void exec_file_attach (const char *filename, int from_tty);
 
-     CORE_REG_SECT points to the register values themselves, read into
-     memory.
+/* 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.  */
 
-     CORE_REG_SIZE is the size of that area.
+extern void exec_file_locate_attach (int pid, int defer_bp_reset, int from_tty);
 
-     WHICH says which set of registers we are handling (0 = int, 2 = float on
-     machines where they are discontiguous).
+extern void validate_files (void);
 
-     REG_ADDR is the offset from u.u_ar0 to the register values relative to
-     core_reg_sect.  This is used with old-fashioned core files to locate the
-     registers in a large upage-plus-stack ".reg" section.  Original upage
-     address X is at location core_reg_sect+x+reg_addr. */
+/* The current default bfd target.  */
 
-  void (*core_read_registers) PARAMS ((char *core_reg_sect, unsigned core_reg_size,
-                                 int which, CORE_ADDR reg_addr));
+extern char *gnutarget;
 
-  /* Finds the next struct core_fns.  They are allocated and initialized
-     in whatever module implements the functions pointed to; an 
-     initializer calls add_core_fns to add them to the global chain.  */
+extern void set_gnutarget (const char *);
 
-  struct core_fns *next;
+/* Structure to keep track of core register reading functions for
+   various core file types.  */
 
+struct core_fns
+  {
+
+    /* BFD flavour that a core file handler is prepared to read.  This
+       can be used by the handler's core tasting function as a first
+       level filter to reject BFD's that don't have the right
+       flavour.  */
+
+    enum bfd_flavour core_flavour;
+
+    /* Core file handler function to call to recognize corefile
+       formats that BFD rejects.  Some core file format just don't fit
+       into the BFD model, or may require other resources to identify
+       them, that simply aren't available to BFD (such as symbols from
+       another file).  Returns nonzero if the handler recognizes the
+       format, zero otherwise.  */
+
+    int (*check_format) (bfd *);
+
+    /* Core file handler function to call to ask if it can handle a
+       given core file format or not.  Returns zero if it can't,
+       nonzero otherwise.  */
+
+    int (*core_sniffer) (struct core_fns *, bfd *);
+
+    /* Extract the register values out of the core file and supply them
+       into REGCACHE.
+
+       CORE_REG_SECT points to the register values themselves, read into
+       memory.
+
+       CORE_REG_SIZE is the size of that area.
+
+       WHICH says which set of registers we are handling:
+         0 --- integer registers
+         2 --- floating-point registers, on machines where they are
+               discontiguous
+         3 --- extended floating-point registers, on machines where
+               these are present in yet a third area.  (GNU/Linux uses
+               this to get at the SSE registers.)
+
+       REG_ADDR is the offset from u.u_ar0 to the register values relative to
+       core_reg_sect.  This is used with old-fashioned core files to locate the
+       registers in a large upage-plus-stack ".reg" section.  Original upage
+       address X is at location core_reg_sect+x+reg_addr.  */
+
+    void (*core_read_registers) (struct regcache *regcache,
+                                char *core_reg_sect,
+                                unsigned core_reg_size,
+                                int which, CORE_ADDR reg_addr);
+
+    /* Finds the next struct core_fns.  They are allocated and
+       initialized in whatever module implements the functions pointed
+       to; an initializer calls deprecated_add_core_fns to add them to
+       the global chain.  */
+
+    struct core_fns *next;
+
+  };
+
+/* 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;
 };
 
-extern void add_core_fns PARAMS ((struct core_fns *cf));
+/* NOTE: cagney/2004-04-05: Replaced by "regset.h" and
+   regset_from_core_section().  */
+extern void deprecated_add_core_fns (struct core_fns *cf);
+extern int default_core_sniffer (struct core_fns *cf, bfd * abfd);
+extern int default_check_format (bfd * abfd);
 
-#endif /* !defined (GDBCORE_H) */
+#endif /* !defined (GDBCORE_H) */
This page took 0.027258 seconds and 4 git commands to generate.