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
   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, 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, enum bfd_endian byte_order);
  68
  69 /* Read a null-terminated string from the debuggee's memory, given address,
  70  * a buffer into which to place the string, and the maximum available space */
  71
  72 extern void read_memory_string (CORE_ADDR, char *, int);
  73
  74 /* Read the pointer of type TYPE at ADDR, and return the address it
  75    represents. */
  76
  77 CORE_ADDR read_memory_typed_address (CORE_ADDR addr, struct type *type);
  78
  79 /* This takes a char *, not void *.  This is probably right, because
  80    passing in an int * or whatever is wrong with respect to
  81    byteswapping, alignment, different sizes for host vs. target types,
  82    etc.  */
  83
  84 extern void write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr, int len);
  85
  86 /* Store VALUE at ADDR in the inferior as a LEN-byte unsigned integer.  */
  87 extern void write_memory_unsigned_integer (CORE_ADDR addr, int len,
  88                                            enum bfd_endian byte_order,
  89                                            ULONGEST value);
  90
  91 /* Store VALUE at ADDR in the inferior as a LEN-byte unsigned integer.  */
  92 extern void write_memory_signed_integer (CORE_ADDR addr, int len,
  93                                          enum bfd_endian byte_order,
  94                                          LONGEST value);
  95 \f
  96 /* Hook for `exec_file_command' command to call.  */
  97
  98 extern void (*deprecated_exec_file_display_hook) (char *filename);
  99
 100 /* Hook for "file_command", which is more useful than above
 101    (because it is invoked AFTER symbols are read, not before).  */
 102
 103 extern void (*deprecated_file_changed_hook) (char *filename);
 104
 105 extern void specify_exec_file_hook (void (*hook) (char *filename));
 106
 107 /* Binary File Diddler for the core file.  */
 108
 109 extern bfd *core_bfd;
 110
 111 extern struct target_ops *core_target;
 112
 113 /* Whether to open exec and core files read-only or read-write.  */
 114
 115 extern int write_files;
 116
 117 extern void core_file_command (char *filename, int from_tty);
 118
 119 extern void exec_file_attach (char *filename, int from_tty);
 120
 121 extern void exec_file_clear (int from_tty);
 122
 123 extern void validate_files (void);
 124
 125 /* The current default bfd target.  */
 126
 127 extern char *gnutarget;
 128
 129 extern void set_gnutarget (char *);
 130
 131 /* Structure to keep track of core register reading functions for
 132    various core file types.  */
 133
 134 struct core_fns
 135   {
 136
 137     /* BFD flavour that a core file handler is prepared to read.  This
 138        can be used by the handler's core tasting function as a first
 139        level filter to reject BFD's that don't have the right
 140        flavour. */
 141
 142     enum bfd_flavour core_flavour;
 143
 144     /* Core file handler function to call to recognize corefile
 145        formats that BFD rejects.  Some core file format just don't fit
 146        into the BFD model, or may require other resources to identify
 147        them, that simply aren't available to BFD (such as symbols from
 148        another file).  Returns nonzero if the handler recognizes the
 149        format, zero otherwise. */
 150
 151     int (*check_format) (bfd *);
 152
 153     /* Core file handler function to call to ask if it can handle a
 154        given core file format or not.  Returns zero if it can't,
 155        nonzero otherwise. */
 156
 157     int (*core_sniffer) (struct core_fns *, bfd *);
 158
 159     /* Extract the register values out of the core file and supply them
 160        into REGCACHE.
 161
 162        CORE_REG_SECT points to the register values themselves, read into
 163        memory.
 164
 165        CORE_REG_SIZE is the size of that area.
 166
 167        WHICH says which set of registers we are handling:
 168          0 --- integer registers
 169          2 --- floating-point registers, on machines where they are
 170                discontiguous
 171          3 --- extended floating-point registers, on machines where
 172                these are present in yet a third area.  (GNU/Linux uses
 173                this to get at the SSE registers.)
 174
 175        REG_ADDR is the offset from u.u_ar0 to the register values relative to
 176        core_reg_sect.  This is used with old-fashioned core files to locate the
 177        registers in a large upage-plus-stack ".reg" section.  Original upage
 178        address X is at location core_reg_sect+x+reg_addr. */
 179
 180     void (*core_read_registers) (struct regcache *regcache,
 181                                  char *core_reg_sect,
 182                                  unsigned core_reg_size,
 183                                  int which, CORE_ADDR reg_addr);
 184
 185     /* Finds the next struct core_fns.  They are allocated and
 186        initialized in whatever module implements the functions pointed
 187        to; an initializer calls deprecated_add_core_fns to add them to
 188        the global chain.  */
 189
 190     struct core_fns *next;
 191
 192   };
 193
 194 /* NOTE: cagney/2004-04-05: Replaced by "regset.h" and
 195    regset_from_core_section().  */
 196 extern void deprecated_add_core_fns (struct core_fns *cf);
 197 extern int default_core_sniffer (struct core_fns *cf, bfd * abfd);
 198 extern int default_check_format (bfd * abfd);
 199
 200 struct target_section *deprecated_core_resize_section_table (int num_added);
 201
 202 #endif /* !defined (GDBCORE_H) */