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