arch/ia64/kdb/ia64.h

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