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