include/opcode/ia64.h

   1 /* ia64.h -- Header file for ia64 opcode table
   2    Copyright (C) 1998, 1999, 2000, 2002, 2005, 2006, 2010
   3    Free Software Foundation, Inc.
   4    Contributed by David Mosberger-Tang <davidm@hpl.hp.com>
   5
   6    This file is part of BFD, the Binary File Descriptor library.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    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 program; if not, write to the Free Software Foundation,
  20    Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.  */
  21
  22 #ifndef opcode_ia64_h
  23 #define opcode_ia64_h
  24
  25 #include <sys/types.h>
  26
  27 #include "bfd.h"
  28
  29
  30 typedef BFD_HOST_U_64_BIT ia64_insn;
  31
  32 enum ia64_insn_type
  33   {
  34     IA64_TYPE_NIL = 0,  /* illegal type */
  35     IA64_TYPE_A,        /* integer alu (I- or M-unit) */
  36     IA64_TYPE_I,        /* non-alu integer (I-unit) */
  37     IA64_TYPE_M,        /* memory (M-unit) */
  38     IA64_TYPE_B,        /* branch (B-unit) */
  39     IA64_TYPE_F,        /* floating-point (F-unit) */
  40     IA64_TYPE_X,        /* long encoding (X-unit) */
  41     IA64_TYPE_DYN,      /* Dynamic opcode */
  42     IA64_NUM_TYPES
  43   };
  44
  45 enum ia64_unit
  46   {
  47     IA64_UNIT_NIL = 0,  /* illegal unit */
  48     IA64_UNIT_I,        /* integer unit */
  49     IA64_UNIT_M,        /* memory unit */
  50     IA64_UNIT_B,        /* branching unit */
  51     IA64_UNIT_F,        /* floating-point unit */
  52     IA64_UNIT_L,        /* long "unit" */
  53     IA64_UNIT_X,        /* may be integer or branch unit */
  54     IA64_NUM_UNITS
  55   };
  56
  57 /* Changes to this enumeration must be propagated to the operand table in
  58    bfd/cpu-ia64-opc.c
  59  */
  60 enum ia64_opnd
  61   {
  62     IA64_OPND_NIL,      /* no operand---MUST BE FIRST!*/
  63
  64     /* constants */
  65     IA64_OPND_AR_CSD,   /* application register csd (ar.csd) */
  66     IA64_OPND_AR_CCV,   /* application register ccv (ar.ccv) */
  67     IA64_OPND_AR_PFS,   /* application register pfs (ar.pfs) */
  68     IA64_OPND_C1,       /* the constant 1 */
  69     IA64_OPND_C8,       /* the constant 8 */
  70     IA64_OPND_C16,      /* the constant 16 */
  71     IA64_OPND_GR0,      /* gr0 */
  72     IA64_OPND_IP,       /* instruction pointer (ip) */
  73     IA64_OPND_PR,       /* predicate register (pr) */
  74     IA64_OPND_PR_ROT,   /* rotating predicate register (pr.rot) */
  75     IA64_OPND_PSR,      /* processor status register (psr) */
  76     IA64_OPND_PSR_L,    /* processor status register L (psr.l) */
  77     IA64_OPND_PSR_UM,   /* processor status register UM (psr.um) */
  78
  79     /* register operands: */
  80     IA64_OPND_AR3,      /* third application register # (bits 20-26) */
  81     IA64_OPND_B1,       /* branch register # (bits 6-8) */
  82     IA64_OPND_B2,       /* branch register # (bits 13-15) */
  83     IA64_OPND_CR3,      /* third control register # (bits 20-26) */
  84     IA64_OPND_F1,       /* first floating-point register # */
  85     IA64_OPND_F2,       /* second floating-point register # */
  86     IA64_OPND_F3,       /* third floating-point register # */
  87     IA64_OPND_F4,       /* fourth floating-point register # */
  88     IA64_OPND_P1,       /* first predicate # */
  89     IA64_OPND_P2,       /* second predicate # */
  90     IA64_OPND_R1,       /* first register # */
  91     IA64_OPND_R2,       /* second register # */
  92     IA64_OPND_R3,       /* third register # */
  93     IA64_OPND_R3_2,     /* third register # (limited to gr0-gr3) */
  94
  95     /* memory operands: */
  96     IA64_OPND_MR3,      /* memory at addr of third register # */
  97
  98     /* indirect operands: */
  99     IA64_OPND_CPUID_R3, /* cpuid[reg] */
 100     IA64_OPND_DBR_R3,   /* dbr[reg] */
 101     IA64_OPND_DTR_R3,   /* dtr[reg] */
 102     IA64_OPND_ITR_R3,   /* itr[reg] */
 103     IA64_OPND_IBR_R3,   /* ibr[reg] */
 104     IA64_OPND_MSR_R3,   /* msr[reg] */
 105     IA64_OPND_PKR_R3,   /* pkr[reg] */
 106     IA64_OPND_PMC_R3,   /* pmc[reg] */
 107     IA64_OPND_PMD_R3,   /* pmd[reg] */
 108     IA64_OPND_RR_R3,    /* rr[reg] */
 109
 110     /* immediate operands: */
 111     IA64_OPND_CCNT5,    /* 5-bit count (31 - bits 20-24) */
 112     IA64_OPND_CNT2a,    /* 2-bit count (1 + bits 27-28) */
 113     IA64_OPND_CNT2b,    /* 2-bit count (bits 27-28): 1, 2, 3 */
 114     IA64_OPND_CNT2c,    /* 2-bit count (bits 30-31): 0, 7, 15, or 16 */
 115     IA64_OPND_CNT5,     /* 5-bit count (bits 14-18) */
 116     IA64_OPND_CNT6,     /* 6-bit count (bits 27-32) */
 117     IA64_OPND_CPOS6a,   /* 6-bit count (63 - bits 20-25) */
 118     IA64_OPND_CPOS6b,   /* 6-bit count (63 - bits 14-19) */
 119     IA64_OPND_CPOS6c,   /* 6-bit count (63 - bits 31-36) */
 120     IA64_OPND_IMM1,     /* signed 1-bit immediate (bit 36) */
 121     IA64_OPND_IMMU2,    /* unsigned 2-bit immediate (bits 13-14) */
 122     IA64_OPND_IMMU5b,   /* unsigned 5-bit immediate (32 + bits 14-18) */
 123     IA64_OPND_IMMU7a,   /* unsigned 7-bit immediate (bits 13-19) */
 124     IA64_OPND_IMMU7b,   /* unsigned 7-bit immediate (bits 20-26) */
 125     IA64_OPND_SOF,      /* 8-bit stack frame size */
 126     IA64_OPND_SOL,      /* 8-bit size of locals */
 127     IA64_OPND_SOR,      /* 6-bit number of rotating registers (scaled by 8) */
 128     IA64_OPND_IMM8,     /* signed 8-bit immediate (bits 13-19 & 36) */
 129     IA64_OPND_IMM8U4,   /* cmp4*u signed 8-bit immediate (bits 13-19 & 36) */
 130     IA64_OPND_IMM8M1,   /* signed 8-bit immediate -1 (bits 13-19 & 36) */
 131     IA64_OPND_IMM8M1U4, /* cmp4*u signed 8-bit immediate -1 (bits 13-19 & 36)*/
 132     IA64_OPND_IMM8M1U8, /* cmp*u signed 8-bit immediate -1 (bits 13-19 & 36) */
 133     IA64_OPND_IMMU9,    /* unsigned 9-bit immediate (bits 33-34, 20-26) */
 134     IA64_OPND_IMM9a,    /* signed 9-bit immediate (bits 6-12, 27, 36) */
 135     IA64_OPND_IMM9b,    /* signed 9-bit immediate (bits 13-19, 27, 36) */
 136     IA64_OPND_IMM14,    /* signed 14-bit immediate (bits 13-19, 27-32, 36) */
 137     IA64_OPND_IMM17,    /* signed 17-bit immediate (2*bits 6-12, 24-31, 36) */
 138     IA64_OPND_IMMU21,   /* unsigned 21-bit immediate (bits 6-25, 36) */
 139     IA64_OPND_IMM22,    /* signed 22-bit immediate (bits 13-19, 22-36) */
 140     IA64_OPND_IMMU24,   /* unsigned 24-bit immediate (bits 6-26, 31-32, 36) */
 141     IA64_OPND_IMM44,    /* signed 44-bit immediate (2^16*bits 6-32, 36) */
 142     IA64_OPND_IMMU62,   /* unsigned 62-bit immediate */
 143     IA64_OPND_IMMU64,   /* unsigned 64-bit immediate (lotsa bits...) */
 144     IA64_OPND_INC3,     /* signed 3-bit (bits 13-15): +/-1, 4, 8, 16 */
 145     IA64_OPND_LEN4,     /* 4-bit count (bits 27-30 + 1) */
 146     IA64_OPND_LEN6,     /* 6-bit count (bits 27-32 + 1) */
 147     IA64_OPND_MBTYPE4,  /* 4-bit mux type (bits 20-23) */
 148     IA64_OPND_MHTYPE8,  /* 8-bit mux type (bits 20-27) */
 149     IA64_OPND_POS6,     /* 6-bit count (bits 14-19) */
 150     IA64_OPND_TAG13,    /* signed 13-bit tag (ip + 16*bits 6-12, 33-34) */
 151     IA64_OPND_TAG13b,   /* signed 13-bit tag (ip + 16*bits 24-32) */
 152     IA64_OPND_TGT25,    /* signed 25-bit (ip + 16*bits 6-25, 36) */
 153     IA64_OPND_TGT25b,   /* signed 25-bit (ip + 16*bits 6-12, 20-32, 36) */
 154     IA64_OPND_TGT25c,   /* signed 25-bit (ip + 16*bits 13-32, 36) */
 155     IA64_OPND_TGT64,    /* 64-bit (ip + 16*bits 13-32, 36, 2-40(L)) */
 156     IA64_OPND_LDXMOV,   /* any symbol, generates R_IA64_LDXMOV.  */
 157
 158     IA64_OPND_COUNT     /* # of operand types (MUST BE LAST!) */
 159   };
 160
 161 enum ia64_dependency_mode
 162 {
 163   IA64_DV_RAW,
 164   IA64_DV_WAW,
 165   IA64_DV_WAR,
 166 };
 167
 168 enum ia64_dependency_semantics
 169 {
 170   IA64_DVS_NONE,
 171   IA64_DVS_IMPLIED,
 172   IA64_DVS_IMPLIEDF,
 173   IA64_DVS_DATA,
 174   IA64_DVS_INSTR,
 175   IA64_DVS_SPECIFIC,
 176   IA64_DVS_STOP,
 177   IA64_DVS_OTHER,
 178 };
 179
 180 enum ia64_resource_specifier
 181 {
 182   IA64_RS_ANY,
 183   IA64_RS_AR_K,
 184   IA64_RS_AR_UNAT,
 185   IA64_RS_AR, /* 8-15, 20, 22-23, 31, 33-35, 37-39, 41-43, 45-47, 67-111 */
 186   IA64_RS_ARb, /* 48-63, 112-127 */
 187   IA64_RS_BR,
 188   IA64_RS_CFM,
 189   IA64_RS_CPUID,
 190   IA64_RS_CR_IIB,
 191   IA64_RS_CR_IRR,
 192   IA64_RS_CR_LRR,
 193   IA64_RS_CR, /* 3-7,10-15,18,28-63,75-79,82-127 */
 194   IA64_RS_DBR,
 195   IA64_RS_FR,
 196   IA64_RS_FRb,
 197   IA64_RS_GR0,
 198   IA64_RS_GR,
 199   IA64_RS_IBR,
 200   IA64_RS_INSERVICE, /* CR[EOI] or CR[IVR] */
 201   IA64_RS_MSR,
 202   IA64_RS_PKR,
 203   IA64_RS_PMC,
 204   IA64_RS_PMD,
 205   IA64_RS_PR,  /* non-rotating, 1-15 */
 206   IA64_RS_PRr, /* rotating, 16-62 */
 207   IA64_RS_PR63,
 208   IA64_RS_RR,
 209
 210   IA64_RS_ARX, /* ARs not in RS_AR or RS_ARb */
 211   IA64_RS_CRX, /* CRs not in RS_CR */
 212   IA64_RS_PSR, /* PSR bits */
 213   IA64_RS_RSE, /* implementation-specific RSE resources */
 214   IA64_RS_AR_FPSR,
 215 };
 216
 217 enum ia64_rse_resource
 218 {
 219   IA64_RSE_N_STACKED_PHYS,
 220   IA64_RSE_BOF,
 221   IA64_RSE_STORE_REG,
 222   IA64_RSE_LOAD_REG,
 223   IA64_RSE_BSPLOAD,
 224   IA64_RSE_RNATBITINDEX,
 225   IA64_RSE_CFLE,
 226   IA64_RSE_NDIRTY,
 227 };
 228
 229 /* Information about a given resource dependency */
 230 struct ia64_dependency
 231 {
 232   /* Name of the resource */
 233   const char *name;
 234   /* Does this dependency need further specification? */
 235   enum ia64_resource_specifier specifier;
 236   /* Mode of dependency */
 237   enum ia64_dependency_mode mode;
 238   /* Dependency semantics */
 239   enum ia64_dependency_semantics semantics;
 240   /* Register index, if applicable (distinguishes AR, CR, and PSR deps) */
 241 #define REG_NONE (-1)
 242   int regindex;
 243   /* Special info on semantics */
 244   const char *info;
 245 };
 246
 247 /* Two arrays of indexes into the ia64_dependency table.
 248    chks are dependencies to check for conflicts when an opcode is
 249    encountered; regs are dependencies to register (mark as used) when an
 250    opcode is used.  chks correspond to readers (RAW) or writers (WAW or
 251    WAR) of a resource, while regs correspond to writers (RAW or WAW) and
 252    readers (WAR) of a resource.  */
 253 struct ia64_opcode_dependency
 254 {
 255   int nchks;
 256   const unsigned short *chks;
 257   int nregs;
 258   const unsigned short *regs;
 259 };
 260
 261 /* encode/extract the note/index for a dependency */
 262 #define RDEP(N,X) (((N)<<11)|(X))
 263 #define NOTE(X) (((X)>>11)&0x1F)
 264 #define DEP(X) ((X)&0x7FF)
 265
 266 /* A template descriptor describes the execution units that are active
 267    for each of the three slots.  It also specifies the location of
 268    instruction group boundaries that may be present between two slots.  */
 269 struct ia64_templ_desc
 270   {
 271     int group_boundary; /* 0=no boundary, 1=between slot 0 & 1, etc. */
 272     enum ia64_unit exec_unit[3];
 273     const char *name;
 274   };
 275
 276 /* The opcode table is an array of struct ia64_opcode.  */
 277
 278 struct ia64_opcode
 279   {
 280     /* The opcode name.  */
 281     const char *name;
 282
 283     /* The type of the instruction: */
 284     enum ia64_insn_type type;
 285
 286     /* Number of output operands: */
 287     int num_outputs;
 288
 289     /* The opcode itself.  Those bits which will be filled in with
 290        operands are zeroes.  */
 291     ia64_insn opcode;
 292
 293     /* The opcode mask.  This is used by the disassembler.  This is a
 294        mask containing ones indicating those bits which must match the
 295        opcode field, and zeroes indicating those bits which need not
 296        match (and are presumably filled in by operands).  */
 297     ia64_insn mask;
 298
 299     /* An array of operand codes.  Each code is an index into the
 300        operand table.  They appear in the order which the operands must
 301        appear in assembly code, and are terminated by a zero.  */
 302     enum ia64_opnd operands[5];
 303
 304     /* One bit flags for the opcode.  These are primarily used to
 305        indicate specific processors and environments support the
 306        instructions.  The defined values are listed below. */
 307     unsigned int flags;
 308
 309     /* Used by ia64_find_next_opcode (). */
 310     short ent_index;
 311
 312     /* Opcode dependencies. */
 313     const struct ia64_opcode_dependency *dependencies;
 314   };
 315
 316 /* Values defined for the flags field of a struct ia64_opcode.  */
 317
 318 #define IA64_OPCODE_FIRST       (1<<0)  /* must be first in an insn group */
 319 #define IA64_OPCODE_X_IN_MLX    (1<<1)  /* insn is allowed in X slot of MLX */
 320 #define IA64_OPCODE_LAST        (1<<2)  /* must be last in an insn group */
 321 #define IA64_OPCODE_PRIV        (1<<3)  /* privileged instruct */
 322 #define IA64_OPCODE_SLOT2       (1<<4)  /* insn allowed in slot 2 only */
 323 #define IA64_OPCODE_NO_PRED     (1<<5)  /* insn cannot be predicated */
 324 #define IA64_OPCODE_PSEUDO      (1<<6)  /* insn is a pseudo-op */
 325 #define IA64_OPCODE_F2_EQ_F3    (1<<7)  /* constraint: F2 == F3 */
 326 #define IA64_OPCODE_LEN_EQ_64MCNT       (1<<8)  /* constraint: LEN == 64-CNT */
 327 #define IA64_OPCODE_MOD_RRBS    (1<<9)  /* modifies all rrbs in CFM */
 328 #define IA64_OPCODE_POSTINC     (1<<10) /* postincrement MR3 operand */
 329
 330 /* A macro to extract the major opcode from an instruction.  */
 331 #define IA64_OP(i)      (((i) >> 37) & 0xf)
 332
 333 enum ia64_operand_class
 334   {
 335     IA64_OPND_CLASS_CST,        /* constant */
 336     IA64_OPND_CLASS_REG,        /* register */
 337     IA64_OPND_CLASS_IND,        /* indirect register */
 338     IA64_OPND_CLASS_ABS,        /* absolute value */
 339     IA64_OPND_CLASS_REL,        /* IP-relative value */
 340   };
 341
 342 /* The operands table is an array of struct ia64_operand.  */
 343
 344 struct ia64_operand
 345 {
 346   enum ia64_operand_class op_class;
 347
 348   /* Set VALUE as the operand bits for the operand of type SELF in the
 349      instruction pointed to by CODE.  If an error occurs, *CODE is not
 350      modified and the returned string describes the cause of the
 351      error.  If no error occurs, NULL is returned.  */
 352   const char *(*insert) (const struct ia64_operand *self, ia64_insn value,
 353                          ia64_insn *code);
 354
 355   /* Extract the operand bits for an operand of type SELF from
 356      instruction CODE store them in *VALUE.  If an error occurs, the
 357      cause of the error is described by the string returned.  If no
 358      error occurs, NULL is returned.  */
 359   const char *(*extract) (const struct ia64_operand *self, ia64_insn code,
 360                           ia64_insn *value);
 361
 362   /* A string whose meaning depends on the operand class.  */
 363
 364   const char *str;
 365
 366   struct bit_field
 367     {
 368       /* The number of bits in the operand.  */
 369       int bits;
 370
 371       /* How far the operand is left shifted in the instruction.  */
 372       int shift;
 373     }
 374   field[4];             /* no operand has more than this many bit-fields */
 375
 376   unsigned int flags;
 377
 378   const char *desc;     /* brief description */
 379 };
 380
 381 /* Values defined for the flags field of a struct ia64_operand.  */
 382
 383 /* Disassemble as signed decimal (instead of hex): */
 384 #define IA64_OPND_FLAG_DECIMAL_SIGNED   (1<<0)
 385 /* Disassemble as unsigned decimal (instead of hex): */
 386 #define IA64_OPND_FLAG_DECIMAL_UNSIGNED (1<<1)
 387
 388 extern const struct ia64_templ_desc ia64_templ_desc[16];
 389
 390 /* The tables are sorted by major opcode number and are otherwise in
 391    the order in which the disassembler should consider instructions.  */
 392 extern struct ia64_opcode ia64_opcodes_a[];
 393 extern struct ia64_opcode ia64_opcodes_i[];
 394 extern struct ia64_opcode ia64_opcodes_m[];
 395 extern struct ia64_opcode ia64_opcodes_b[];
 396 extern struct ia64_opcode ia64_opcodes_f[];
 397 extern struct ia64_opcode ia64_opcodes_d[];
 398
 399
 400 extern struct ia64_opcode *ia64_find_opcode (const char *);
 401 extern struct ia64_opcode *ia64_find_next_opcode (struct ia64_opcode *);
 402
 403 extern struct ia64_opcode *ia64_dis_opcode (ia64_insn,
 404                                             enum ia64_insn_type);
 405
 406 extern void ia64_free_opcode (struct ia64_opcode *);
 407 extern const struct ia64_dependency *ia64_find_dependency (int);
 408
 409 /* To avoid circular library dependencies, this array is implemented
 410    in bfd/cpu-ia64-opc.c: */
 411 extern const struct ia64_operand elf64_ia64_operands[IA64_OPND_COUNT];
 412
 413 #endif /* opcode_ia64_h */