gdb/gdbcore.h

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