arch/x86/lib/insn.c

   1 /*
   2  * x86 instruction analysis
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17  *
  18  * Copyright (C) IBM Corporation, 2002, 2004, 2009
  19  */
  20
  21 #ifdef __KERNEL__
  22 #include <linux/string.h>
  23 #else
  24 #include <string.h>
  25 #endif
  26 #include <asm/inat.h>
  27 #include <asm/insn.h>
  28
  29 /* Verify next sizeof(t) bytes can be on the same instruction */
  30 #define validate_next(t, insn, n)       \
  31         ((insn)->next_byte + sizeof(t) + n <= (insn)->end_kaddr)
  32
  33 #define __get_next(t, insn)     \
  34         ({ t r = *(t*)insn->next_byte; insn->next_byte += sizeof(t); r; })
  35
  36 #define __peek_nbyte_next(t, insn, n)   \
  37         ({ t r = *(t*)((insn)->next_byte + n); r; })
  38
  39 #define get_next(t, insn)       \
  40         ({ if (unlikely(!validate_next(t, insn, 0))) goto err_out; __get_next(t, insn); })
  41
  42 #define peek_nbyte_next(t, insn, n)     \
  43         ({ if (unlikely(!validate_next(t, insn, n))) goto err_out; __peek_nbyte_next(t, insn, n); })
  44
  45 #define peek_next(t, insn)      peek_nbyte_next(t, insn, 0)
  46
  47 /**
  48  * insn_init() - initialize struct insn
  49  * @insn:       &struct insn to be initialized
  50  * @kaddr:      address (in kernel memory) of instruction (or copy thereof)
  51  * @x86_64:     !0 for 64-bit kernel or 64-bit app
  52  */
  53 void insn_init(struct insn *insn, const void *kaddr, int buf_len, int x86_64)
  54 {
  55         memset(insn, 0, sizeof(*insn));
  56         insn->kaddr = kaddr;
  57         insn->end_kaddr = kaddr + buf_len;
  58         insn->next_byte = kaddr;
  59         insn->x86_64 = x86_64 ? 1 : 0;
  60         insn->opnd_bytes = 4;
  61         if (x86_64)
  62                 insn->addr_bytes = 8;
  63         else
  64                 insn->addr_bytes = 4;
  65 }
  66
  67 /**
  68  * insn_get_prefixes - scan x86 instruction prefix bytes
  69  * @insn:       &struct insn containing instruction
  70  *
  71  * Populates the @insn->prefixes bitmap, and updates @insn->next_byte
  72  * to point to the (first) opcode.  No effect if @insn->prefixes.got
  73  * is already set.
  74  */
  75 void insn_get_prefixes(struct insn *insn)
  76 {
  77         struct insn_field *prefixes = &insn->prefixes;
  78         insn_attr_t attr;
  79         insn_byte_t b, lb;
  80         int i, nb;
  81
  82         if (prefixes->got)
  83                 return;
  84
  85         nb = 0;
  86         lb = 0;
  87         b = peek_next(insn_byte_t, insn);
  88         attr = inat_get_opcode_attribute(b);
  89         while (inat_is_legacy_prefix(attr)) {
  90                 /* Skip if same prefix */
  91                 for (i = 0; i < nb; i++)
  92                         if (prefixes->bytes[i] == b)
  93                                 goto found;
  94                 if (nb == 4)
  95                         /* Invalid instruction */
  96                         break;
  97                 prefixes->bytes[nb++] = b;
  98                 if (inat_is_address_size_prefix(attr)) {
  99                         /* address size switches 2/4 or 4/8 */
 100                         if (insn->x86_64)
 101                                 insn->addr_bytes ^= 12;
 102                         else
 103                                 insn->addr_bytes ^= 6;
 104                 } else if (inat_is_operand_size_prefix(attr)) {
 105                         /* oprand size switches 2/4 */
 106                         insn->opnd_bytes ^= 6;
 107                 }
 108 found:
 109                 prefixes->nbytes++;
 110                 insn->next_byte++;
 111                 lb = b;
 112                 b = peek_next(insn_byte_t, insn);
 113                 attr = inat_get_opcode_attribute(b);
 114         }
 115         /* Set the last prefix */
 116         if (lb && lb != insn->prefixes.bytes[3]) {
 117                 if (unlikely(insn->prefixes.bytes[3])) {
 118                         /* Swap the last prefix */
 119                         b = insn->prefixes.bytes[3];
 120                         for (i = 0; i < nb; i++)
 121                                 if (prefixes->bytes[i] == lb)
 122                                         prefixes->bytes[i] = b;
 123                 }
 124                 insn->prefixes.bytes[3] = lb;
 125         }
 126
 127         /* Decode REX prefix */
 128         if (insn->x86_64) {
 129                 b = peek_next(insn_byte_t, insn);
 130                 attr = inat_get_opcode_attribute(b);
 131                 if (inat_is_rex_prefix(attr)) {
 132                         insn->rex_prefix.value = b;
 133                         insn->rex_prefix.nbytes = 1;
 134                         insn->next_byte++;
 135                         if (X86_REX_W(b))
 136                                 /* REX.W overrides opnd_size */
 137                                 insn->opnd_bytes = 8;
 138                 }
 139         }
 140         insn->rex_prefix.got = 1;
 141
 142         /* Decode VEX prefix */
 143         b = peek_next(insn_byte_t, insn);
 144         attr = inat_get_opcode_attribute(b);
 145         if (inat_is_vex_prefix(attr)) {
 146                 insn_byte_t b2 = peek_nbyte_next(insn_byte_t, insn, 1);
 147                 if (!insn->x86_64) {
 148                         /*
 149                          * In 32-bits mode, if the [7:6] bits (mod bits of
 150                          * ModRM) on the second byte are not 11b, it is
 151                          * LDS or LES.
 152                          */
 153                         if (X86_MODRM_MOD(b2) != 3)
 154                                 goto vex_end;
 155                 }
 156                 insn->vex_prefix.bytes[0] = b;
 157                 insn->vex_prefix.bytes[1] = b2;
 158                 if (inat_is_vex3_prefix(attr)) {
 159                         b2 = peek_nbyte_next(insn_byte_t, insn, 2);
 160                         insn->vex_prefix.bytes[2] = b2;
 161                         insn->vex_prefix.nbytes = 3;
 162                         insn->next_byte += 3;
 163                         if (insn->x86_64 && X86_VEX_W(b2))
 164                                 /* VEX.W overrides opnd_size */
 165                                 insn->opnd_bytes = 8;
 166                 } else {
 167                         /*
 168                          * For VEX2, fake VEX3-like byte#2.
 169                          * Makes it easier to decode vex.W, vex.vvvv,
 170                          * vex.L and vex.pp. Masking with 0x7f sets vex.W == 0.
 171                          */
 172                         insn->vex_prefix.bytes[2] = b2 & 0x7f;
 173                         insn->vex_prefix.nbytes = 2;
 174                         insn->next_byte += 2;
 175                 }
 176         }
 177 vex_end:
 178         insn->vex_prefix.got = 1;
 179
 180         prefixes->got = 1;
 181
 182 err_out:
 183         return;
 184 }
 185
 186 /**
 187  * insn_get_opcode - collect opcode(s)
 188  * @insn:       &struct insn containing instruction
 189  *
 190  * Populates @insn->opcode, updates @insn->next_byte to point past the
 191  * opcode byte(s), and set @insn->attr (except for groups).
 192  * If necessary, first collects any preceding (prefix) bytes.
 193  * Sets @insn->opcode.value = opcode1.  No effect if @insn->opcode.got
 194  * is already 1.
 195  */
 196 void insn_get_opcode(struct insn *insn)
 197 {
 198         struct insn_field *opcode = &insn->opcode;
 199         insn_byte_t op;
 200         int pfx_id;
 201         if (opcode->got)
 202                 return;
 203         if (!insn->prefixes.got)
 204                 insn_get_prefixes(insn);
 205
 206         /* Get first opcode */
 207         op = get_next(insn_byte_t, insn);
 208         opcode->bytes[0] = op;
 209         opcode->nbytes = 1;
 210
 211         /* Check if there is VEX prefix or not */
 212         if (insn_is_avx(insn)) {
 213                 insn_byte_t m, p;
 214                 m = insn_vex_m_bits(insn);
 215                 p = insn_vex_p_bits(insn);
 216                 insn->attr = inat_get_avx_attribute(op, m, p);
 217                 if (!inat_accept_vex(insn->attr) && !inat_is_group(insn->attr))
 218                         insn->attr = 0; /* This instruction is bad */
 219                 goto end;       /* VEX has only 1 byte for opcode */
 220         }
 221
 222         insn->attr = inat_get_opcode_attribute(op);
 223         while (inat_is_escape(insn->attr)) {
 224                 /* Get escaped opcode */
 225                 op = get_next(insn_byte_t, insn);
 226                 opcode->bytes[opcode->nbytes++] = op;
 227                 pfx_id = insn_last_prefix_id(insn);
 228                 insn->attr = inat_get_escape_attribute(op, pfx_id, insn->attr);
 229         }
 230         if (inat_must_vex(insn->attr))
 231                 insn->attr = 0; /* This instruction is bad */
 232 end:
 233         opcode->got = 1;
 234
 235 err_out:
 236         return;
 237 }
 238
 239 /**
 240  * insn_get_modrm - collect ModRM byte, if any
 241  * @insn:       &struct insn containing instruction
 242  *
 243  * Populates @insn->modrm and updates @insn->next_byte to point past the
 244  * ModRM byte, if any.  If necessary, first collects the preceding bytes
 245  * (prefixes and opcode(s)).  No effect if @insn->modrm.got is already 1.
 246  */
 247 void insn_get_modrm(struct insn *insn)
 248 {
 249         struct insn_field *modrm = &insn->modrm;
 250         insn_byte_t pfx_id, mod;
 251         if (modrm->got)
 252                 return;
 253         if (!insn->opcode.got)
 254                 insn_get_opcode(insn);
 255
 256         if (inat_has_modrm(insn->attr)) {
 257                 mod = get_next(insn_byte_t, insn);
 258                 modrm->value = mod;
 259                 modrm->nbytes = 1;
 260                 if (inat_is_group(insn->attr)) {
 261                         pfx_id = insn_last_prefix_id(insn);
 262                         insn->attr = inat_get_group_attribute(mod, pfx_id,
 263                                                               insn->attr);
 264                         if (insn_is_avx(insn) && !inat_accept_vex(insn->attr))
 265                                 insn->attr = 0; /* This is bad */
 266                 }
 267         }
 268
 269         if (insn->x86_64 && inat_is_force64(insn->attr))
 270                 insn->opnd_bytes = 8;
 271         modrm->got = 1;
 272
 273 err_out:
 274         return;
 275 }
 276
 277
 278 /**
 279  * insn_rip_relative() - Does instruction use RIP-relative addressing mode?
 280  * @insn:       &struct insn containing instruction
 281  *
 282  * If necessary, first collects the instruction up to and including the
 283  * ModRM byte.  No effect if @insn->x86_64 is 0.
 284  */
 285 int insn_rip_relative(struct insn *insn)
 286 {
 287         struct insn_field *modrm = &insn->modrm;
 288
 289         if (!insn->x86_64)
 290                 return 0;
 291         if (!modrm->got)
 292                 insn_get_modrm(insn);
 293         /*
 294          * For rip-relative instructions, the mod field (top 2 bits)
 295          * is zero and the r/m field (bottom 3 bits) is 0x5.
 296          */
 297         return (modrm->nbytes && (modrm->value & 0xc7) == 0x5);
 298 }
 299
 300 /**
 301  * insn_get_sib() - Get the SIB byte of instruction
 302  * @insn:       &struct insn containing instruction
 303  *
 304  * If necessary, first collects the instruction up to and including the
 305  * ModRM byte.
 306  */
 307 void insn_get_sib(struct insn *insn)
 308 {
 309         insn_byte_t modrm;
 310
 311         if (insn->sib.got)
 312                 return;
 313         if (!insn->modrm.got)
 314                 insn_get_modrm(insn);
 315         if (insn->modrm.nbytes) {
 316                 modrm = (insn_byte_t)insn->modrm.value;
 317                 if (insn->addr_bytes != 2 &&
 318                     X86_MODRM_MOD(modrm) != 3 && X86_MODRM_RM(modrm) == 4) {
 319                         insn->sib.value = get_next(insn_byte_t, insn);
 320                         insn->sib.nbytes = 1;
 321                 }
 322         }
 323         insn->sib.got = 1;
 324
 325 err_out:
 326         return;
 327 }
 328
 329
 330 /**
 331  * insn_get_displacement() - Get the displacement of instruction
 332  * @insn:       &struct insn containing instruction
 333  *
 334  * If necessary, first collects the instruction up to and including the
 335  * SIB byte.
 336  * Displacement value is sign-expanded.
 337  */
 338 void insn_get_displacement(struct insn *insn)
 339 {
 340         insn_byte_t mod, rm, base;
 341
 342         if (insn->displacement.got)
 343                 return;
 344         if (!insn->sib.got)
 345                 insn_get_sib(insn);
 346         if (insn->modrm.nbytes) {
 347                 /*
 348                  * Interpreting the modrm byte:
 349                  * mod = 00 - no displacement fields (exceptions below)
 350                  * mod = 01 - 1-byte displacement field
 351                  * mod = 10 - displacement field is 4 bytes, or 2 bytes if
 352                  *      address size = 2 (0x67 prefix in 32-bit mode)
 353                  * mod = 11 - no memory operand
 354                  *
 355                  * If address size = 2...
 356                  * mod = 00, r/m = 110 - displacement field is 2 bytes
 357                  *
 358                  * If address size != 2...
 359                  * mod != 11, r/m = 100 - SIB byte exists
 360                  * mod = 00, SIB base = 101 - displacement field is 4 bytes
 361                  * mod = 00, r/m = 101 - rip-relative addressing, displacement
 362                  *      field is 4 bytes
 363                  */
 364                 mod = X86_MODRM_MOD(insn->modrm.value);
 365                 rm = X86_MODRM_RM(insn->modrm.value);
 366                 base = X86_SIB_BASE(insn->sib.value);
 367                 if (mod == 3)
 368                         goto out;
 369                 if (mod == 1) {
 370                         insn->displacement.value = get_next(char, insn);
 371                         insn->displacement.nbytes = 1;
 372                 } else if (insn->addr_bytes == 2) {
 373                         if ((mod == 0 && rm == 6) || mod == 2) {
 374                                 insn->displacement.value =
 375                                          get_next(short, insn);
 376                                 insn->displacement.nbytes = 2;
 377                         }
 378                 } else {
 379                         if ((mod == 0 && rm == 5) || mod == 2 ||
 380                             (mod == 0 && base == 5)) {
 381                                 insn->displacement.value = get_next(int, insn);
 382                                 insn->displacement.nbytes = 4;
 383                         }
 384                 }
 385         }
 386 out:
 387         insn->displacement.got = 1;
 388
 389 err_out:
 390         return;
 391 }
 392
 393 /* Decode moffset16/32/64. Return 0 if failed */
 394 static int __get_moffset(struct insn *insn)
 395 {
 396         switch (insn->addr_bytes) {
 397         case 2:
 398                 insn->moffset1.value = get_next(short, insn);
 399                 insn->moffset1.nbytes = 2;
 400                 break;
 401         case 4:
 402                 insn->moffset1.value = get_next(int, insn);
 403                 insn->moffset1.nbytes = 4;
 404                 break;
 405         case 8:
 406                 insn->moffset1.value = get_next(int, insn);
 407                 insn->moffset1.nbytes = 4;
 408                 insn->moffset2.value = get_next(int, insn);
 409                 insn->moffset2.nbytes = 4;
 410                 break;
 411         default:        /* opnd_bytes must be modified manually */
 412                 goto err_out;
 413         }
 414         insn->moffset1.got = insn->moffset2.got = 1;
 415
 416         return 1;
 417
 418 err_out:
 419         return 0;
 420 }
 421
 422 /* Decode imm v32(Iz). Return 0 if failed */
 423 static int __get_immv32(struct insn *insn)
 424 {
 425         switch (insn->opnd_bytes) {
 426         case 2:
 427                 insn->immediate.value = get_next(short, insn);
 428                 insn->immediate.nbytes = 2;
 429                 break;
 430         case 4:
 431         case 8:
 432                 insn->immediate.value = get_next(int, insn);
 433                 insn->immediate.nbytes = 4;
 434                 break;
 435         default:        /* opnd_bytes must be modified manually */
 436                 goto err_out;
 437         }
 438
 439         return 1;
 440
 441 err_out:
 442         return 0;
 443 }
 444
 445 /* Decode imm v64(Iv/Ov), Return 0 if failed */
 446 static int __get_immv(struct insn *insn)
 447 {
 448         switch (insn->opnd_bytes) {
 449         case 2:
 450                 insn->immediate1.value = get_next(short, insn);
 451                 insn->immediate1.nbytes = 2;
 452                 break;
 453         case 4:
 454                 insn->immediate1.value = get_next(int, insn);
 455                 insn->immediate1.nbytes = 4;
 456                 break;
 457         case 8:
 458                 insn->immediate1.value = get_next(int, insn);
 459                 insn->immediate1.nbytes = 4;
 460                 insn->immediate2.value = get_next(int, insn);
 461                 insn->immediate2.nbytes = 4;
 462                 break;
 463         default:        /* opnd_bytes must be modified manually */
 464                 goto err_out;
 465         }
 466         insn->immediate1.got = insn->immediate2.got = 1;
 467
 468         return 1;
 469 err_out:
 470         return 0;
 471 }
 472
 473 /* Decode ptr16:16/32(Ap) */
 474 static int __get_immptr(struct insn *insn)
 475 {
 476         switch (insn->opnd_bytes) {
 477         case 2:
 478                 insn->immediate1.value = get_next(short, insn);
 479                 insn->immediate1.nbytes = 2;
 480                 break;
 481         case 4:
 482                 insn->immediate1.value = get_next(int, insn);
 483                 insn->immediate1.nbytes = 4;
 484                 break;
 485         case 8:
 486                 /* ptr16:64 is not exist (no segment) */
 487                 return 0;
 488         default:        /* opnd_bytes must be modified manually */
 489                 goto err_out;
 490         }
 491         insn->immediate2.value = get_next(unsigned short, insn);
 492         insn->immediate2.nbytes = 2;
 493         insn->immediate1.got = insn->immediate2.got = 1;
 494
 495         return 1;
 496 err_out:
 497         return 0;
 498 }
 499
 500 /**
 501  * insn_get_immediate() - Get the immediates of instruction
 502  * @insn:       &struct insn containing instruction
 503  *
 504  * If necessary, first collects the instruction up to and including the
 505  * displacement bytes.
 506  * Basically, most of immediates are sign-expanded. Unsigned-value can be
 507  * get by bit masking with ((1 << (nbytes * 8)) - 1)
 508  */
 509 void insn_get_immediate(struct insn *insn)
 510 {
 511         if (insn->immediate.got)
 512                 return;
 513         if (!insn->displacement.got)
 514                 insn_get_displacement(insn);
 515
 516         if (inat_has_moffset(insn->attr)) {
 517                 if (!__get_moffset(insn))
 518                         goto err_out;
 519                 goto done;
 520         }
 521
 522         if (!inat_has_immediate(insn->attr))
 523                 /* no immediates */
 524                 goto done;
 525
 526         switch (inat_immediate_size(insn->attr)) {
 527         case INAT_IMM_BYTE:
 528                 insn->immediate.value = get_next(char, insn);
 529                 insn->immediate.nbytes = 1;
 530                 break;
 531         case INAT_IMM_WORD:
 532                 insn->immediate.value = get_next(short, insn);
 533                 insn->immediate.nbytes = 2;
 534                 break;
 535         case INAT_IMM_DWORD:
 536                 insn->immediate.value = get_next(int, insn);
 537                 insn->immediate.nbytes = 4;
 538                 break;
 539         case INAT_IMM_QWORD:
 540                 insn->immediate1.value = get_next(int, insn);
 541                 insn->immediate1.nbytes = 4;
 542                 insn->immediate2.value = get_next(int, insn);
 543                 insn->immediate2.nbytes = 4;
 544                 break;
 545         case INAT_IMM_PTR:
 546                 if (!__get_immptr(insn))
 547                         goto err_out;
 548                 break;
 549         case INAT_IMM_VWORD32:
 550                 if (!__get_immv32(insn))
 551                         goto err_out;
 552                 break;
 553         case INAT_IMM_VWORD:
 554                 if (!__get_immv(insn))
 555                         goto err_out;
 556                 break;
 557         default:
 558                 /* Here, insn must have an immediate, but failed */
 559                 goto err_out;
 560         }
 561         if (inat_has_second_immediate(insn->attr)) {
 562                 insn->immediate2.value = get_next(char, insn);
 563                 insn->immediate2.nbytes = 1;
 564         }
 565 done:
 566         insn->immediate.got = 1;
 567
 568 err_out:
 569         return;
 570 }
 571
 572 /**
 573  * insn_get_length() - Get the length of instruction
 574  * @insn:       &struct insn containing instruction
 575  *
 576  * If necessary, first collects the instruction up to and including the
 577  * immediates bytes.
 578  */
 579 void insn_get_length(struct insn *insn)
 580 {
 581         if (insn->length)
 582                 return;
 583         if (!insn->immediate.got)
 584                 insn_get_immediate(insn);
 585         insn->length = (unsigned char)((unsigned long)insn->next_byte
 586                                      - (unsigned long)insn->kaddr);
 587 }