gdb/gdbcore.h

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