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