gdb/gdbcore.h

   1 /* Machine independent variables that describe the core file under GDB.
   2
   3    Copyright (C) 1986, 1987, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
   4    1997, 1998, 1999, 2000, 2001, 2004, 2007, 2008, 2009, 2010, 2011
   5    Free Software Foundation, Inc.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 /* Interface routines for core, executable, etc.  */
  23
  24 #if !defined (GDBCORE_H)
  25 #define GDBCORE_H 1
  26
  27 struct type;
  28 struct regcache;
  29
  30 #include "bfd.h"
  31 #include "exec.h"
  32
  33 /* Return the name of the executable file as a string.
  34    ERR nonzero means get error if there is none specified;
  35    otherwise return 0 in that case.  */
  36
  37 extern char *get_exec_file (int err);
  38
  39 /* Nonzero if there is a core file.  */
  40
  41 extern int have_core_file_p (void);
  42
  43 /* Report a memory error with error().  */
  44
  45 extern void memory_error (int status, CORE_ADDR memaddr);
  46
  47 /* Like target_read_memory, but report an error if can't read.  */
  48
  49 extern void read_memory (CORE_ADDR memaddr, gdb_byte *myaddr, int len);
  50
  51 /* Like target_read_stack, but report an error if can't read.  */
  52
  53 extern void read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, int len);
  54
  55 /* Read an integer from debugged memory, given address and number of
  56    bytes.  */
  57
  58 extern LONGEST read_memory_integer (CORE_ADDR memaddr,
  59                                     int len, enum bfd_endian byte_order);
  60 extern int safe_read_memory_integer (CORE_ADDR memaddr, int len,
  61                                      enum bfd_endian byte_order,
  62                                      LONGEST *return_value);
  63
  64 /* Read an unsigned integer from debugged memory, given address and
  65    number of bytes.  */
  66
  67 extern ULONGEST read_memory_unsigned_integer (CORE_ADDR memaddr,
  68                                               int len,
  69                                               enum bfd_endian byte_order);
  70
  71 /* Read a null-terminated string from the debuggee's memory, given address,
  72  * a buffer into which to place the string, and the maximum available space */
  73
  74 extern void read_memory_string (CORE_ADDR, char *, int);
  75
  76 /* Read the pointer of type TYPE at ADDR, and return the address it
  77    represents. */
  78
  79 CORE_ADDR read_memory_typed_address (CORE_ADDR addr, struct type *type);
  80
  81 /* This takes a char *, not void *.  This is probably right, because
  82    passing in an int * or whatever is wrong with respect to
  83    byteswapping, alignment, different sizes for host vs. target types,
  84    etc.  */
  85
  86 extern void write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr, int len);
  87
  88 /* Store VALUE at ADDR in the inferior as a LEN-byte unsigned integer.  */
  89 extern void write_memory_unsigned_integer (CORE_ADDR addr, int len,
  90                                            enum bfd_endian byte_order,
  91                                            ULONGEST value);
  92
  93 /* Store VALUE at ADDR in the inferior as a LEN-byte unsigned integer.  */
  94 extern void write_memory_signed_integer (CORE_ADDR addr, int len,
  95                                          enum bfd_endian byte_order,
  96                                          LONGEST value);
  97 \f
  98 /* Hook for `exec_file_command' command to call.  */
  99
 100 extern void (*deprecated_exec_file_display_hook) (char *filename);
 101
 102 /* Hook for "file_command", which is more useful than above
 103    (because it is invoked AFTER symbols are read, not before).  */
 104
 105 extern void (*deprecated_file_changed_hook) (char *filename);
 106
 107 extern void specify_exec_file_hook (void (*hook) (char *filename));
 108
 109 /* Binary File Diddler for the core file.  */
 110
 111 extern bfd *core_bfd;
 112
 113 extern struct target_ops *core_target;
 114
 115 /* Whether to open exec and core files read-only or read-write.  */
 116
 117 extern int write_files;
 118
 119 extern void core_file_command (char *filename, int from_tty);
 120
 121 extern void exec_file_attach (char *filename, int from_tty);
 122
 123 extern void exec_file_clear (int from_tty);
 124
 125 extern void validate_files (void);
 126
 127 /* The current default bfd target.  */
 128
 129 extern char *gnutarget;
 130
 131 extern void set_gnutarget (char *);
 132
 133 /* Structure to keep track of core register reading functions for
 134    various core file types.  */
 135
 136 struct core_fns
 137   {
 138
 139     /* BFD flavour that a core file handler is prepared to read.  This
 140        can be used by the handler's core tasting function as a first
 141        level filter to reject BFD's that don't have the right
 142        flavour. */
 143
 144     enum bfd_flavour core_flavour;
 145
 146     /* Core file handler function to call to recognize corefile
 147        formats that BFD rejects.  Some core file format just don't fit
 148        into the BFD model, or may require other resources to identify
 149        them, that simply aren't available to BFD (such as symbols from
 150        another file).  Returns nonzero if the handler recognizes the
 151        format, zero otherwise. */
 152
 153     int (*check_format) (bfd *);
 154
 155     /* Core file handler function to call to ask if it can handle a
 156        given core file format or not.  Returns zero if it can't,
 157        nonzero otherwise. */
 158
 159     int (*core_sniffer) (struct core_fns *, bfd *);
 160
 161     /* Extract the register values out of the core file and supply them
 162        into REGCACHE.
 163
 164        CORE_REG_SECT points to the register values themselves, read into
 165        memory.
 166
 167        CORE_REG_SIZE is the size of that area.
 168
 169        WHICH says which set of registers we are handling:
 170          0 --- integer registers
 171          2 --- floating-point registers, on machines where they are
 172                discontiguous
 173          3 --- extended floating-point registers, on machines where
 174                these are present in yet a third area.  (GNU/Linux uses
 175                this to get at the SSE registers.)
 176
 177        REG_ADDR is the offset from u.u_ar0 to the register values relative to
 178        core_reg_sect.  This is used with old-fashioned core files to locate the
 179        registers in a large upage-plus-stack ".reg" section.  Original upage
 180        address X is at location core_reg_sect+x+reg_addr. */
 181
 182     void (*core_read_registers) (struct regcache *regcache,
 183                                  char *core_reg_sect,
 184                                  unsigned core_reg_size,
 185                                  int which, CORE_ADDR reg_addr);
 186
 187     /* Finds the next struct core_fns.  They are allocated and
 188        initialized in whatever module implements the functions pointed
 189        to; an initializer calls deprecated_add_core_fns to add them to
 190        the global chain.  */
 191
 192     struct core_fns *next;
 193
 194   };
 195
 196 /* NOTE: cagney/2004-04-05: Replaced by "regset.h" and
 197    regset_from_core_section().  */
 198 extern void deprecated_add_core_fns (struct core_fns *cf);
 199 extern int default_core_sniffer (struct core_fns *cf, bfd * abfd);
 200 extern int default_check_format (bfd * abfd);
 201
 202 struct target_section *deprecated_core_resize_section_table (int num_added);
 203
 204 #endif /* !defined (GDBCORE_H) */