gdb/config/i386/tm-i386.h

   1 /* Macro definitions for GDB on an Intel i[345]86.
   2    Copyright 1995, 1996, 1998, 1999, 2000, 2001
   3    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 #ifndef TM_I386_H
  23 #define TM_I386_H 1
  24
  25 #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PARTIAL
  26
  27 #include "regcache.h"
  28
  29 /* Forward declarations for prototypes.  */
  30 struct frame_info;
  31 struct frame_saved_regs;
  32 struct value;
  33 struct type;
  34
  35 /* Offset from address of function to start of its code.
  36    Zero on most machines.  */
  37
  38 #define FUNCTION_START_OFFSET 0
  39
  40 /* Advance PC across any function entry prologue instructions to reach some
  41    "real" code.  */
  42
  43 #define SKIP_PROLOGUE(frompc)   (i386_skip_prologue (frompc))
  44
  45 extern int i386_skip_prologue (int);
  46
  47 /* Stack grows downward.  */
  48
  49 #define INNER_THAN(lhs,rhs) ((lhs) < (rhs))
  50
  51 /* Sequence of bytes for breakpoint instruction.  */
  52
  53 #define BREAKPOINT {0xcc}
  54
  55 /* Amount PC must be decremented by after a breakpoint.  This is often the
  56    number of bytes in BREAKPOINT but not always. */
  57
  58 #define DECR_PC_AFTER_BREAK 1
  59 \f
  60
  61 /* Return the GDB type object for the "standard" data type of data in
  62    register REGNUM.  */
  63
  64 #define REGISTER_VIRTUAL_TYPE(regnum) i386_register_virtual_type (regnum)
  65 extern struct type *i386_register_virtual_type (int regnum);
  66
  67 /* Return true iff register REGNUM's virtual format is different from
  68    its raw format.  */
  69
  70 #define REGISTER_CONVERTIBLE(regnum) i386_register_convertible (regnum)
  71 extern int i386_register_convertible (int regnum);
  72
  73 /* Convert data from raw format for register REGNUM in buffer FROM to
  74    virtual format with type TYPE in buffer TO.  */
  75
  76 #define REGISTER_CONVERT_TO_VIRTUAL(regnum, type, from, to) \
  77   i386_register_convert_to_virtual ((regnum), (type), (from), (to))
  78 extern void i386_register_convert_to_virtual (int regnum, struct type *type,
  79                                               char *from, char *to);
  80
  81 /* Convert data from virtual format with type TYPE in buffer FROM to
  82    raw format for register REGNUM in buffer TO.  */
  83
  84 #define REGISTER_CONVERT_TO_RAW(type, regnum, from, to) \
  85   i386_register_convert_to_raw ((type), (regnum), (from), (to))
  86 extern void i386_register_convert_to_raw (struct type *type, int regnum,
  87                                           char *from, char *to);
  88
  89 /* Print out the i387 floating point state.  */
  90 #ifdef HAVE_I387_REGS
  91 extern void i387_float_info (void);
  92 #define FLOAT_INFO { i387_float_info (); }
  93 #endif
  94 \f
  95
  96 #define PUSH_ARGUMENTS(nargs, args, sp, struct_return, struct_addr) \
  97   i386_push_arguments ((nargs), (args), (sp), (struct_return), (struct_addr))
  98 extern CORE_ADDR i386_push_arguments (int nargs, struct value **args,
  99                                       CORE_ADDR sp, int struct_return,
 100                                       CORE_ADDR struct_addr);
 101
 102 /* Store the address of the place in which to copy the structure the
 103    subroutine will return.  This is called from call_function.  */
 104
 105 #define STORE_STRUCT_RETURN(addr, sp) \
 106   i386_store_struct_return ((addr), (sp))
 107 extern void i386_store_struct_return (CORE_ADDR addr, CORE_ADDR sp);
 108
 109 /* Extract from an array REGBUF containing the (raw) register state
 110    a function return value of type TYPE, and copy that, in virtual format,
 111    into VALBUF.  */
 112
 113 #define DEPRECATED_EXTRACT_RETURN_VALUE(type, regbuf, valbuf) \
 114   i386_extract_return_value ((type), (regbuf), (valbuf))
 115 extern void i386_extract_return_value (struct type *type, char *regbuf,
 116                                        char *valbuf);
 117
 118 /* Write into the appropriate registers a function return value stored
 119    in VALBUF of type TYPE, given in virtual format.  */
 120
 121 #define STORE_RETURN_VALUE(type, valbuf) \
 122   i386_store_return_value ((type), (valbuf))
 123 extern void i386_store_return_value (struct type *type, char *valbuf);
 124
 125 /* Extract from an array REGBUF containing the (raw) register state
 126    the address in which a function should return its structure value,
 127    as a CORE_ADDR.  */
 128
 129 #define DEPRECATED_EXTRACT_STRUCT_VALUE_ADDRESS(regbuf) \
 130   i386_extract_struct_value_address ((regbuf))
 131 extern CORE_ADDR i386_extract_struct_value_address (char *regbuf);
 132
 133 /* Determine whether the function invocation represented by FRAME does
 134    not have a from on the stack associated with it.  If it does not,
 135    return non-zero, otherwise return zero.  */
 136
 137 #define FRAMELESS_FUNCTION_INVOCATION(frame) \
 138   i386_frameless_function_invocation (frame)
 139 extern int i386_frameless_function_invocation (struct frame_info *frame);
 140
 141 #define FRAME_ARGS_ADDRESS(fi) ((fi)->frame)
 142
 143 #define FRAME_LOCALS_ADDRESS(fi) ((fi)->frame)
 144
 145 /* Return number of args passed to a frame.  Can return -1, meaning no way
 146    to tell, which is typical now that the C compiler delays popping them.  */
 147
 148 #define FRAME_NUM_ARGS(fi) (i386_frame_num_args(fi))
 149
 150 extern int i386_frame_num_args (struct frame_info *);
 151
 152 /* Return number of bytes at start of arglist that are not really args.  */
 153
 154 #define FRAME_ARGS_SKIP 8
 155
 156 /* Put here the code to store, into a struct frame_saved_regs,
 157    the addresses of the saved registers of frame described by FRAME_INFO.
 158    This includes special registers such as pc and fp saved in special
 159    ways in the stack frame.  sp is even more special:
 160    the address we return for it IS the sp for the next frame.  */
 161
 162 extern void i386_frame_init_saved_regs (struct frame_info *);
 163 #define FRAME_INIT_SAVED_REGS(FI) i386_frame_init_saved_regs (FI)
 164
 165 \f
 166
 167 /* Things needed for making the inferior call functions.  */
 168
 169 /* "An argument's size is increased, if necessary, to make it a
 170    multiple of [32 bit] words.  This may require tail padding,
 171    depending on the size of the argument" - from the x86 ABI.  */
 172 #define PARM_BOUNDARY 32
 173
 174 /* Push an empty stack frame, to record the current PC, etc.  */
 175
 176 #define PUSH_DUMMY_FRAME { i386_push_dummy_frame (); }
 177
 178 extern void i386_push_dummy_frame (void);
 179
 180 /* Discard from the stack the innermost frame, restoring all registers.  */
 181
 182 #define POP_FRAME  { i386_pop_frame (); }
 183
 184 extern void i386_pop_frame (void);
 185 \f
 186
 187 /* this is
 188  *   call 11223344 (32 bit relative)
 189  *   int3
 190  */
 191
 192 #define CALL_DUMMY { 0x223344e8, 0xcc11 }
 193
 194 #define CALL_DUMMY_LENGTH 8
 195
 196 #define CALL_DUMMY_START_OFFSET 0       /* Start execution at beginning of dummy */
 197
 198 #define CALL_DUMMY_BREAKPOINT_OFFSET 5
 199
 200 /* Insert the specified number of args and function address
 201    into a call sequence of the above form stored at DUMMYNAME.  */
 202
 203 #define FIX_CALL_DUMMY(dummyname, pc, fun, nargs, args, type, gcc_p) \
 204   i386_fix_call_dummy (dummyname, pc, fun, nargs, args, type, gcc_p)
 205 extern void i386_fix_call_dummy (char *dummy, CORE_ADDR pc, CORE_ADDR fun,
 206                                  int nargs, struct value **args,
 207                                  struct type *type, int gcc_p);
 208
 209 /* FIXME: kettenis/2000-06-12: These do not belong here.  */
 210 extern void print_387_control_word (unsigned int);
 211 extern void print_387_status_word (unsigned int);
 212
 213 /* Offset from SP to first arg on stack at first instruction of a function */
 214
 215 #define SP_ARG0 (1 * 4)
 216
 217 #endif /* ifndef TM_I386_H */