gdb/config/i386/tm-i386.h

   1 /* Macro definitions for GDB on an Intel i[345]86.
   2    Copyright (C) 1995, 1996, 2000 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 #ifndef TM_I386_H
  22 #define TM_I386_H 1
  23
  24 /* Forward declarations for prototypes.  */
  25 struct frame_info;
  26 struct frame_saved_regs;
  27 struct value;
  28 struct type;
  29
  30 #define TARGET_BYTE_ORDER LITTLE_ENDIAN
  31
  32 /* The format used for `long double' on almost all i386 targets is the
  33    i387 extended floating-point format.  In fact, of all targets in the
  34    GCC 2.95 tree, only OSF/1 does it different, and insists on having
  35    a `long double' that's not `long' at all.  */
  36
  37 #define TARGET_LONG_DOUBLE_FORMAT &floatformat_i387_ext
  38
  39 /* Although the i386 extended floating-point has only 80 significant
  40    bits, a `long double' actually takes up 96, probably to enforce
  41    alignment.  */
  42
  43 #define TARGET_LONG_DOUBLE_BIT 96
  44
  45 /* Used for example in valprint.c:print_floating() to enable checking
  46    for NaN's */
  47
  48 #define IEEE_FLOAT (1)
  49
  50 /* Number of traps that happen between exec'ing the shell to run an
  51    inferior, and when we finally get to the inferior code.  This is 2
  52    on most implementations. */
  53
  54 #define START_INFERIOR_TRAPS_EXPECTED 2
  55
  56 /* Offset from address of function to start of its code.
  57    Zero on most machines.  */
  58
  59 #define FUNCTION_START_OFFSET 0
  60
  61 /* Advance PC across any function entry prologue instructions to reach some
  62    "real" code.  */
  63
  64 #define SKIP_PROLOGUE(frompc)   (i386_skip_prologue (frompc))
  65
  66 extern int i386_skip_prologue (int);
  67
  68 /* Immediately after a function call, return the saved pc.  Can't always go
  69    through the frames for this because on some machines the new frame is not
  70    set up until the new function executes some instructions.  */
  71
  72 #define SAVED_PC_AFTER_CALL(frame) \
  73      (read_memory_unsigned_integer (read_register (SP_REGNUM), 4))
  74
  75 /* Stack grows downward.  */
  76
  77 #define INNER_THAN(lhs,rhs) ((lhs) < (rhs))
  78
  79 /* Sequence of bytes for breakpoint instruction.  */
  80
  81 #define BREAKPOINT {0xcc}
  82
  83 /* Amount PC must be decremented by after a breakpoint.  This is often the
  84    number of bytes in BREAKPOINT but not always. */
  85
  86 #define DECR_PC_AFTER_BREAK 1
  87
  88 /* Say how long (ordinary) registers are.  This is a piece of bogosity
  89    used in push_word and a few other places; REGISTER_RAW_SIZE is the
  90    real way to know how big a register is.  */
  91
  92 #define REGISTER_SIZE 4
  93
  94 /* This register file is parameterized by two macros:
  95    HAVE_I387_REGS --- register file should include i387 registers
  96    HAVE_SSE_REGS  --- register file should include SSE registers
  97    If HAVE_SSE_REGS is #defined, then HAVE_I387_REGS must also be #defined.
  98
  99    However, GDB code should not test those macros with #ifdef, since
 100    that makes code which is annoying to multi-arch.  Instead, GDB code
 101    should check the values of NUM_GREGS, NUM_FREGS, and NUM_SSE_REGS,
 102    which will eventually get mapped onto architecture vector entries.
 103
 104    It's okay to use the macros in tm-*.h files, though, since those
 105    files will get completely replaced when we multi-arch anyway.  */
 106
 107 /* Number of general registers, present on every 32-bit x86 variant.  */
 108 #define NUM_GREGS (16)
 109
 110 /* Number of floating-point unit registers.  */
 111 #ifdef HAVE_I387_REGS
 112 #define NUM_FREGS (16)
 113 #else
 114 #define NUM_FREGS (0)
 115 #endif
 116
 117 /* Number of SSE registers.  */
 118 #ifdef HAVE_SSE_REGS
 119 #define NUM_SSE_REGS (9)
 120 #else
 121 #define NUM_SSE_REGS (0)
 122 #endif
 123
 124 #define NUM_REGS (NUM_GREGS + NUM_FREGS + NUM_SSE_REGS)
 125
 126 /* Largest number of registers we could have in any configuration.  */
 127 #define MAX_NUM_REGS (16 + 16 + 9)
 128
 129 /* Initializer for an array of names of registers.  There should be at least
 130    NUM_REGS strings in this initializer.  Any excess ones are simply ignored.
 131    The order of the first 8 registers must match the compiler's numbering
 132    scheme (which is the same as the 386 scheme) and also regmap in the various
 133    *-nat.c files. */
 134
 135 #define REGISTER_NAMES { "eax",   "ecx",    "edx",   "ebx",     \
 136                          "esp",   "ebp",    "esi",   "edi",     \
 137                          "eip",   "eflags", "cs",    "ss",      \
 138                          "ds",    "es",     "fs",    "gs",      \
 139                          "st0",   "st1",    "st2",   "st3",     \
 140                          "st4",   "st5",    "st6",   "st7",     \
 141                          "fctrl", "fstat",  "ftag",  "fiseg",   \
 142                          "fioff", "foseg",  "fooff", "fop",     \
 143                          "xmm0",  "xmm1",   "xmm2",  "xmm3",    \
 144                          "xmm4",  "xmm5",   "xmm6",  "xmm7",    \
 145                          "mxcsr"                                \
 146                        }
 147
 148 /* Register numbers of various important registers.
 149    Note that some of these values are "real" register numbers,
 150    and correspond to the general registers of the machine,
 151    and some are "phony" register numbers which are too large
 152    to be actual register numbers as far as the user is concerned
 153    but do serve to get the desired values when passed to read_register.  */
 154
 155 #define FP_REGNUM 5             /* (ebp) Contains address of executing stack
 156                                    frame */
 157 #define SP_REGNUM 4             /* (usp) Contains address of top of stack */
 158 #define PC_REGNUM 8             /* (eip) Contains program counter */
 159 #define PS_REGNUM 9             /* (ps)  Contains processor status */
 160
 161 /* These registers are present only if HAVE_I387_REGS is #defined.
 162    We promise that FP0 .. FP7 will always be consecutive register numbers.  */
 163 #define FP0_REGNUM   16         /* first FPU floating-point register */
 164 #define FP7_REGNUM   23         /* last  FPU floating-point register */
 165
 166 /* All of these control registers (except for FCOFF and FDOFF) are
 167    sixteen bits long (at most) in the FPU, but are zero-extended to
 168    thirty-two bits in GDB's register file.  This makes it easier to
 169    compute the size of the control register file, and somewhat easier
 170    to convert to and from the FSAVE instruction's 32-bit format.  */
 171 #define FIRST_FPU_CTRL_REGNUM 24
 172 #define FCTRL_REGNUM 24         /* FPU control word */
 173 #define FPC_REGNUM   24         /* old name for FCTRL_REGNUM */
 174 #define FSTAT_REGNUM 25         /* FPU status word */
 175 #define FTAG_REGNUM  26         /* FPU register tag word */
 176 #define FCS_REGNUM   27         /* FPU instruction's code segment selector
 177                                    16 bits, called "FPU Instruction Pointer
 178                                    Selector" in the x86 manuals  */
 179 #define FCOFF_REGNUM 28         /* FPU instruction's offset within segment
 180                                    ("Fpu Code OFFset") */
 181 #define FDS_REGNUM   29         /* FPU operand's data segment */
 182 #define FDOFF_REGNUM 30         /* FPU operand's offset within segment */
 183 #define FOP_REGNUM   31         /* FPU opcode, bottom eleven bits */
 184 #define LAST_FPU_CTRL_REGNUM 31
 185
 186 /* These registers are present only if HAVE_SSE_REGS is #defined.
 187    We promise that XMM0 .. XMM7 will always have consecutive reg numbers. */
 188 #define XMM0_REGNUM  32         /* first SSE data register */
 189 #define XMM7_REGNUM  39         /* last  SSE data register */
 190 #define MXCSR_REGNUM 40         /* Streaming SIMD Extension control/status */
 191
 192 #define IS_FP_REGNUM(n) (FP0_REGNUM <= (n) && (n) <= FP7_REGNUM)
 193 #define IS_SSE_REGNUM(n) (XMM0_REGNUM <= (n) && (n) <= XMM7_REGNUM)
 194
 195 #define FPU_REG_RAW_SIZE (10)
 196
 197 /* Sizes of individual register sets.  These cover the entire register
 198    file, so summing up the sizes of those portions actually present
 199    yields REGISTER_BYTES.  */
 200 #define SIZEOF_GREGS (NUM_GREGS * 4)
 201 #define SIZEOF_FPU_REGS (8 * FPU_REG_RAW_SIZE)
 202 #define SIZEOF_FPU_CTRL_REGS \
 203   ((LAST_FPU_CTRL_REGNUM - FIRST_FPU_CTRL_REGNUM + 1) * 4)
 204 #define SIZEOF_SSE_REGS (8 * 16 + 4)
 205
 206
 207 /* Total amount of space needed to store our copies of the machine's register
 208    state, the array `registers'. */
 209 #ifdef HAVE_SSE_REGS
 210 #define REGISTER_BYTES \
 211   (SIZEOF_GREGS + SIZEOF_FPU_REGS + SIZEOF_FPU_CTRL_REGS + SIZEOF_SSE_REGS)
 212 #else
 213 #ifdef HAVE_I387_REGS
 214 #define REGISTER_BYTES (SIZEOF_GREGS + SIZEOF_FPU_REGS + SIZEOF_FPU_CTRL_REGS)
 215 #else
 216 #define REGISTER_BYTES (SIZEOF_GREGS)
 217 #endif
 218 #endif
 219
 220 /* Index within `registers' of the first byte of the space for register N. */
 221 #define REGISTER_BYTE(n) (i386_register_byte[(n)])
 222 extern int i386_register_byte[];
 223
 224 /* Number of bytes of storage in the actual machine representation for
 225    register N.  */
 226 #define REGISTER_RAW_SIZE(n) (i386_register_raw_size[(n)])
 227 extern int i386_register_raw_size[];
 228
 229 /* Largest value REGISTER_RAW_SIZE can have.  */
 230 #define MAX_REGISTER_RAW_SIZE 16
 231
 232 /* Number of bytes of storage in the program's representation
 233    for register N. */
 234 #define REGISTER_VIRTUAL_SIZE(n) (i386_register_virtual_size[(n)])
 235 extern int i386_register_virtual_size[];
 236
 237 /* Largest value REGISTER_VIRTUAL_SIZE can have.  */
 238 #define MAX_REGISTER_VIRTUAL_SIZE 16
 239
 240 /* Return the GDB type object for the "standard" data type of data in
 241    register N.  Perhaps si and di should go here, but potentially they
 242    could be used for things other than address.  */
 243
 244 #define REGISTER_VIRTUAL_TYPE(N)                                \
 245   (((N) == PC_REGNUM || (N) == FP_REGNUM || (N) == SP_REGNUM)   \
 246    ? lookup_pointer_type (builtin_type_void)                    \
 247    : IS_FP_REGNUM(N) ? builtin_type_long_double                 \
 248    : IS_SSE_REGNUM(N) ? builtin_type_v4sf                       \
 249    : builtin_type_int)
 250
 251 /* REGISTER_CONVERTIBLE(N) is true iff register N's virtual format is
 252    different from its raw format.  Note that this definition assumes
 253    that the host supports IEEE 32-bit floats, since it doesn't say
 254    that SSE registers need conversion.  Even if we can't find a
 255    counterexample, this is still sloppy.  */
 256 #define REGISTER_CONVERTIBLE(n) (IS_FP_REGNUM (n))
 257
 258 /* Convert data from raw format for register REGNUM in buffer FROM to
 259    virtual format with type TYPE in buffer TO.  */
 260
 261 #define REGISTER_CONVERT_TO_VIRTUAL(regnum, type, from, to) \
 262   i386_register_convert_to_virtual ((regnum), (type), (from), (to));
 263 extern void i386_register_convert_to_virtual (int regnum, struct type *type,
 264                                               char *from, char *to);
 265
 266 /* Convert data from virtual format with type TYPE in buffer FROM to
 267    raw format for register REGNUM in buffer TO.  */
 268
 269 #define REGISTER_CONVERT_TO_RAW(type, regnum, from, to) \
 270   i386_register_convert_to_raw ((type), (regnum), (from), (to));
 271 extern void i386_register_convert_to_raw (struct type *type, int regnum,
 272                                           char *from, char *to);
 273
 274 /* Print out the i387 floating point state.  */
 275 #ifdef HAVE_I387_REGS
 276 extern void i387_float_info (void);
 277 #define FLOAT_INFO { i387_float_info (); }
 278 #endif
 279
 280 \f
 281 /* Store the address of the place in which to copy the structure the
 282    subroutine will return.  This is called from call_function. */
 283
 284 #define STORE_STRUCT_RETURN(ADDR, SP) \
 285   { char buf[REGISTER_SIZE];    \
 286     (SP) -= sizeof (ADDR);      \
 287     store_address (buf, sizeof (ADDR), ADDR);   \
 288     write_memory ((SP), buf, sizeof (ADDR)); }
 289
 290 /* Extract from an array REGBUF containing the (raw) register state
 291    a function return value of type TYPE, and copy that, in virtual format,
 292    into VALBUF.  */
 293
 294 #define EXTRACT_RETURN_VALUE(type, regbuf, valbuf) \
 295   i386_extract_return_value ((type), (regbuf), (valbuf))
 296 extern void i386_extract_return_value (struct type *type, char *regbuf,
 297                                        char *valbuf);
 298
 299 /* Write into appropriate registers a function return value of type TYPE, given
 300    in virtual format.  */
 301
 302 #define STORE_RETURN_VALUE(TYPE,VALBUF) \
 303   {                                                                          \
 304     if (TYPE_CODE (TYPE) == TYPE_CODE_FLT)                                   \
 305       write_register_bytes (REGISTER_BYTE (FP0_REGNUM), (VALBUF),            \
 306                             TYPE_LENGTH (TYPE));                             \
 307     else                                                                     \
 308       write_register_bytes (0, (VALBUF), TYPE_LENGTH (TYPE));                \
 309   }
 310
 311 /* Extract from an array REGBUF containing the (raw) register state the address
 312    in which a function should return its structure value, as a CORE_ADDR (or an
 313    expression that can be used as one).  */
 314
 315 #define EXTRACT_STRUCT_VALUE_ADDRESS(REGBUF) (*(int *)(REGBUF))
 316
 317 /* The following redefines make backtracing through sigtramp work.
 318    They manufacture a fake sigtramp frame and obtain the saved pc in sigtramp
 319    from the sigcontext structure which is pushed by the kernel on the
 320    user stack, along with a pointer to it.  */
 321
 322 /* FRAME_CHAIN takes a frame's nominal address and produces the frame's
 323    chain-pointer.
 324    In the case of the i386, the frame's nominal address
 325    is the address of a 4-byte word containing the calling frame's address.  */
 326
 327 #define FRAME_CHAIN(thisframe)  \
 328   ((thisframe)->signal_handler_caller \
 329    ? (thisframe)->frame \
 330    : (!inside_entry_file ((thisframe)->pc) \
 331       ? read_memory_unsigned_integer ((thisframe)->frame, 4) \
 332       : 0))
 333
 334 /* A macro that tells us whether the function invocation represented
 335    by FI does not have a frame on the stack associated with it.  If it
 336    does not, FRAMELESS is set to 1, else 0.  */
 337
 338 #define FRAMELESS_FUNCTION_INVOCATION(FI) \
 339      (((FI)->signal_handler_caller) ? 0 : frameless_look_for_prologue(FI))
 340
 341 /* Saved Pc.  Get it from sigcontext if within sigtramp.  */
 342
 343 #define FRAME_SAVED_PC(FRAME) \
 344   (((FRAME)->signal_handler_caller \
 345     ? sigtramp_saved_pc (FRAME) \
 346     : read_memory_unsigned_integer ((FRAME)->frame + 4, 4)) \
 347    )
 348
 349 extern CORE_ADDR sigtramp_saved_pc (struct frame_info *);
 350
 351 #define FRAME_ARGS_ADDRESS(fi) ((fi)->frame)
 352
 353 #define FRAME_LOCALS_ADDRESS(fi) ((fi)->frame)
 354
 355 /* Return number of args passed to a frame.  Can return -1, meaning no way
 356    to tell, which is typical now that the C compiler delays popping them.  */
 357
 358 #define FRAME_NUM_ARGS(fi) (i386_frame_num_args(fi))
 359
 360 extern int i386_frame_num_args (struct frame_info *);
 361
 362 /* Return number of bytes at start of arglist that are not really args.  */
 363
 364 #define FRAME_ARGS_SKIP 8
 365
 366 /* Put here the code to store, into a struct frame_saved_regs,
 367    the addresses of the saved registers of frame described by FRAME_INFO.
 368    This includes special registers such as pc and fp saved in special
 369    ways in the stack frame.  sp is even more special:
 370    the address we return for it IS the sp for the next frame.  */
 371
 372 extern void i386_frame_init_saved_regs (struct frame_info *);
 373 #define FRAME_INIT_SAVED_REGS(FI) i386_frame_init_saved_regs (FI)
 374
 375 \f
 376
 377 /* Things needed for making the inferior call functions.  */
 378
 379 /* "An argument's size is increased, if necessary, to make it a
 380    multiple of [32 bit] words.  This may require tail padding,
 381    depending on the size of the argument" - from the x86 ABI.  */
 382 #define PARM_BOUNDARY 32
 383
 384 /* Push an empty stack frame, to record the current PC, etc.  */
 385
 386 #define PUSH_DUMMY_FRAME { i386_push_dummy_frame (); }
 387
 388 extern void i386_push_dummy_frame (void);
 389
 390 /* Discard from the stack the innermost frame, restoring all registers.  */
 391
 392 #define POP_FRAME  { i386_pop_frame (); }
 393
 394 extern void i386_pop_frame (void);
 395 \f
 396
 397 /* this is
 398  *   call 11223344 (32 bit relative)
 399  *   int3
 400  */
 401
 402 #define CALL_DUMMY { 0x223344e8, 0xcc11 }
 403
 404 #define CALL_DUMMY_LENGTH 8
 405
 406 #define CALL_DUMMY_START_OFFSET 0       /* Start execution at beginning of dummy */
 407
 408 #define CALL_DUMMY_BREAKPOINT_OFFSET 5
 409
 410 /* Insert the specified number of args and function address
 411    into a call sequence of the above form stored at DUMMYNAME.  */
 412
 413 #define FIX_CALL_DUMMY(dummyname, pc, fun, nargs, args, type, gcc_p) \
 414   i386_fix_call_dummy (dummyname, pc, fun, nargs, args, type, gcc_p)
 415 extern void i386_fix_call_dummy (char *dummy, CORE_ADDR pc, CORE_ADDR fun,
 416                                  int nargs, struct value **args,
 417                                  struct type *type, int gcc_p);
 418
 419 /* FIXME: kettenis/2000-06-12: These do not belong here.  */
 420 extern void print_387_control_word (unsigned int);
 421 extern void print_387_status_word (unsigned int);
 422
 423 /* Offset from SP to first arg on stack at first instruction of a function */
 424
 425 #define SP_ARG0 (1 * 4)
 426
 427 #endif /* ifndef TM_I386_H */