disasm.c

   1 /* disasm.c   where all the _work_ gets done in the Netwide Disassembler
   2  *
   3  * The Netwide Assembler is copyright (C) 1996 Simon Tatham and
   4  * Julian Hall. All rights reserved. The software is
   5  * redistributable under the licence given in the file "Licence"
   6  * distributed in the NASM archive.
   7  *
   8  * initial version 27/iii/95 by Simon Tatham
   9  */
  10
  11 #include "compiler.h"
  12
  13 #include <stdio.h>
  14 #include <string.h>
  15 #include <limits.h>
  16 #include <inttypes.h>
  17
  18 #include "nasm.h"
  19 #include "disasm.h"
  20 #include "sync.h"
  21 #include "insns.h"
  22
  23 #include "names.c"
  24
  25 /*
  26  * Flags that go into the `segment' field of `insn' structures
  27  * during disassembly.
  28  */
  29 #define SEG_RELATIVE      1
  30 #define SEG_32BIT         2
  31 #define SEG_RMREG         4
  32 #define SEG_DISP8         8
  33 #define SEG_DISP16       16
  34 #define SEG_DISP32       32
  35 #define SEG_NODISP       64
  36 #define SEG_SIGNED      128
  37 #define SEG_64BIT       256
  38
  39 #include "regdis.c"
  40
  41 /*
  42  * Prefix information
  43  */
  44 struct prefix_info {
  45     uint8_t osize;              /* Operand size */
  46     uint8_t asize;              /* Address size */
  47     uint8_t osp;                /* Operand size prefix present */
  48     uint8_t asp;                /* Address size prefix present */
  49     uint8_t rep;                /* Rep prefix present */
  50     uint8_t seg;                /* Segment override prefix present */
  51     uint8_t lock;               /* Lock prefix present */
  52     uint8_t rex;                /* Rex prefix present */
  53 };
  54
  55 #define getu8(x) (*(uint8_t *)(x))
  56 #if defined(__i386__) || defined(__x86_64__)
  57 /* Littleendian CPU which can handle unaligned references */
  58 #define getu16(x) (*(uint16_t *)(x))
  59 #define getu32(x) (*(uint32_t *)(x))
  60 #define getu64(x) (*(uint64_t *)(x))
  61 #else
  62 static uint16_t getu16(uint8_t *data)
  63 {
  64     return (uint16_t)data[0] + ((uint16_t)data[1] << 8);
  65 }
  66 static uint32_t getu32(uint8_t *data)
  67 {
  68     return (uint32_t)getu16(data) + ((uint32_t)getu16(data+2) << 16);
  69 }
  70 static uint64_t getu64(uint8_t *data)
  71 {
  72     return (uint64_t)getu32(data) + ((uint64_t)getu32(data+4) << 32);
  73 }
  74 #endif
  75
  76 #define gets8(x) ((int8_t)getu8(x))
  77 #define gets16(x) ((int16_t)getu16(x))
  78 #define gets32(x) ((int32_t)getu32(x))
  79 #define gets64(x) ((int64_t)getu64(x))
  80
  81 /* Important: regval must already have been adjusted for rex extensions */
  82 static enum reg_enum whichreg(int32_t regflags, int regval, int rex)
  83 {
  84     if (!(regflags & (REGISTER|REGMEM)))
  85         return 0;               /* Registers not permissible?! */
  86
  87     regflags |= REGISTER;
  88
  89     if (!(REG_AL & ~regflags))
  90         return R_AL;
  91     if (!(REG_AX & ~regflags))
  92         return R_AX;
  93     if (!(REG_EAX & ~regflags))
  94         return R_EAX;
  95     if (!(REG_RAX & ~regflags))
  96         return R_RAX;
  97     if (!(REG_DL & ~regflags))
  98         return R_DL;
  99     if (!(REG_DX & ~regflags))
 100         return R_DX;
 101     if (!(REG_EDX & ~regflags))
 102         return R_EDX;
 103     if (!(REG_RDX & ~regflags))
 104         return R_RDX;
 105     if (!(REG_CL & ~regflags))
 106         return R_CL;
 107     if (!(REG_CX & ~regflags))
 108         return R_CX;
 109     if (!(REG_ECX & ~regflags))
 110         return R_ECX;
 111     if (!(REG_RCX & ~regflags))
 112         return R_RCX;
 113     if (!(FPU0 & ~regflags))
 114         return R_ST0;
 115     if (!(REG_CS & ~regflags))
 116         return (regval == 1) ? R_CS : 0;
 117     if (!(REG_DESS & ~regflags))
 118         return (regval == 0 || regval == 2
 119                 || regval == 3 ? rd_sreg[regval] : 0);
 120     if (!(REG_FSGS & ~regflags))
 121         return (regval == 4 || regval == 5 ? rd_sreg[regval] : 0);
 122     if (!(REG_SEG67 & ~regflags))
 123         return (regval == 6 || regval == 7 ? rd_sreg[regval] : 0);
 124
 125     /* All the entries below look up regval in an 16-entry array */
 126     if (regval < 0 || regval > 15)
 127         return 0;
 128
 129     if (!(REG8 & ~regflags)) {
 130         if (rex & REX_P)
 131             return rd_reg8_rex[regval];
 132         else
 133             return rd_reg8[regval];
 134     }
 135     if (!(REG16 & ~regflags))
 136         return rd_reg16[regval];
 137     if (!(REG32 & ~regflags))
 138         return rd_reg32[regval];
 139     if (!(REG64 & ~regflags))
 140         return rd_reg64[regval];
 141     if (!(REG_SREG & ~regflags))
 142         return rd_sreg[regval & 7]; /* Ignore REX */
 143     if (!(REG_CREG & ~regflags))
 144         return rd_creg[regval];
 145     if (!(REG_DREG & ~regflags))
 146         return rd_dreg[regval];
 147     if (!(REG_TREG & ~regflags)) {
 148         if (rex & REX_P)
 149             return 0;           /* TR registers are ill-defined with rex */
 150         return rd_treg[regval];
 151     }
 152     if (!(FPUREG & ~regflags))
 153         return rd_fpureg[regval & 7]; /* Ignore REX */
 154     if (!(MMXREG & ~regflags))
 155         return rd_mmxreg[regval & 7]; /* Ignore REX */
 156     if (!(XMMREG & ~regflags))
 157         return rd_xmmreg[regval];
 158
 159     return 0;
 160 }
 161
 162 static const char *whichcond(int condval)
 163 {
 164     static int conds[] = {
 165         C_O, C_NO, C_C, C_NC, C_Z, C_NZ, C_NA, C_A,
 166         C_S, C_NS, C_PE, C_PO, C_L, C_NL, C_NG, C_G
 167     };
 168     return conditions[conds[condval]];
 169 }
 170
 171 /*
 172  * Process a DREX suffix
 173  */
 174 static uint8_t *do_drex(uint8_t *data, insn *ins)
 175 {
 176     uint8_t drex = *data++;
 177     operand *dst = &ins->oprs[ins->drexdst];
 178
 179     if ((drex & 8) != ((ins->rex & REX_OC) ? 8 : 0))
 180         return NULL;    /* OC0 mismatch */
 181     ins->rex = (ins->rex & ~7) | (drex & 7);
 182
 183     dst->segment = SEG_RMREG;
 184     dst->basereg = drex >> 4;
 185     return data;
 186 }
 187
 188
 189 /*
 190  * Process an effective address (ModRM) specification.
 191  */
 192 static uint8_t *do_ea(uint8_t *data, int modrm, int asize,
 193                       int segsize, operand * op, insn *ins)
 194 {
 195     int mod, rm, scale, index, base;
 196     int rex;
 197     uint8_t sib = 0;
 198
 199     mod = (modrm >> 6) & 03;
 200     rm = modrm & 07;
 201
 202     if (mod != 3 && rm == 4 && asize != 16)
 203         sib = *data++;
 204
 205     if (ins->rex & REX_D) {
 206         data = do_drex(data, ins);
 207         if (!data)
 208             return NULL;
 209     }
 210     rex = ins->rex;
 211
 212     if (mod == 3) {             /* pure register version */
 213         op->basereg = rm+(rex & REX_B ? 8 : 0);
 214         op->segment |= SEG_RMREG;
 215         return data;
 216     }
 217
 218     op->disp_size = 0;
 219     op->eaflags = 0;
 220
 221     if (asize == 16) {
 222         /*
 223          * <mod> specifies the displacement size (none, byte or
 224          * word), and <rm> specifies the register combination.
 225          * Exception: mod=0,rm=6 does not specify [BP] as one might
 226          * expect, but instead specifies [disp16].
 227          */
 228         op->indexreg = op->basereg = -1;
 229         op->scale = 1;          /* always, in 16 bits */
 230         switch (rm) {
 231         case 0:
 232             op->basereg = R_BX;
 233             op->indexreg = R_SI;
 234             break;
 235         case 1:
 236             op->basereg = R_BX;
 237             op->indexreg = R_DI;
 238             break;
 239         case 2:
 240             op->basereg = R_BP;
 241             op->indexreg = R_SI;
 242             break;
 243         case 3:
 244             op->basereg = R_BP;
 245             op->indexreg = R_DI;
 246             break;
 247         case 4:
 248             op->basereg = R_SI;
 249             break;
 250         case 5:
 251             op->basereg = R_DI;
 252             break;
 253         case 6:
 254             op->basereg = R_BP;
 255             break;
 256         case 7:
 257             op->basereg = R_BX;
 258             break;
 259         }
 260         if (rm == 6 && mod == 0) {      /* special case */
 261             op->basereg = -1;
 262             if (segsize != 16)
 263                 op->disp_size = 16;
 264             mod = 2;            /* fake disp16 */
 265         }
 266         switch (mod) {
 267         case 0:
 268             op->segment |= SEG_NODISP;
 269             break;
 270         case 1:
 271             op->segment |= SEG_DISP8;
 272             op->offset = (int8_t)*data++;
 273             break;
 274         case 2:
 275             op->segment |= SEG_DISP16;
 276             op->offset = *data++;
 277             op->offset |= ((unsigned)*data++) << 8;
 278             break;
 279         }
 280         return data;
 281     } else {
 282         /*
 283          * Once again, <mod> specifies displacement size (this time
 284          * none, byte or *dword*), while <rm> specifies the base
 285          * register. Again, [EBP] is missing, replaced by a pure
 286          * disp32 (this time that's mod=0,rm=*5*) in 32-bit mode,
 287          * and RIP-relative addressing in 64-bit mode.
 288          *
 289          * However, rm=4
 290          * indicates not a single base register, but instead the
 291          * presence of a SIB byte...
 292          */
 293         int a64 = asize == 64;
 294
 295         op->indexreg = -1;
 296
 297         if (a64)
 298             op->basereg = rd_reg64[rm | ((rex & REX_B) ? 8 : 0)];
 299         else
 300             op->basereg = rd_reg32[rm | ((rex & REX_B) ? 8 : 0)];
 301
 302         if (rm == 5 && mod == 0) {
 303             if (segsize == 64) {
 304                 op->eaflags |= EAF_REL;
 305                 op->segment |= SEG_RELATIVE;
 306                 mod = 2;        /* fake disp32 */
 307             }
 308
 309             if (asize != 64)
 310                 op->disp_size = asize;
 311
 312             op->basereg = -1;
 313             mod = 2;            /* fake disp32 */
 314         }
 315
 316         if (rm == 4) {          /* process SIB */
 317             scale = (sib >> 6) & 03;
 318             index = (sib >> 3) & 07;
 319             base = sib & 07;
 320
 321             op->scale = 1 << scale;
 322
 323             if (index == 4)
 324                 op->indexreg = -1; /* ESP/RSP/R12 cannot be an index */
 325             else if (a64)
 326                 op->indexreg = rd_reg64[index | ((rex & REX_X) ? 8 : 0)];
 327             else
 328                 op->indexreg = rd_reg64[index | ((rex & REX_X) ? 8 : 0)];
 329
 330             if (base == 5 && mod == 0) {
 331                 op->basereg = -1;
 332                 mod = 2;        /* Fake disp32 */
 333             } else if (a64)
 334                 op->basereg = rd_reg64[base | ((rex & REX_B) ? 8 : 0)];
 335             else
 336                 op->basereg = rd_reg32[base | ((rex & REX_B) ? 8 : 0)];
 337
 338             if (segsize != 32)
 339                 op->disp_size = 32;
 340         }
 341
 342         switch (mod) {
 343         case 0:
 344             op->segment |= SEG_NODISP;
 345             break;
 346         case 1:
 347             op->segment |= SEG_DISP8;
 348             op->offset = gets8(data);
 349             data++;
 350             break;
 351         case 2:
 352             op->segment |= SEG_DISP32;
 353             op->offset = getu32(data);
 354             data += 4;
 355             break;
 356         }
 357         return data;
 358     }
 359 }
 360
 361 /*
 362  * Determine whether the instruction template in t corresponds to the data
 363  * stream in data. Return the number of bytes matched if so.
 364  */
 365 static int matches(const struct itemplate *t, uint8_t *data,
 366                    const struct prefix_info *prefix, int segsize, insn *ins)
 367 {
 368     uint8_t *r = (uint8_t *)(t->code);
 369     uint8_t *origdata = data;
 370     bool a_used = false, o_used = false;
 371     enum prefixes drep = 0;
 372     uint8_t lock = prefix->lock;
 373     int osize = prefix->osize;
 374     int asize = prefix->asize;
 375     int i;
 376
 377     for (i = 0; i < MAX_OPERANDS; i++) {
 378         ins->oprs[i].segment = ins->oprs[i].disp_size =
 379             (segsize == 64 ? SEG_64BIT : segsize == 32 ? SEG_32BIT : 0);
 380     }
 381     ins->condition = -1;
 382     ins->rex = prefix->rex;
 383
 384     if (t->flags & (segsize == 64 ? IF_NOLONG : IF_LONG))
 385         return false;
 386
 387     if (prefix->rep == 0xF2)
 388         drep = P_REPNE;
 389     else if (prefix->rep == 0xF3)
 390         drep = P_REP;
 391
 392     while (*r) {
 393         int c = *r++;
 394
 395         /* FIX: change this into a switch */
 396         if (c >= 01 && c <= 03) {
 397             while (c--)
 398                 if (*r++ != *data++)
 399                     return false;
 400         } else if (c == 04) {
 401             switch (*data++) {
 402             case 0x07:
 403                 ins->oprs[0].basereg = 0;
 404                 break;
 405             case 0x17:
 406                 ins->oprs[0].basereg = 2;
 407                 break;
 408             case 0x1F:
 409                 ins->oprs[0].basereg = 3;
 410                 break;
 411             default:
 412                 return false;
 413             }
 414         } else if (c == 05) {
 415             switch (*data++) {
 416             case 0xA1:
 417                 ins->oprs[0].basereg = 4;
 418                 break;
 419             case 0xA9:
 420                 ins->oprs[0].basereg = 5;
 421                 break;
 422             default:
 423                 return false;
 424             }
 425         } else if (c == 06) {
 426             switch (*data++) {
 427             case 0x06:
 428                 ins->oprs[0].basereg = 0;
 429                 break;
 430             case 0x0E:
 431                 ins->oprs[0].basereg = 1;
 432                 break;
 433             case 0x16:
 434                 ins->oprs[0].basereg = 2;
 435                 break;
 436             case 0x1E:
 437                 ins->oprs[0].basereg = 3;
 438                 break;
 439             default:
 440                 return false;
 441             }
 442         } else if (c == 07) {
 443             switch (*data++) {
 444             case 0xA0:
 445                 ins->oprs[0].basereg = 4;
 446                 break;
 447             case 0xA8:
 448                 ins->oprs[0].basereg = 5;
 449                 break;
 450             default:
 451                 return false;
 452             }
 453         } else if (c >= 010 && c <= 013) {
 454             int t = *r++, d = *data++;
 455             if (d < t || d > t + 7)
 456                 return false;
 457             else {
 458                 ins->oprs[c - 010].basereg = (d-t)+
 459                     (ins->rex & REX_B ? 8 : 0);
 460                 ins->oprs[c - 010].segment |= SEG_RMREG;
 461             }
 462         } else if (c >= 014 && c <= 017) {
 463             ins->oprs[c - 014].offset = (int8_t)*data++;
 464             ins->oprs[c - 014].segment |= SEG_SIGNED;
 465         } else if (c >= 020 && c <= 023) {
 466             ins->oprs[c - 020].offset = *data++;
 467         } else if (c >= 024 && c <= 027) {
 468             ins->oprs[c - 024].offset = *data++;
 469         } else if (c >= 030 && c <= 033) {
 470             ins->oprs[c - 030].offset = getu16(data);
 471             data += 2;
 472         } else if (c >= 034 && c <= 037) {
 473             if (osize == 32) {
 474                 ins->oprs[c - 034].offset = getu32(data);
 475                 data += 4;
 476             } else {
 477                 ins->oprs[c - 034].offset = getu16(data);
 478                 data += 2;
 479             }
 480             if (segsize != asize)
 481                 ins->oprs[c - 034].disp_size = asize;
 482         } else if (c >= 040 && c <= 043) {
 483             ins->oprs[c - 040].offset = getu32(data);
 484             data += 4;
 485         } else if (c >= 044 && c <= 047) {
 486             switch (asize) {
 487             case 16:
 488                 ins->oprs[c - 044].offset = getu16(data);
 489                 data += 2;
 490                 break;
 491             case 32:
 492                 ins->oprs[c - 044].offset = getu32(data);
 493                 data += 4;
 494                 break;
 495             case 64:
 496                 ins->oprs[c - 044].offset = getu64(data);
 497                 data += 8;
 498                 break;
 499             }
 500             if (segsize != asize)
 501                 ins->oprs[c - 044].disp_size = asize;
 502         } else if (c >= 050 && c <= 053) {
 503             ins->oprs[c - 050].offset = gets8(data++);
 504             ins->oprs[c - 050].segment |= SEG_RELATIVE;
 505         } else if (c >= 054 && c <= 057) {
 506             ins->oprs[c - 054].offset = getu64(data);
 507             data += 8;
 508         } else if (c >= 060 && c <= 063) {
 509             ins->oprs[c - 060].offset = gets16(data);
 510             data += 2;
 511             ins->oprs[c - 060].segment |= SEG_RELATIVE;
 512             ins->oprs[c - 060].segment &= ~SEG_32BIT;
 513         } else if (c >= 064 && c <= 067) {
 514             ins->oprs[c - 064].segment |= SEG_RELATIVE;
 515             if (osize == 16) {
 516                 ins->oprs[c - 064].offset = getu16(data);
 517                 data += 2;
 518                 ins->oprs[c - 064].segment &= ~(SEG_32BIT|SEG_64BIT);
 519             } else if (osize == 32) {
 520                 ins->oprs[c - 064].offset = getu32(data);
 521                 data += 4;
 522                 ins->oprs[c - 064].segment &= ~SEG_64BIT;
 523                 ins->oprs[c - 064].segment |= SEG_32BIT;
 524             }
 525             if (segsize != osize) {
 526                 ins->oprs[c - 064].type =
 527                     (ins->oprs[c - 064].type & ~SIZE_MASK)
 528                     | ((osize == 16) ? BITS16 : BITS32);
 529             }
 530         } else if (c >= 070 && c <= 073) {
 531             ins->oprs[c - 070].offset = getu32(data);
 532             data += 4;
 533             ins->oprs[c - 070].segment |= SEG_32BIT | SEG_RELATIVE;
 534         } else if (c >= 0100 && c < 0140) {
 535             int modrm = *data++;
 536             ins->oprs[c & 07].segment |= SEG_RMREG;
 537             data = do_ea(data, modrm, asize, segsize,
 538                          &ins->oprs[(c >> 3) & 07], ins);
 539             if (!data)
 540                 return false;
 541             ins->oprs[c & 07].basereg = ((modrm >> 3)&7)+
 542                 (ins->rex & REX_R ? 8 : 0);
 543         } else if (c >= 0140 && c <= 0143) {
 544             ins->oprs[c - 0140].offset = getu16(data);
 545             data += 2;
 546         } else if (c >= 0150 && c <= 0153) {
 547             ins->oprs[c - 0150].offset = getu32(data);
 548             data += 4;
 549         } else if (c >= 0160 && c <= 0167) {
 550             ins->rex |= (c & 4) ? REX_D|REX_OC : REX_D;
 551             ins->drexdst = c & 3;
 552         } else if (c == 0170) {
 553             if (*data++)
 554                 return false;
 555         } else if (c == 0171) {
 556             data = do_drex(data, ins);
 557             if (!data)
 558                 return false;
 559         } else if (c >= 0200 && c <= 0277) {
 560             int modrm = *data++;
 561             if (((modrm >> 3) & 07) != (c & 07))
 562                 return false;   /* spare field doesn't match up */
 563             data = do_ea(data, modrm, asize, segsize,
 564                          &ins->oprs[(c >> 3) & 07], ins);
 565             if (!data)
 566                 return false;
 567         } else if (c == 0310) {
 568             if (asize != 16)
 569                 return false;
 570             else
 571                 a_used = true;
 572         } else if (c == 0311) {
 573             if (asize == 16)
 574                 return false;
 575             else
 576                 a_used = true;
 577         } else if (c == 0312) {
 578             if (asize != segsize)
 579                 return false;
 580             else
 581                 a_used = true;
 582         } else if (c == 0313) {
 583             if (asize != 64)
 584                 return false;
 585             else
 586                 a_used = true;
 587         } else if (c == 0314) {
 588             if (prefix->rex & REX_B)
 589                 return false;
 590         } else if (c == 0315) {
 591             if (prefix->rex & REX_X)
 592                 return false;
 593         } else if (c == 0316) {
 594             if (prefix->rex & REX_R)
 595                 return false;
 596         } else if (c == 0317) {
 597             if (prefix->rex & REX_W)
 598                 return false;
 599         } else if (c == 0320) {
 600             if (osize != 16)
 601                 return false;
 602             else
 603                 o_used = true;
 604         } else if (c == 0321) {
 605             if (osize != 32)
 606                 return false;
 607             else
 608                 o_used = true;
 609         } else if (c == 0322) {
 610             if (osize != (segsize == 16) ? 16 : 32)
 611                 return false;
 612             else
 613                 o_used = true;
 614         } else if (c == 0323) {
 615             ins->rex |= REX_W;  /* 64-bit only instruction */
 616             osize = 64;
 617         } else if (c == 0324) {
 618             if (!(ins->rex & (REX_P|REX_W)) || osize != 64)
 619                 return false;
 620         } else if (c == 0330) {
 621             int t = *r++, d = *data++;
 622             if (d < t || d > t + 15)
 623                 return false;
 624             else
 625                 ins->condition = d - t;
 626         } else if (c == 0331) {
 627             if (prefix->rep)
 628                 return false;
 629         } else if (c == 0332) {
 630             if (prefix->rep != 0xF2)
 631                 return false;
 632         } else if (c == 0333) {
 633             if (prefix->rep != 0xF3)
 634                 return false;
 635             drep = 0;
 636         } else if (c == 0334) {
 637             if (lock) {
 638                 ins->rex |= REX_R;
 639                 lock = 0;
 640             }
 641         } else if (c == 0335) {
 642             if (drep == P_REP)
 643                 drep = P_REPE;
 644         } else if (c == 0364) {
 645             if (prefix->osp)
 646                 return false;
 647         } else if (c == 0365) {
 648             if (prefix->asp)
 649                 return false;
 650         } else if (c == 0366) {
 651             if (!prefix->osp)
 652                 return false;
 653             o_used = true;
 654         } else if (c == 0367) {
 655             if (!prefix->asp)
 656                 return false;
 657             o_used = true;
 658         }
 659     }
 660
 661     /* REX cannot be combined with DREX */
 662     if ((ins->rex & REX_D) && (prefix->rex))
 663         return false;
 664
 665     /*
 666      * Check for unused rep or a/o prefixes.
 667      */
 668     for (i = 0; i < t->operands; i++) {
 669         if (ins->oprs[i].segment != SEG_RMREG)
 670             a_used = true;
 671     }
 672
 673     if (lock) {
 674         if (ins->prefixes[PPS_LREP])
 675             return false;
 676         ins->prefixes[PPS_LREP] = P_LOCK;
 677     }
 678     if (drep) {
 679         if (ins->prefixes[PPS_LREP])
 680             return false;
 681         ins->prefixes[PPS_LREP] = drep;
 682     }
 683     if (!o_used && osize == ((segsize == 16) ? 32 : 16)) {
 684         if (ins->prefixes[PPS_OSIZE])
 685             return false;
 686         ins->prefixes[PPS_OSIZE] = osize == 16 ? P_O16 : P_O32;
 687     }
 688     if (!a_used && asize != segsize) {
 689         if (ins->prefixes[PPS_ASIZE])
 690             return false;
 691         ins->prefixes[PPS_ASIZE] = asize == 16 ? P_A16 : P_A32;
 692     }
 693
 694     /* Fix: check for redundant REX prefixes */
 695
 696     return data - origdata;
 697 }
 698
 699 int32_t disasm(uint8_t *data, char *output, int outbufsize, int segsize,
 700             int32_t offset, int autosync, uint32_t prefer)
 701 {
 702     const struct itemplate * const *p, * const *best_p;
 703     const struct disasm_index *ix;
 704     uint8_t *dp;
 705     int length, best_length = 0;
 706     char *segover;
 707     int i, slen, colon, n;
 708     uint8_t *origdata;
 709     int works;
 710     insn tmp_ins, ins;
 711     uint32_t goodness, best;
 712     int best_pref;
 713     struct prefix_info prefix;
 714
 715     memset(&ins, 0, sizeof ins);
 716
 717     /*
 718      * Scan for prefixes.
 719      */
 720     memset(&prefix, 0, sizeof prefix);
 721     prefix.asize = segsize;
 722     prefix.osize = (segsize == 64) ? 32 : segsize;
 723     segover = NULL;
 724     origdata = data;
 725     for (;;) {
 726         if (*data == 0xF3 || *data == 0xF2)
 727             prefix.rep = *data++;
 728         else if (*data == 0xF0)
 729             prefix.lock = *data++;
 730         else if (*data == 0x2E)
 731             segover = "cs", prefix.seg = *data++;
 732         else if (*data == 0x36)
 733             segover = "ss", prefix.seg = *data++;
 734         else if (*data == 0x3E)
 735             segover = "ds", prefix.seg = *data++;
 736         else if (*data == 0x26)
 737             segover = "es", prefix.seg = *data++;
 738         else if (*data == 0x64)
 739             segover = "fs", prefix.seg = *data++;
 740         else if (*data == 0x65)
 741             segover = "gs", prefix.seg = *data++;
 742         else if (*data == 0x66) {
 743             prefix.osize = (segsize == 16) ? 32 : 16;
 744             prefix.osp = *data++;
 745         } else if (*data == 0x67) {
 746             prefix.asize = (segsize == 32) ? 16 : 32;
 747             prefix.asp = *data++;
 748         } else if (segsize == 64 && (*data & 0xf0) == REX_P) {
 749             prefix.rex = *data++;
 750             if (prefix.rex & REX_W)
 751                 prefix.osize = 64;
 752             break;              /* REX is always the last prefix */
 753         } else {
 754             break;
 755         }
 756     }
 757
 758     best = -1;                  /* Worst possible */
 759     best_p = NULL;
 760     best_pref = INT_MAX;
 761
 762     dp = data;
 763     ix = itable + *dp++;
 764     while (ix->n == -1) {
 765         ix = (const struct disasm_index *)ix->p + *dp++;
 766     }
 767
 768     p = (const struct itemplate * const *)ix->p;
 769     for (n = ix->n; n; n--, p++) {
 770         if ((length = matches(*p, data, &prefix, segsize, &tmp_ins))) {
 771             works = true;
 772             /*
 773              * Final check to make sure the types of r/m match up.
 774              * XXX: Need to make sure this is actually correct.
 775              */
 776             for (i = 0; i < (*p)->operands; i++) {
 777                 if (!((*p)->opd[i] & SAME_AS) &&
 778                     (
 779                         /* If it's a mem-only EA but we have a register, die. */
 780                         ((tmp_ins.oprs[i].segment & SEG_RMREG) &&
 781                          !(MEMORY & ~(*p)->opd[i])) ||
 782                         /* If it's a reg-only EA but we have a memory ref, die. */
 783                         (!(tmp_ins.oprs[i].segment & SEG_RMREG) &&
 784                          !(REG_EA & ~(*p)->opd[i]) &&
 785                          !((*p)->opd[i] & REG_SMASK)) ||
 786                         /* Register type mismatch (eg FS vs REG_DESS): die. */
 787                         ((((*p)->opd[i] & (REGISTER | FPUREG)) ||
 788                           (tmp_ins.oprs[i].segment & SEG_RMREG)) &&
 789                          !whichreg((*p)->opd[i],
 790                                    tmp_ins.oprs[i].basereg, tmp_ins.rex))
 791                         )) {
 792                     works = false;
 793                     break;
 794                 }
 795             }
 796
 797             /*
 798              * Note: we always prefer instructions which incorporate
 799              * prefixes in the instructions themselves.  This is to allow
 800              * e.g. PAUSE to be preferred to REP NOP, and deal with
 801              * MMX/SSE instructions where prefixes are used to select
 802              * between MMX and SSE register sets or outright opcode
 803              * selection.
 804              */
 805             if (works) {
 806                 int i, nprefix;
 807                 goodness = ((*p)->flags & IF_PFMASK) ^ prefer;
 808                 nprefix = 0;
 809                 for (i = 0; i < MAXPREFIX; i++)
 810                     if (tmp_ins.prefixes[i])
 811                         nprefix++;
 812                 if (nprefix < best_pref ||
 813                     (nprefix == best_pref && goodness < best)) {
 814                     /* This is the best one found so far */
 815                     best = goodness;
 816                     best_p = p;
 817                     best_pref = nprefix;
 818                     best_length = length;
 819                     ins = tmp_ins;
 820                 }
 821             }
 822         }
 823     }
 824
 825     if (!best_p)
 826         return 0;               /* no instruction was matched */
 827
 828     /* Pick the best match */
 829     p = best_p;
 830     length = best_length;
 831
 832     slen = 0;
 833
 834     /* TODO: snprintf returns the value that the string would have if
 835      *      the buffer were long enough, and not the actual length of
 836      *      the returned string, so each instance of using the return
 837      *      value of snprintf should actually be checked to assure that
 838      *      the return value is "sane."  Maybe a macro wrapper could
 839      *      be used for that purpose.
 840      */
 841     for (i = 0; i < MAXPREFIX; i++)
 842         switch (ins.prefixes[i]) {
 843         case P_LOCK:
 844             slen += snprintf(output + slen, outbufsize - slen, "lock ");
 845             break;
 846         case P_REP:
 847             slen += snprintf(output + slen, outbufsize - slen, "rep ");
 848             break;
 849         case P_REPE:
 850             slen += snprintf(output + slen, outbufsize - slen, "repe ");
 851             break;
 852         case P_REPNE:
 853             slen += snprintf(output + slen, outbufsize - slen, "repne ");
 854             break;
 855         case P_A16:
 856             slen += snprintf(output + slen, outbufsize - slen, "a16 ");
 857             break;
 858         case P_A32:
 859             slen += snprintf(output + slen, outbufsize - slen, "a32 ");
 860             break;
 861         case P_O16:
 862             slen += snprintf(output + slen, outbufsize - slen, "o16 ");
 863             break;
 864         case P_O32:
 865             slen += snprintf(output + slen, outbufsize - slen, "o32 ");
 866             break;
 867         default:
 868             break;
 869         }
 870
 871     for (i = 0; i < (int)elements(ico); i++)
 872         if ((*p)->opcode == ico[i]) {
 873             slen +=
 874                 snprintf(output + slen, outbufsize - slen, "%s%s", icn[i],
 875                          whichcond(ins.condition));
 876             break;
 877         }
 878     if (i >= (int)elements(ico))
 879         slen +=
 880             snprintf(output + slen, outbufsize - slen, "%s",
 881                      insn_names[(*p)->opcode]);
 882     colon = false;
 883     length += data - origdata;  /* fix up for prefixes */
 884     for (i = 0; i < (*p)->operands; i++) {
 885         opflags_t t = (*p)->opd[i];
 886         const operand *o = &ins.oprs[i];
 887         int64_t offs;
 888
 889         if (t & SAME_AS) {
 890             o = &ins.oprs[t & ~SAME_AS];
 891             t = (*p)->opd[t & ~SAME_AS];
 892         }
 893
 894         output[slen++] = (colon ? ':' : i == 0 ? ' ' : ',');
 895
 896         offs = o->offset;
 897         if (o->segment & SEG_RELATIVE) {
 898             offs += offset + length;
 899             /*
 900              * sort out wraparound
 901              */
 902             if (!(o->segment & (SEG_32BIT|SEG_64BIT)))
 903                 offs &= 0xffff;
 904             /*
 905              * add sync marker, if autosync is on
 906              */
 907             if (autosync)
 908                 add_sync(offs, 0L);
 909         }
 910
 911         if (t & COLON)
 912             colon = true;
 913         else
 914             colon = false;
 915
 916         if ((t & (REGISTER | FPUREG)) ||
 917             (o->segment & SEG_RMREG)) {
 918             enum reg_enum reg;
 919             reg = whichreg(t, o->basereg, ins.rex);
 920             if (t & TO)
 921                 slen += snprintf(output + slen, outbufsize - slen, "to ");
 922             slen += snprintf(output + slen, outbufsize - slen, "%s",
 923                              reg_names[reg - EXPR_REG_START]);
 924         } else if (!(UNITY & ~t)) {
 925             output[slen++] = '1';
 926         } else if (t & IMMEDIATE) {
 927             if (t & BITS8) {
 928                 slen +=
 929                     snprintf(output + slen, outbufsize - slen, "byte ");
 930                 if (o->segment & SEG_SIGNED) {
 931                     if (offs < 0) {
 932                         offs *= -1;
 933                         output[slen++] = '-';
 934                     } else
 935                         output[slen++] = '+';
 936                 }
 937             } else if (t & BITS16) {
 938                 slen +=
 939                     snprintf(output + slen, outbufsize - slen, "word ");
 940             } else if (t & BITS32) {
 941                 slen +=
 942                     snprintf(output + slen, outbufsize - slen, "dword ");
 943             } else if (t & BITS64) {
 944                 slen +=
 945                     snprintf(output + slen, outbufsize - slen, "qword ");
 946             } else if (t & NEAR) {
 947                 slen +=
 948                     snprintf(output + slen, outbufsize - slen, "near ");
 949             } else if (t & SHORT) {
 950                 slen +=
 951                     snprintf(output + slen, outbufsize - slen, "short ");
 952             }
 953             slen +=
 954                 snprintf(output + slen, outbufsize - slen, "0x%"PRIx64"",
 955                          offs);
 956         } else if (!(MEM_OFFS & ~t)) {
 957             slen +=
 958                 snprintf(output + slen, outbufsize - slen, "[%s%s%s0x%"PRIx64"]",
 959                          (segover ? segover : ""),
 960                          (segover ? ":" : ""),
 961                          (o->disp_size ==
 962                           32 ? "dword " : o->disp_size ==
 963                           16 ? "word " : ""), offs);
 964             segover = NULL;
 965         } else if (!(REGMEM & ~t)) {
 966             int started = false;
 967             if (t & BITS8)
 968                 slen +=
 969                     snprintf(output + slen, outbufsize - slen, "byte ");
 970             if (t & BITS16)
 971                 slen +=
 972                     snprintf(output + slen, outbufsize - slen, "word ");
 973             if (t & BITS32)
 974                 slen +=
 975                     snprintf(output + slen, outbufsize - slen, "dword ");
 976             if (t & BITS64)
 977                 slen +=
 978                     snprintf(output + slen, outbufsize - slen, "qword ");
 979             if (t & BITS80)
 980                 slen +=
 981                     snprintf(output + slen, outbufsize - slen, "tword ");
 982             if (t & FAR)
 983                 slen += snprintf(output + slen, outbufsize - slen, "far ");
 984             if (t & NEAR)
 985                 slen +=
 986                     snprintf(output + slen, outbufsize - slen, "near ");
 987             output[slen++] = '[';
 988             if (o->disp_size)
 989                 slen += snprintf(output + slen, outbufsize - slen, "%s",
 990                                  (o->disp_size == 64 ? "qword " :
 991                                   o->disp_size == 32 ? "dword " :
 992                                   o->disp_size == 16 ? "word " :
 993                                   ""));
 994             if (o->eaflags & EAF_REL)
 995                 slen += snprintf(output + slen, outbufsize - slen, "rel ");
 996             if (segover) {
 997                 slen +=
 998                     snprintf(output + slen, outbufsize - slen, "%s:",
 999                              segover);
1000                 segover = NULL;
1001             }
1002             if (o->basereg != -1) {
1003                 slen += snprintf(output + slen, outbufsize - slen, "%s",
1004                                  reg_names[(o->basereg -
1005                                             EXPR_REG_START)]);
1006                 started = true;
1007             }
1008             if (o->indexreg != -1) {
1009                 if (started)
1010                     output[slen++] = '+';
1011                 slen += snprintf(output + slen, outbufsize - slen, "%s",
1012                                  reg_names[(o->indexreg -
1013                                             EXPR_REG_START)]);
1014                 if (o->scale > 1)
1015                     slen +=
1016                         snprintf(output + slen, outbufsize - slen, "*%d",
1017                                  o->scale);
1018                 started = true;
1019             }
1020             if (o->segment & SEG_DISP8) {
1021                 int minus = 0;
1022                 int8_t offset = offs;
1023                 if (offset < 0) {
1024                     minus = 1;
1025                     offset = -offset;
1026                 }
1027                 slen +=
1028                     snprintf(output + slen, outbufsize - slen, "%s0x%"PRIx8"",
1029                              minus ? "-" : "+", offset);
1030             } else if (o->segment & SEG_DISP16) {
1031                 int minus = 0;
1032                 int16_t offset = offs;
1033                 if (offset < 0) {
1034                     minus = 1;
1035                     offset = -offset;
1036                 }
1037                 slen +=
1038                     snprintf(output + slen, outbufsize - slen, "%s0x%"PRIx16"",
1039                              minus ? "-" : started ? "+" : "", offset);
1040             } else if (o->segment & SEG_DISP32) {
1041                     char *prefix = "";
1042                     int32_t offset = offs;
1043                     if (offset < 0) {
1044                         offset = -offset;
1045                         prefix = "-";
1046                     } else {
1047                         prefix = started ? "+" : "";
1048                     }
1049                     slen +=
1050                         snprintf(output + slen, outbufsize - slen,
1051                                  "%s0x%"PRIx32"", prefix, offset);
1052             }
1053             output[slen++] = ']';
1054         } else {
1055             slen +=
1056                 snprintf(output + slen, outbufsize - slen, "<operand%d>",
1057                          i);
1058         }
1059     }
1060     output[slen] = '\0';
1061     if (segover) {              /* unused segment override */
1062         char *p = output;
1063         int count = slen + 1;
1064         while (count--)
1065             p[count + 3] = p[count];
1066         strncpy(output, segover, 2);
1067         output[2] = ' ';
1068     }
1069     return length;
1070 }
1071
1072 int32_t eatbyte(uint8_t *data, char *output, int outbufsize)
1073 {
1074     snprintf(output, outbufsize, "db 0x%02X", *data);
1075     return 1;
1076 }