gdb/gdbcore.h

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