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 /* Number of traps that happen between exec'ing the shell to run an
  36    inferior, and when we finally get to the inferior code.  This is 2
  37    on most implementations. */
  38
  39 #define START_INFERIOR_TRAPS_EXPECTED 2
  40
  41 /* Offset from address of function to start of its code.
  42    Zero on most machines.  */
  43
  44 #define FUNCTION_START_OFFSET 0
  45
  46 /* Advance PC across any function entry prologue instructions to reach some
  47    "real" code.  */
  48
  49 #define SKIP_PROLOGUE(frompc)   (i386_skip_prologue (frompc))
  50
  51 extern int i386_skip_prologue (int);
  52
  53 /* Stack grows downward.  */
  54
  55 #define INNER_THAN(lhs,rhs) ((lhs) < (rhs))
  56
  57 /* Sequence of bytes for breakpoint instruction.  */
  58
  59 #define BREAKPOINT {0xcc}
  60
  61 /* Amount PC must be decremented by after a breakpoint.  This is often the
  62    number of bytes in BREAKPOINT but not always. */
  63
  64 #define DECR_PC_AFTER_BREAK 1
  65
  66 /* Say how long (ordinary) registers are.  This is a piece of bogosity
  67    used in push_word and a few other places; REGISTER_RAW_SIZE is the
  68    real way to know how big a register is.  */
  69
  70 #define REGISTER_SIZE 4
  71
  72 /* This register file is parameterized by two macros:
  73    HAVE_I387_REGS --- register file should include i387 registers
  74    HAVE_SSE_REGS  --- register file should include SSE registers
  75    If HAVE_SSE_REGS is #defined, then HAVE_I387_REGS must also be #defined.
  76
  77    However, GDB code should not test those macros with #ifdef, since
  78    that makes code which is annoying to multi-arch.  Instead, GDB code
  79    should check the values of NUM_GREGS, NUM_FREGS, and NUM_SSE_REGS,
  80    which will eventually get mapped onto architecture vector entries.
  81
  82    It's okay to use the macros in tm-*.h files, though, since those
  83    files will get completely replaced when we multi-arch anyway.  */
  84
  85 /* Number of general registers, present on every 32-bit x86 variant.  */
  86 #define NUM_GREGS (16)
  87
  88 /* Number of floating-point unit registers.  */
  89 #ifdef HAVE_I387_REGS
  90 #define NUM_FREGS (16)
  91 #else
  92 #define NUM_FREGS (0)
  93 #endif
  94
  95 /* Number of SSE registers.  */
  96 #ifdef HAVE_SSE_REGS
  97 #define NUM_SSE_REGS (9)
  98 #else
  99 #define NUM_SSE_REGS (0)
 100 #endif
 101
 102 /* Largest number of registers we could have in any configuration.  */
 103 #define MAX_NUM_REGS (16 + 16 + 9 + 1)
 104
 105 /* Register numbers of various important registers.
 106    Note that some of these values are "real" register numbers,
 107    and correspond to the general registers of the machine,
 108    and some are "phony" register numbers which are too large
 109    to be actual register numbers as far as the user is concerned
 110    but do serve to get the desired values when passed to read_register.  */
 111
 112 #define FP_REGNUM 5             /* (ebp) Contains address of executing stack
 113                                    frame */
 114 #define SP_REGNUM 4             /* (usp) Contains address of top of stack */
 115 #define PC_REGNUM 8             /* (eip) Contains program counter */
 116 #define PS_REGNUM 9             /* (ps)  Contains processor status */
 117
 118 /* First FPU data register.  */
 119 #ifdef HAVE_I387_REGS
 120 #define FP0_REGNUM 16
 121 #else
 122 #define FP0_REGNUM 0
 123 #endif
 124 \f
 125
 126 /* Largest value REGISTER_RAW_SIZE can have.  */
 127 #define MAX_REGISTER_RAW_SIZE 16
 128
 129 /* Return the size in bytes of the virtual type of register REG.  */
 130 #define REGISTER_VIRTUAL_SIZE(reg) i386_register_virtual_size ((reg))
 131 extern int i386_register_virtual_size (int reg);
 132
 133 /* Largest value REGISTER_VIRTUAL_SIZE can have.  */
 134 #define MAX_REGISTER_VIRTUAL_SIZE 16
 135
 136 /* Return the GDB type object for the "standard" data type of data in
 137    register REGNUM.  */
 138
 139 #define REGISTER_VIRTUAL_TYPE(regnum) i386_register_virtual_type (regnum)
 140 extern struct type *i386_register_virtual_type (int regnum);
 141
 142 /* Return true iff register REGNUM's virtual format is different from
 143    its raw format.  */
 144
 145 #define REGISTER_CONVERTIBLE(regnum) i386_register_convertible (regnum)
 146 extern int i386_register_convertible (int regnum);
 147
 148 /* Convert data from raw format for register REGNUM in buffer FROM to
 149    virtual format with type TYPE in buffer TO.  */
 150
 151 #define REGISTER_CONVERT_TO_VIRTUAL(regnum, type, from, to) \
 152   i386_register_convert_to_virtual ((regnum), (type), (from), (to))
 153 extern void i386_register_convert_to_virtual (int regnum, struct type *type,
 154                                               char *from, char *to);
 155
 156 /* Convert data from virtual format with type TYPE in buffer FROM to
 157    raw format for register REGNUM in buffer TO.  */
 158
 159 #define REGISTER_CONVERT_TO_RAW(type, regnum, from, to) \
 160   i386_register_convert_to_raw ((type), (regnum), (from), (to))
 161 extern void i386_register_convert_to_raw (struct type *type, int regnum,
 162                                           char *from, char *to);
 163
 164 /* Print out the i387 floating point state.  */
 165 #ifdef HAVE_I387_REGS
 166 extern void i387_float_info (void);
 167 #define FLOAT_INFO { i387_float_info (); }
 168 #endif
 169 \f
 170
 171 #define PUSH_ARGUMENTS(nargs, args, sp, struct_return, struct_addr) \
 172   i386_push_arguments ((nargs), (args), (sp), (struct_return), (struct_addr))
 173 extern CORE_ADDR i386_push_arguments (int nargs, struct value **args,
 174                                       CORE_ADDR sp, int struct_return,
 175                                       CORE_ADDR struct_addr);
 176
 177 /* Store the address of the place in which to copy the structure the
 178    subroutine will return.  This is called from call_function.  */
 179
 180 #define STORE_STRUCT_RETURN(addr, sp) \
 181   i386_store_struct_return ((addr), (sp))
 182 extern void i386_store_struct_return (CORE_ADDR addr, CORE_ADDR sp);
 183
 184 /* Extract from an array REGBUF containing the (raw) register state
 185    a function return value of type TYPE, and copy that, in virtual format,
 186    into VALBUF.  */
 187
 188 #define EXTRACT_RETURN_VALUE(type, regbuf, valbuf) \
 189   i386_extract_return_value ((type), (regbuf), (valbuf))
 190 extern void i386_extract_return_value (struct type *type, char *regbuf,
 191                                        char *valbuf);
 192
 193 /* Write into the appropriate registers a function return value stored
 194    in VALBUF of type TYPE, given in virtual format.  */
 195
 196 #define STORE_RETURN_VALUE(type, valbuf) \
 197   i386_store_return_value ((type), (valbuf))
 198 extern void i386_store_return_value (struct type *type, char *valbuf);
 199
 200 /* Extract from an array REGBUF containing the (raw) register state
 201    the address in which a function should return its structure value,
 202    as a CORE_ADDR.  */
 203
 204 #define EXTRACT_STRUCT_VALUE_ADDRESS(regbuf) \
 205   i386_extract_struct_value_address ((regbuf))
 206 extern CORE_ADDR i386_extract_struct_value_address (char *regbuf);
 207
 208 /* Determine whether the function invocation represented by FRAME does
 209    not have a from on the stack associated with it.  If it does not,
 210    return non-zero, otherwise return zero.  */
 211
 212 #define FRAMELESS_FUNCTION_INVOCATION(frame) \
 213   i386_frameless_function_invocation (frame)
 214 extern int i386_frameless_function_invocation (struct frame_info *frame);
 215
 216 #define FRAME_ARGS_ADDRESS(fi) ((fi)->frame)
 217
 218 #define FRAME_LOCALS_ADDRESS(fi) ((fi)->frame)
 219
 220 /* Return number of args passed to a frame.  Can return -1, meaning no way
 221    to tell, which is typical now that the C compiler delays popping them.  */
 222
 223 #define FRAME_NUM_ARGS(fi) (i386_frame_num_args(fi))
 224
 225 extern int i386_frame_num_args (struct frame_info *);
 226
 227 /* Return number of bytes at start of arglist that are not really args.  */
 228
 229 #define FRAME_ARGS_SKIP 8
 230
 231 /* Put here the code to store, into a struct frame_saved_regs,
 232    the addresses of the saved registers of frame described by FRAME_INFO.
 233    This includes special registers such as pc and fp saved in special
 234    ways in the stack frame.  sp is even more special:
 235    the address we return for it IS the sp for the next frame.  */
 236
 237 extern void i386_frame_init_saved_regs (struct frame_info *);
 238 #define FRAME_INIT_SAVED_REGS(FI) i386_frame_init_saved_regs (FI)
 239
 240 \f
 241
 242 /* Things needed for making the inferior call functions.  */
 243
 244 /* "An argument's size is increased, if necessary, to make it a
 245    multiple of [32 bit] words.  This may require tail padding,
 246    depending on the size of the argument" - from the x86 ABI.  */
 247 #define PARM_BOUNDARY 32
 248
 249 /* Push an empty stack frame, to record the current PC, etc.  */
 250
 251 #define PUSH_DUMMY_FRAME { i386_push_dummy_frame (); }
 252
 253 extern void i386_push_dummy_frame (void);
 254
 255 /* Discard from the stack the innermost frame, restoring all registers.  */
 256
 257 #define POP_FRAME  { i386_pop_frame (); }
 258
 259 extern void i386_pop_frame (void);
 260 \f
 261
 262 /* this is
 263  *   call 11223344 (32 bit relative)
 264  *   int3
 265  */
 266
 267 #define CALL_DUMMY { 0x223344e8, 0xcc11 }
 268
 269 #define CALL_DUMMY_LENGTH 8
 270
 271 #define CALL_DUMMY_START_OFFSET 0       /* Start execution at beginning of dummy */
 272
 273 #define CALL_DUMMY_BREAKPOINT_OFFSET 5
 274
 275 /* Insert the specified number of args and function address
 276    into a call sequence of the above form stored at DUMMYNAME.  */
 277
 278 #define FIX_CALL_DUMMY(dummyname, pc, fun, nargs, args, type, gcc_p) \
 279   i386_fix_call_dummy (dummyname, pc, fun, nargs, args, type, gcc_p)
 280 extern void i386_fix_call_dummy (char *dummy, CORE_ADDR pc, CORE_ADDR fun,
 281                                  int nargs, struct value **args,
 282                                  struct type *type, int gcc_p);
 283
 284 /* FIXME: kettenis/2000-06-12: These do not belong here.  */
 285 extern void print_387_control_word (unsigned int);
 286 extern void print_387_status_word (unsigned int);
 287
 288 /* Offset from SP to first arg on stack at first instruction of a function */
 289
 290 #define SP_ARG0 (1 * 4)
 291
 292 #endif /* ifndef TM_I386_H */