jit/powerpc/ppc.h

   1 /* ppc.h -- Header file for PowerPC opcode table
   2    Copyright 1994, 1995, 1999, 2000, 2001, 2002
   3    Free Software Foundation, Inc.
   4    Written by Ian Lance Taylor, Cygnus Support
   5
   6 This file is part of GDB, GAS, and the GNU binutils.
   7
   8 GDB, GAS, and the GNU binutils are free software; you can redistribute
   9 them and/or modify them under the terms of the GNU General Public
  10 License as published by the Free Software Foundation; either version
  11 1, or (at your option) any later version.
  12
  13 GDB, GAS, and the GNU binutils are distributed in the hope that they
  14 will be useful, but WITHOUT ANY WARRANTY; without even the implied
  15 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
  16 the GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with this file; see the file COPYING.  If not, write to the Free
  20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  21
  22 #ifndef PPC_H
  23 #define PPC_H
  24
  25 #define PARAMS(a) a
  26
  27 /* The opcode table is an array of struct powerpc_opcode.  */
  28
  29 struct powerpc_opcode
  30 {
  31   /* The opcode name.  */
  32   const char *name;
  33
  34   /* The opcode itself.  Those bits which will be filled in with
  35      operands are zeroes.  */
  36   unsigned long opcode;
  37
  38   /* The opcode mask.  This is used by the disassembler.  This is a
  39      mask containing ones indicating those bits which must match the
  40      opcode field, and zeroes indicating those bits which need not
  41      match (and are presumably filled in by operands).  */
  42   unsigned long mask;
  43
  44   /* One bit flags for the opcode.  These are used to indicate which
  45      specific processors support the instructions.  The defined values
  46      are listed below.  */
  47   unsigned long flags;
  48
  49   /* An array of operand codes.  Each code is an index into the
  50      operand table.  They appear in the order which the operands must
  51      appear in assembly code, and are terminated by a zero.  */
  52   unsigned char operands[8];
  53 };
  54
  55 /* The table itself is sorted by major opcode number, and is otherwise
  56    in the order in which the disassembler should consider
  57    instructions.  */
  58 extern const struct powerpc_opcode powerpc_opcodes[];
  59 extern const int powerpc_num_opcodes;
  60
  61 /* Values defined for the flags field of a struct powerpc_opcode.  */
  62
  63 /* Opcode is defined for the PowerPC architecture.  */
  64 #define PPC_OPCODE_PPC (01)
  65
  66 /* Opcode is defined for the POWER (RS/6000) architecture.  */
  67 #define PPC_OPCODE_POWER (02)
  68
  69 /* Opcode is defined for the POWER2 (Rios 2) architecture.  */
  70 #define PPC_OPCODE_POWER2 (04)
  71
  72 /* Opcode is only defined on 32 bit architectures.  */
  73 #define PPC_OPCODE_32 (010)
  74
  75 /* Opcode is only defined on 64 bit architectures.  */
  76 #define PPC_OPCODE_64 (020)
  77
  78 /* Opcode is supported by the Motorola PowerPC 601 processor.  The 601
  79    is assumed to support all PowerPC (PPC_OPCODE_PPC) instructions,
  80    but it also supports many additional POWER instructions.  */
  81 #define PPC_OPCODE_601 (040)
  82
  83 /* Opcode is supported in both the Power and PowerPC architectures
  84    (ie, compiler's -mcpu=common or assembler's -mcom).  */
  85 #define PPC_OPCODE_COMMON (0100)
  86
  87 /* Opcode is supported for any Power or PowerPC platform (this is
  88    for the assembler's -many option, and it eliminates duplicates).  */
  89 #define PPC_OPCODE_ANY (0200)
  90
  91 /* Opcode is supported as part of the 64-bit bridge.  */
  92 #define PPC_OPCODE_64_BRIDGE (0400)
  93
  94 /* Opcode is supported by Altivec Vector Unit */
  95 #define PPC_OPCODE_ALTIVEC (01000)
  96
  97 /* Opcode is supported by PowerPC 403 processor.  */
  98 #define PPC_OPCODE_403 (02000)
  99
 100 /* Opcode is supported by PowerPC BookE processor.  */
 101 #define PPC_OPCODE_BOOKE (04000)
 102
 103 /* Opcode is only supported by 64-bit PowerPC BookE processor.  */
 104 #define PPC_OPCODE_BOOKE64 (010000)
 105
 106 /* Opcode is only supported by Power4 architecture.  */
 107 #define PPC_OPCODE_POWER4 (020000)
 108
 109 /* Opcode isn't supported by Power4 architecture.  */
 110 #define PPC_OPCODE_NOPOWER4 (040000)
 111
 112 /* Opcode is only supported by POWERPC Classic architecture.  */
 113 #define PPC_OPCODE_CLASSIC (0100000)
 114
 115 /* Opcode is only supported by e500x2 Core.  */
 116 #define PPC_OPCODE_SPE     (0200000)
 117
 118 /* Opcode is supported by e500x2 Integer select APU.  */
 119 #define PPC_OPCODE_ISEL     (0400000)
 120
 121 /* Opcode is an e500 SPE floating point instruction.  */
 122 #define PPC_OPCODE_EFS      (01000000)
 123
 124 /* Opcode is supported by branch locking APU.  */
 125 #define PPC_OPCODE_BRLOCK   (02000000)
 126
 127 /* Opcode is supported by performance monitor APU.  */
 128 #define PPC_OPCODE_PMR      (04000000)
 129
 130 /* Opcode is supported by cache locking APU.  */
 131 #define PPC_OPCODE_CACHELCK (010000000)
 132
 133 /* Opcode is supported by machine check APU.  */
 134 #define PPC_OPCODE_RFMCI    (020000000)
 135
 136 /* A macro to extract the major opcode from an instruction.  */
 137 #define PPC_OP(i) (((i) >> 26) & 0x3f)
 138 \f
 139 /* The operands table is an array of struct powerpc_operand.  */
 140
 141 struct powerpc_operand
 142 {
 143   /* The number of bits in the operand.  */
 144   int bits;
 145
 146   /* How far the operand is left shifted in the instruction.  */
 147   int shift;
 148
 149   /* Insertion function.  This is used by the assembler.  To insert an
 150      operand value into an instruction, check this field.
 151
 152      If it is NULL, execute
 153          i |= (op & ((1 << o->bits) - 1)) << o->shift;
 154      (i is the instruction which we are filling in, o is a pointer to
 155      this structure, and op is the opcode value; this assumes twos
 156      complement arithmetic).
 157
 158      If this field is not NULL, then simply call it with the
 159      instruction and the operand value.  It will return the new value
 160      of the instruction.  If the ERRMSG argument is not NULL, then if
 161      the operand value is illegal, *ERRMSG will be set to a warning
 162      string (the operand will be inserted in any case).  If the
 163      operand value is legal, *ERRMSG will be unchanged (most operands
 164      can accept any value).  */
 165   unsigned long (*insert) PARAMS ((unsigned long instruction, long op,
 166                                    int dialect,
 167                                    const char **errmsg));
 168
 169   /* Extraction function.  This is used by the disassembler.  To
 170      extract this operand type from an instruction, check this field.
 171
 172      If it is NULL, compute
 173          op = ((i) >> o->shift) & ((1 << o->bits) - 1);
 174          if ((o->flags & PPC_OPERAND_SIGNED) != 0
 175              && (op & (1 << (o->bits - 1))) != 0)
 176            op -= 1 << o->bits;
 177      (i is the instruction, o is a pointer to this structure, and op
 178      is the result; this assumes twos complement arithmetic).
 179
 180      If this field is not NULL, then simply call it with the
 181      instruction value.  It will return the value of the operand.  If
 182      the INVALID argument is not NULL, *INVALID will be set to
 183      non-zero if this operand type can not actually be extracted from
 184      this operand (i.e., the instruction does not match).  If the
 185      operand is valid, *INVALID will not be changed.  */
 186   long (*extract) PARAMS ((unsigned long instruction, int dialect,
 187                            int *invalid));
 188
 189   /* One bit syntax flags.  */
 190   unsigned long flags;
 191 };
 192
 193 /* Elements in the table are retrieved by indexing with values from
 194    the operands field of the powerpc_opcodes table.  */
 195
 196 extern const struct powerpc_operand powerpc_operands[];
 197
 198 /* Values defined for the flags field of a struct powerpc_operand.  */
 199
 200 /* This operand takes signed values.  */
 201 #define PPC_OPERAND_SIGNED (01)
 202
 203 /* This operand takes signed values, but also accepts a full positive
 204    range of values when running in 32 bit mode.  That is, if bits is
 205    16, it takes any value from -0x8000 to 0xffff.  In 64 bit mode,
 206    this flag is ignored.  */
 207 #define PPC_OPERAND_SIGNOPT (02)
 208
 209 /* This operand does not actually exist in the assembler input.  This
 210    is used to support extended mnemonics such as mr, for which two
 211    operands fields are identical.  The assembler should call the
 212    insert function with any op value.  The disassembler should call
 213    the extract function, ignore the return value, and check the value
 214    placed in the valid argument.  */
 215 #define PPC_OPERAND_FAKE (04)
 216
 217 /* The next operand should be wrapped in parentheses rather than
 218    separated from this one by a comma.  This is used for the load and
 219    store instructions which want their operands to look like
 220        reg,displacement(reg)
 221    */
 222 #define PPC_OPERAND_PARENS (010)
 223
 224 /* This operand may use the symbolic names for the CR fields, which
 225    are
 226        lt  0    gt  1   eq  2   so  3   un  3
 227        cr0 0    cr1 1   cr2 2   cr3 3
 228        cr4 4    cr5 5   cr6 6   cr7 7
 229    These may be combined arithmetically, as in cr2*4+gt.  These are
 230    only supported on the PowerPC, not the POWER.  */
 231 #define PPC_OPERAND_CR (020)
 232
 233 /* This operand names a register.  The disassembler uses this to print
 234    register names with a leading 'r'.  */
 235 #define PPC_OPERAND_GPR (040)
 236
 237 /* This operand names a floating point register.  The disassembler
 238    prints these with a leading 'f'.  */
 239 #define PPC_OPERAND_FPR (0100)
 240
 241 /* This operand is a relative branch displacement.  The disassembler
 242    prints these symbolically if possible.  */
 243 #define PPC_OPERAND_RELATIVE (0200)
 244
 245 /* This operand is an absolute branch address.  The disassembler
 246    prints these symbolically if possible.  */
 247 #define PPC_OPERAND_ABSOLUTE (0400)
 248
 249 /* This operand is optional, and is zero if omitted.  This is used for
 250    the optional BF and L fields in the comparison instructions.  The
 251    assembler must count the number of operands remaining on the line,
 252    and the number of operands remaining for the opcode, and decide
 253    whether this operand is present or not.  The disassembler should
 254    print this operand out only if it is not zero.  */
 255 #define PPC_OPERAND_OPTIONAL (01000)
 256
 257 /* This flag is only used with PPC_OPERAND_OPTIONAL.  If this operand
 258    is omitted, then for the next operand use this operand value plus
 259    1, ignoring the next operand field for the opcode.  This wretched
 260    hack is needed because the Power rotate instructions can take
 261    either 4 or 5 operands.  The disassembler should print this operand
 262    out regardless of the PPC_OPERAND_OPTIONAL field.  */
 263 #define PPC_OPERAND_NEXT (02000)
 264
 265 /* This operand should be regarded as a negative number for the
 266    purposes of overflow checking (i.e., the normal most negative
 267    number is disallowed and one more than the normal most positive
 268    number is allowed).  This flag will only be set for a signed
 269    operand.  */
 270 #define PPC_OPERAND_NEGATIVE (04000)
 271
 272 /* This operand names a vector unit register.  The disassembler
 273    prints these with a leading 'v'.  */
 274 #define PPC_OPERAND_VR (010000)
 275
 276 /* This operand is for the DS field in a DS form instruction.  */
 277 #define PPC_OPERAND_DS (020000)
 278 \f
 279 /* The POWER and PowerPC assemblers use a few macros.  We keep them
 280    with the operands table for simplicity.  The macro table is an
 281    array of struct powerpc_macro.  */
 282
 283 struct powerpc_macro
 284 {
 285   /* The macro name.  */
 286   const char *name;
 287
 288   /* The number of operands the macro takes.  */
 289   unsigned int operands;
 290
 291   /* One bit flags for the opcode.  These are used to indicate which
 292      specific processors support the instructions.  The values are the
 293      same as those for the struct powerpc_opcode flags field.  */
 294   unsigned long flags;
 295
 296   /* A format string to turn the macro into a normal instruction.
 297      Each %N in the string is replaced with operand number N (zero
 298      based).  */
 299   const char *format;
 300 };
 301
 302 extern const struct powerpc_macro powerpc_macros[];
 303 extern const int powerpc_num_macros;
 304
 305 #endif /* PPC_H */