contrib/gdb/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, Boston, MA 02111-1307, USA.  */
  19
  20 /* Interface routines for core, executable, etc.  */
  21
  22 #if !defined (GDBCORE_H)
  23 #define GDBCORE_H 1
  24
  25 #include "bfd.h"
  26
  27 /* Return the name of the executable file as a string.
  28    ERR nonzero means get error if there is none specified;
  29    otherwise return 0 in that case.  */
  30
  31 extern char *get_exec_file PARAMS ((int err));
  32
  33 /* Nonzero if there is a core file.  */
  34
  35 extern int have_core_file_p PARAMS ((void));
  36
  37 /* Read "memory data" from whatever target or inferior we have.
  38    Returns zero if successful, errno value if not.  EIO is used for
  39    address out of bounds.  If breakpoints are inserted, returns shadow
  40    contents, not the breakpoints themselves.  From breakpoint.c.  */
  41
  42 extern int read_memory_nobpt PARAMS ((CORE_ADDR memaddr, char *myaddr,
  43                                       unsigned len));
  44
  45 /* Report a memory error with error().  */
  46
  47 extern void memory_error PARAMS ((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 PARAMS ((CORE_ADDR memaddr, char *myaddr, int len));
  52
  53 extern void read_memory_section PARAMS ((CORE_ADDR memaddr, char *myaddr,
  54                                          int len, asection *bfd_section));
  55
  56 /* Read an integer from debugged memory, given address and number of
  57    bytes.  */
  58
  59 extern LONGEST read_memory_integer PARAMS ((CORE_ADDR memaddr, int len));
  60
  61 /* Read an unsigned integer from debugged memory, given address and
  62    number of bytes.  */
  63
  64 extern ULONGEST read_memory_unsigned_integer PARAMS ((CORE_ADDR memaddr, int len));
  65
  66 /* Read a null-terminated string from the debuggee's memory, given address,
  67  * a buffer into which to place the string, and the maximum available space */
  68 extern void read_memory_string PARAMS ((CORE_ADDR, char *, int));
  69
  70 /* This takes a char *, not void *.  This is probably right, because
  71    passing in an int * or whatever is wrong with respect to
  72    byteswapping, alignment, different sizes for host vs. target types,
  73    etc.  */
  74
  75 extern void write_memory PARAMS ((CORE_ADDR memaddr, char *myaddr, int len));
  76
  77 extern void generic_search PARAMS ((int len, char *data, char *mask,
  78                                     CORE_ADDR startaddr, int increment,
  79                                     CORE_ADDR lorange, CORE_ADDR hirange,
  80                                     CORE_ADDR *addr_found, char *data_found));
  81 \f
  82 /* Hook for `exec_file_command' command to call.  */
  83
  84 extern void (*exec_file_display_hook) PARAMS ((char *filename));
  85
  86 /* Hook for "file_command", which is more useful than above
  87    (because it is invoked AFTER symbols are read, not before) */
  88
  89 extern void (*file_changed_hook) PARAMS ((char *filename));
  90
  91 extern void specify_exec_file_hook PARAMS ((void (*hook) (char *filename)));
  92
  93 /* Binary File Diddlers for the exec and core files */
  94
  95 extern bfd *core_bfd;
  96 extern bfd *exec_bfd;
  97
  98 /* Whether to open exec and core files read-only or read-write.  */
  99
 100 extern int write_files;
 101
 102 extern void core_file_command PARAMS ((char *filename, int from_tty));
 103
 104 extern void exec_file_attach PARAMS ((char *filename, int from_tty));
 105
 106 extern void exec_file_command PARAMS ((char *filename, int from_tty));
 107
 108 extern void validate_files PARAMS ((void));
 109
 110 extern CORE_ADDR register_addr PARAMS ((int regno, CORE_ADDR blockend));
 111
 112 extern void registers_fetched PARAMS ((void));
 113
 114 #if !defined (KERNEL_U_ADDR)
 115 extern CORE_ADDR kernel_u_addr;
 116 #define KERNEL_U_ADDR kernel_u_addr
 117 #endif
 118
 119 /* The target vector for core files. */
 120
 121 extern struct target_ops core_ops;
 122
 123 /* The current default bfd target.  */
 124
 125 extern char *gnutarget;
 126
 127 extern void set_gnutarget PARAMS ((char *));
 128
 129 /* Structure to keep track of core register reading functions for
 130    various core file types.  */
 131
 132 struct core_fns {
 133
 134   /* BFD flavour that we handle.  Note that bfd_target_unknown_flavour matches
 135      anything, and if there is no better match, this function will be called
 136      as the default. */
 137
 138   enum bfd_flavour core_flavour;
 139
 140   /* Extract the register values out of the core file and store them where
 141      `read_register' will find them.
 142
 143      CORE_REG_SECT points to the register values themselves, read into
 144      memory.
 145
 146      CORE_REG_SIZE is the size of that area.
 147
 148      WHICH says which set of registers we are handling (0 = int, 2 = float on
 149      machines where they are discontiguous).
 150
 151      REG_ADDR is the offset from u.u_ar0 to the register values relative to
 152      core_reg_sect.  This is used with old-fashioned core files to locate the
 153      registers in a large upage-plus-stack ".reg" section.  Original upage
 154      address X is at location core_reg_sect+x+reg_addr. */
 155
 156   void (*core_read_registers) PARAMS ((char *core_reg_sect, unsigned core_reg_size,
 157                                   int which, CORE_ADDR reg_addr));
 158
 159   /* Finds the next struct core_fns.  They are allocated and initialized
 160      in whatever module implements the functions pointed to; an
 161      initializer calls add_core_fns to add them to the global chain.  */
 162
 163   struct core_fns *next;
 164
 165 };
 166
 167 extern void add_core_fns PARAMS ((struct core_fns *cf));
 168
 169 #endif  /* !defined (GDBCORE_H) */