gdb/config/mips/tm-mips.h

   1 /* Definitions to make GDB run on a mips box under 4.3bsd.
   2    Copyright 1986, 1987, 1989, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
   3    1998, 1999, 2000
   4    Free Software Foundation, Inc.
   5    Contributed by Per Bothner ([email protected]) at U.Wisconsin
   6    and by Alessandro Forin ([email protected]) at CMU..
   7
   8    This file is part of GDB.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 2 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 59 Temple Place - Suite 330,
  23    Boston, MA 02111-1307, USA.  */
  24
  25 #ifndef TM_MIPS_H
  26 #define TM_MIPS_H 1
  27
  28 #define GDB_MULTI_ARCH 1
  29
  30 #include "regcache.h"
  31
  32 struct frame_info;
  33 struct symbol;
  34 struct type;
  35 struct value;
  36
  37 #include <bfd.h>
  38 #include "coff/sym.h"           /* Needed for PDR below.  */
  39 #include "coff/symconst.h"
  40
  41 /* PC should be masked to remove possible MIPS16 flag */
  42 #if !defined (GDB_TARGET_MASK_DISAS_PC)
  43 #define GDB_TARGET_MASK_DISAS_PC(addr) UNMAKE_MIPS16_ADDR(addr)
  44 #endif
  45 #if !defined (GDB_TARGET_UNMASK_DISAS_PC)
  46 #define GDB_TARGET_UNMASK_DISAS_PC(addr) MAKE_MIPS16_ADDR(addr)
  47 #endif
  48
  49 /* The name of the usual type of MIPS processor that is in the target
  50    system.  */
  51
  52 #define DEFAULT_MIPS_TYPE "generic"
  53
  54 /* Offset from address of function to start of its code.
  55    Zero on most machines.  */
  56
  57 #define FUNCTION_START_OFFSET 0
  58
  59 /* Return non-zero if PC points to an instruction which will cause a step
  60    to execute both the instruction at PC and an instruction at PC+4.  */
  61 extern int mips_step_skips_delay (CORE_ADDR);
  62 #define STEP_SKIPS_DELAY_P (1)
  63 #define STEP_SKIPS_DELAY(pc) (mips_step_skips_delay (pc))
  64
  65 /* Are we currently handling a signal */
  66
  67 extern int in_sigtramp (CORE_ADDR, char *);
  68 #define IN_SIGTRAMP(pc, name)   in_sigtramp(pc, name)
  69
  70 /* Say how long (ordinary) registers are.  This is a piece of bogosity
  71    used in push_word and a few other places; REGISTER_RAW_SIZE is the
  72    real way to know how big a register is.  */
  73
  74 #define REGISTER_SIZE 4
  75
  76 /* The size of a register.  This is predefined in tm-mips64.h.  We
  77    can't use REGISTER_SIZE because that is used for various other
  78    things.  */
  79
  80 #ifndef MIPS_REGSIZE
  81 #define MIPS_REGSIZE 4
  82 #endif
  83
  84 /* Number of machine registers */
  85
  86 #ifndef NUM_REGS
  87 #define NUM_REGS 90
  88 #endif
  89
  90 /* Given the register index, return the name of the corresponding
  91    register. */
  92 extern const char *mips_register_name (int regnr);
  93 #define REGISTER_NAME(i) mips_register_name (i)
  94
  95 /* Initializer for an array of names of registers.
  96    There should be NUM_REGS strings in this initializer.  */
  97
  98 #ifndef MIPS_REGISTER_NAMES
  99 #define MIPS_REGISTER_NAMES     \
 100     {   "zero", "at",   "v0",   "v1",   "a0",   "a1",   "a2",   "a3", \
 101         "t0",   "t1",   "t2",   "t3",   "t4",   "t5",   "t6",   "t7", \
 102         "s0",   "s1",   "s2",   "s3",   "s4",   "s5",   "s6",   "s7", \
 103         "t8",   "t9",   "k0",   "k1",   "gp",   "sp",   "s8",   "ra", \
 104         "sr",   "lo",   "hi",   "bad",  "cause","pc",    \
 105         "f0",   "f1",   "f2",   "f3",   "f4",   "f5",   "f6",   "f7", \
 106         "f8",   "f9",   "f10",  "f11",  "f12",  "f13",  "f14",  "f15", \
 107         "f16",  "f17",  "f18",  "f19",  "f20",  "f21",  "f22",  "f23",\
 108         "f24",  "f25",  "f26",  "f27",  "f28",  "f29",  "f30",  "f31",\
 109         "fsr",  "fir",  "fp",   "", \
 110         "",     "",     "",     "",     "",     "",     "",     "", \
 111         "",     "",     "",     "",     "",     "",     "",     "", \
 112     }
 113 #endif
 114
 115 /* Register numbers of various important registers.
 116    Note that some of these values are "real" register numbers,
 117    and correspond to the general registers of the machine,
 118    and some are "phony" register numbers which are too large
 119    to be actual register numbers as far as the user is concerned
 120    but do serve to get the desired values when passed to read_register.  */
 121
 122 #define ZERO_REGNUM 0           /* read-only register, always 0 */
 123 #define V0_REGNUM 2             /* Function integer return value */
 124 #define A0_REGNUM 4             /* Loc of first arg during a subr call */
 125 #define T9_REGNUM 25            /* Contains address of callee in PIC */
 126 #define SP_REGNUM 29            /* Contains address of top of stack */
 127 #define RA_REGNUM 31            /* Contains return address value */
 128 #define PS_REGNUM 32            /* Contains processor status */
 129 #define HI_REGNUM 34            /* Multiple/divide temp */
 130 #define LO_REGNUM 33            /* ... */
 131 #define BADVADDR_REGNUM 35      /* bad vaddr for addressing exception */
 132 #define CAUSE_REGNUM 36         /* describes last exception */
 133 #define PC_REGNUM 37            /* Contains program counter */
 134 #define FP0_REGNUM 38           /* Floating point register 0 (single float) */
 135 #define FPA0_REGNUM (FP0_REGNUM+12)     /* First float argument register */
 136 #define FCRCS_REGNUM 70         /* FP control/status */
 137 #define FCRIR_REGNUM 71         /* FP implementation/revision */
 138 #define FP_REGNUM 72            /* Pseudo register that contains true address of executing stack frame */
 139 #define UNUSED_REGNUM 73        /* Never used, FIXME */
 140 #define FIRST_EMBED_REGNUM 74   /* First CP0 register for embedded use */
 141 #define PRID_REGNUM 89          /* Processor ID */
 142 #define LAST_EMBED_REGNUM 89    /* Last one */
 143
 144 /* Total amount of space needed to store our copies of the machine's
 145    register state, the array `registers'.  */
 146
 147 #define REGISTER_BYTES (NUM_REGS*MIPS_REGSIZE)
 148
 149 /* Index within `registers' of the first byte of the space for
 150    register N.  */
 151
 152 #define REGISTER_BYTE(N) ((N) * MIPS_REGSIZE)
 153
 154 /* Number of bytes of storage in the program's representation
 155    for register N. */
 156
 157 #define REGISTER_VIRTUAL_SIZE(N) TYPE_LENGTH (REGISTER_VIRTUAL_TYPE (N))
 158
 159 /* Return the GDB type object for the "standard" data type of data in
 160    register N.  */
 161
 162 #ifndef REGISTER_VIRTUAL_TYPE
 163 #define REGISTER_VIRTUAL_TYPE(N) \
 164         (((N) >= FP0_REGNUM && (N) < FP0_REGNUM+32) ? builtin_type_float \
 165          : ((N) == 32 /*SR*/) ? builtin_type_uint32 \
 166          : ((N) >= 70 && (N) <= 89) ? builtin_type_uint32 \
 167          : builtin_type_int)
 168 #endif
 169
 170 /* All mips targets store doubles in a register pair with the least
 171    significant register in the lower numbered register.
 172    If the target is big endian, double register values need conversion
 173    between memory and register formats.  */
 174
 175 #define REGISTER_CONVERT_TO_TYPE(n, type, buffer)                       \
 176   do {if (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG                           \
 177           && REGISTER_RAW_SIZE (n) == 4                                 \
 178           && (n) >= FP0_REGNUM && (n) < FP0_REGNUM + 32                 \
 179           && TYPE_CODE(type) == TYPE_CODE_FLT                           \
 180           && TYPE_LENGTH(type) == 8) {                                  \
 181         char __temp[4];                                                 \
 182         memcpy (__temp, ((char *)(buffer))+4, 4);                       \
 183         memcpy (((char *)(buffer))+4, (buffer), 4);                     \
 184         memcpy (((char *)(buffer)), __temp, 4); }} while (0)
 185
 186 #define REGISTER_CONVERT_FROM_TYPE(n, type, buffer)                     \
 187   do {if (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG                           \
 188           && REGISTER_RAW_SIZE (n) == 4                                 \
 189           && (n) >= FP0_REGNUM && (n) < FP0_REGNUM + 32                 \
 190           && TYPE_CODE(type) == TYPE_CODE_FLT                           \
 191           && TYPE_LENGTH(type) == 8) {                                  \
 192         char __temp[4];                                                 \
 193         memcpy (__temp, ((char *)(buffer))+4, 4);                       \
 194         memcpy (((char *)(buffer))+4, (buffer), 4);                     \
 195         memcpy (((char *)(buffer)), __temp, 4); }} while (0)
 196
 197 /* Store the address of the place in which to copy the structure the
 198    subroutine will return.  Handled by mips_push_arguments.  */
 199
 200 #define STORE_STRUCT_RETURN(addr, sp)
 201 /**/
 202
 203 /* Extract from an array REGBUF containing the (raw) register state
 204    a function return value of type TYPE, and copy that, in virtual format,
 205    into VALBUF.  XXX floats */
 206
 207 #define DEPRECATED_EXTRACT_RETURN_VALUE(TYPE,REGBUF,VALBUF) \
 208   mips_extract_return_value(TYPE, REGBUF, VALBUF)
 209 extern void mips_extract_return_value (struct type *, char[], char *);
 210
 211 /* Write into appropriate registers a function return value
 212    of type TYPE, given in virtual format.  */
 213
 214 #define STORE_RETURN_VALUE(TYPE,VALBUF) \
 215   mips_store_return_value(TYPE, VALBUF)
 216 extern void mips_store_return_value (struct type *, char *);
 217
 218 /* Extract from an array REGBUF containing the (raw) register state
 219    the address in which a function should return its structure value,
 220    as a CORE_ADDR (or an expression that can be used as one).  */
 221 /* The address is passed in a0 upon entry to the function, but when
 222    the function exits, the compiler has copied the value to v0.  This
 223    convention is specified by the System V ABI, so I think we can rely
 224    on it.  */
 225
 226 #define DEPRECATED_EXTRACT_STRUCT_VALUE_ADDRESS(REGBUF) \
 227   (extract_address (REGBUF + REGISTER_BYTE (V0_REGNUM), \
 228                     REGISTER_RAW_SIZE (V0_REGNUM)))
 229
 230 \f
 231 /* Describe the pointer in each stack frame to the previous stack frame
 232    (its caller).  */
 233
 234 /* FRAME_CHAIN takes a frame's nominal address
 235    and produces the frame's chain-pointer. */
 236
 237 #define FRAME_CHAIN(thisframe) (CORE_ADDR) mips_frame_chain (thisframe)
 238 extern CORE_ADDR mips_frame_chain (struct frame_info *);
 239
 240 /* Define other aspects of the stack frame.  */
 241
 242
 243 /* A macro that tells us whether the function invocation represented
 244    by FI does not have a frame on the stack associated with it.  If it
 245    does not, FRAMELESS is set to 1, else 0.  */
 246 /* We handle this differently for mips, and maybe we should not */
 247
 248 #define FRAMELESS_FUNCTION_INVOCATION(FI)  (0)
 249
 250 /* Saved Pc.  */
 251
 252 #define FRAME_SAVED_PC(FRAME)   (mips_frame_saved_pc(FRAME))
 253 extern CORE_ADDR mips_frame_saved_pc (struct frame_info *);
 254
 255 #define FRAME_ARGS_ADDRESS(fi)  (fi)->frame
 256
 257 #define FRAME_LOCALS_ADDRESS(fi) (fi)->frame
 258
 259 /* Return number of args passed to a frame.
 260    Can return -1, meaning no way to tell.  */
 261
 262 #define FRAME_NUM_ARGS(fi)      (mips_frame_num_args(fi))
 263 extern int mips_frame_num_args (struct frame_info *);
 264
 265 /* Return number of bytes at start of arglist that are not really args.  */
 266
 267 #define FRAME_ARGS_SKIP 0
 268
 269 \f
 270
 271 /* Things needed for making the inferior call functions.  */
 272
 273 /* Stack must be aligned on 32-bit boundaries when synthesizing
 274    function calls.  We don't need STACK_ALIGN, PUSH_ARGUMENTS will
 275    handle it. */
 276
 277 extern CORE_ADDR mips_push_return_address (CORE_ADDR pc, CORE_ADDR sp);
 278 #define PUSH_RETURN_ADDRESS(PC, SP) (mips_push_return_address ((PC), (SP)))
 279
 280 /* Push an empty stack frame, to record the current PC, etc.  */
 281
 282 #define PUSH_DUMMY_FRAME        mips_push_dummy_frame()
 283 extern void mips_push_dummy_frame (void);
 284
 285 /* Discard from the stack the innermost frame, restoring all registers.  */
 286
 287 #define POP_FRAME               mips_pop_frame()
 288 extern void mips_pop_frame (void);
 289
 290 #define CALL_DUMMY_START_OFFSET (0)
 291
 292 #define CALL_DUMMY_BREAKPOINT_OFFSET (0)
 293
 294 /* When calling functions on Irix 5 (or any MIPS SVR4 ABI compliant
 295    platform), $t9 ($25) (Dest_Reg) contains the address of the callee
 296    (used for PIC).  It doesn't hurt to do this on other systems; $t9
 297    will be ignored.  */
 298 #define FIX_CALL_DUMMY(dummyname, start_sp, fun, nargs, args, rettype, gcc_p) \
 299     write_register(T9_REGNUM, fun)
 300
 301 #define CALL_DUMMY_ADDRESS() (mips_call_dummy_address ())
 302 extern CORE_ADDR mips_call_dummy_address (void);
 303
 304 /* Special symbol found in blocks associated with routines.  We can hang
 305    mips_extra_func_info_t's off of this.  */
 306
 307 #define MIPS_EFI_SYMBOL_NAME "__GDB_EFI_INFO__"
 308 extern void ecoff_relocate_efi (struct symbol *, CORE_ADDR);
 309
 310 /* Specific information about a procedure.
 311    This overlays the MIPS's PDR records,
 312    mipsread.c (ab)uses this to save memory */
 313
 314 typedef struct mips_extra_func_info
 315   {
 316     long numargs;               /* number of args to procedure (was iopt) */
 317     bfd_vma high_addr;          /* upper address bound */
 318     long frame_adjust;          /* offset of FP from SP (used on MIPS16) */
 319     PDR pdr;                    /* Procedure descriptor record */
 320   }
 321  *mips_extra_func_info_t;
 322
 323 extern void mips_init_extra_frame_info (int fromleaf, struct frame_info *);
 324 #define INIT_EXTRA_FRAME_INFO(fromleaf, fci) \
 325   mips_init_extra_frame_info(fromleaf, fci)
 326
 327 extern void mips_print_extra_frame_info (struct frame_info *frame);
 328 #define PRINT_EXTRA_FRAME_INFO(fi) \
 329   mips_print_extra_frame_info (fi)
 330
 331 /* It takes two values to specify a frame on the MIPS.
 332
 333    In fact, the *PC* is the primary value that sets up a frame.  The
 334    PC is looked up to see what function it's in; symbol information
 335    from that function tells us which register is the frame pointer
 336    base, and what offset from there is the "virtual frame pointer".
 337    (This is usually an offset from SP.)  On most non-MIPS machines,
 338    the primary value is the SP, and the PC, if needed, disambiguates
 339    multiple functions with the same SP.  But on the MIPS we can't do
 340    that since the PC is not stored in the same part of the frame every
 341    time.  This does not seem to be a very clever way to set up frames,
 342    but there is nothing we can do about that.  */
 343
 344 #define SETUP_ARBITRARY_FRAME(argc, argv) setup_arbitrary_frame (argc, argv)
 345 extern struct frame_info *setup_arbitrary_frame (int, CORE_ADDR *);
 346
 347 /* Select the default mips disassembler */
 348
 349 #define TM_PRINT_INSN_MACH 0
 350
 351
 352 /* These are defined in mdebugread.c and are used in mips-tdep.c  */
 353 extern CORE_ADDR sigtramp_address, sigtramp_end;
 354 extern void fixup_sigtramp (void);
 355
 356 /* Defined in mips-tdep.c and used in remote-mips.c */
 357 extern char *mips_read_processor_type (void);
 358
 359 /* Functions for dealing with MIPS16 call and return stubs.  */
 360 #define IN_SOLIB_CALL_TRAMPOLINE(pc, name)      mips_in_call_stub (pc, name)
 361 #define IN_SOLIB_RETURN_TRAMPOLINE(pc, name)    mips_in_return_stub (pc, name)
 362 #define SKIP_TRAMPOLINE_CODE(pc)                mips_skip_stub (pc)
 363 #define IGNORE_HELPER_CALL(pc)                  mips_ignore_helper (pc)
 364 extern int mips_in_call_stub (CORE_ADDR pc, char *name);
 365 extern int mips_in_return_stub (CORE_ADDR pc, char *name);
 366 extern CORE_ADDR mips_skip_stub (CORE_ADDR pc);
 367 extern int mips_ignore_helper (CORE_ADDR pc);
 368
 369 #ifndef TARGET_MIPS
 370 #define TARGET_MIPS
 371 #endif
 372
 373 /* Definitions and declarations used by mips-tdep.c and remote-mips.c  */
 374 #define MIPS_INSTLEN 4          /* Length of an instruction */
 375 #define MIPS16_INSTLEN 2        /* Length of an instruction on MIPS16 */
 376 #define MIPS_NUMREGS 32         /* Number of integer or float registers */
 377 typedef unsigned long t_inst;   /* Integer big enough to hold an instruction */
 378
 379 /* MIPS16 function addresses are odd (bit 0 is set).  Here are some
 380    macros to test, set, or clear bit 0 of addresses.  */
 381 #define IS_MIPS16_ADDR(addr)     ((addr) & 1)
 382 #define MAKE_MIPS16_ADDR(addr)   ((addr) | 1)
 383 #define UNMAKE_MIPS16_ADDR(addr) ((addr) & ~1)
 384
 385 #endif /* TM_MIPS_H */
 386
 387 /* Macros for setting and testing a bit in a minimal symbol that
 388    marks it as 16-bit function.  The MSB of the minimal symbol's
 389    "info" field is used for this purpose. This field is already
 390    being used to store the symbol size, so the assumption is
 391    that the symbol size cannot exceed 2^31.
 392
 393    ELF_MAKE_MSYMBOL_SPECIAL
 394    tests whether an ELF symbol is "special", i.e. refers
 395    to a 16-bit function, and sets a "special" bit in a
 396    minimal symbol to mark it as a 16-bit function
 397    MSYMBOL_IS_SPECIAL   tests the "special" bit in a minimal symbol
 398    MSYMBOL_SIZE         returns the size of the minimal symbol, i.e.
 399    the "info" field with the "special" bit masked out
 400  */
 401
 402 #define ELF_MAKE_MSYMBOL_SPECIAL(sym,msym) \
 403  { \
 404   if (((elf_symbol_type *)(sym))->internal_elf_sym.st_other == STO_MIPS16) { \
 405     MSYMBOL_INFO (msym) = (char *) (((long) MSYMBOL_INFO (msym)) | 0x80000000); \
 406     SYMBOL_VALUE_ADDRESS (msym) |= 1; \
 407   } \
 408  }
 409
 410 #define MSYMBOL_IS_SPECIAL(msym) \
 411   (((long) MSYMBOL_INFO (msym) & 0x80000000) != 0)
 412 #define MSYMBOL_SIZE(msym) \
 413   ((long) MSYMBOL_INFO (msym) & 0x7fffffff)
 414
 415
 416 /* Command to set the processor type. */
 417 extern void mips_set_processor_type_command (char *, int);
 418
 419
 420 /* Single step based on where the current instruction will take us.  */
 421 extern void mips_software_single_step (enum target_signal, int);