Un-special-case "xchg rax,rax"; disassemble o64
[platform/upstream/nasm.git] / 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 == 16)
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 #define case4(x) case (x): case (x)+1: case (x)+2: case (x)+3
366
367 static int matches(const struct itemplate *t, uint8_t *data,
368                    const struct prefix_info *prefix, int segsize, insn *ins)
369 {
370     uint8_t *r = (uint8_t *)(t->code);
371     uint8_t *origdata = data;
372     bool a_used = false, o_used = false;
373     enum prefixes drep = 0;
374     uint8_t lock = prefix->lock;
375     int osize = prefix->osize;
376     int asize = prefix->asize;
377     int i, c;
378
379     for (i = 0; i < MAX_OPERANDS; i++) {
380         ins->oprs[i].segment = ins->oprs[i].disp_size =
381             (segsize == 64 ? SEG_64BIT : segsize == 32 ? SEG_32BIT : 0);
382     }
383     ins->condition = -1;
384     ins->rex = prefix->rex;
385     memset(ins->prefixes, 0, sizeof ins->prefixes);
386
387     if (t->flags & (segsize == 64 ? IF_NOLONG : IF_LONG))
388         return false;
389
390     if (prefix->rep == 0xF2)
391         drep = P_REPNE;
392     else if (prefix->rep == 0xF3)
393         drep = P_REP;
394
395     while ((c = *r++) != 0) {
396         switch (c) {
397         case 01:
398         case 02:
399         case 03:
400             while (c--)
401                 if (*r++ != *data++)
402                     return false;
403             break;
404
405         case 04:
406             switch (*data++) {
407             case 0x07:
408                 ins->oprs[0].basereg = 0;
409                 break;
410             case 0x17:
411                 ins->oprs[0].basereg = 2;
412                 break;
413             case 0x1F:
414                 ins->oprs[0].basereg = 3;
415                 break;
416             default:
417                 return false;
418             }
419             break;
420
421         case 05:
422             switch (*data++) {
423             case 0xA1:
424                 ins->oprs[0].basereg = 4;
425                 break;
426             case 0xA9:
427                 ins->oprs[0].basereg = 5;
428                 break;
429             default:
430                 return false;
431             }
432             break;
433
434         case 06:
435             switch (*data++) {
436             case 0x06:
437                 ins->oprs[0].basereg = 0;
438                 break;
439             case 0x0E:
440                 ins->oprs[0].basereg = 1;
441                 break;
442             case 0x16:
443                 ins->oprs[0].basereg = 2;
444                 break;
445             case 0x1E:
446                 ins->oprs[0].basereg = 3;
447                 break;
448             default:
449                 return false;
450             }
451             break;
452
453         case 07:
454             switch (*data++) {
455             case 0xA0:
456                 ins->oprs[0].basereg = 4;
457                 break;
458             case 0xA8:
459                 ins->oprs[0].basereg = 5;
460                 break;
461             default:
462                 return false;
463             }
464             break;
465
466         case4(010):
467         {
468             int t = *r++, d = *data++;
469             if (d < t || d > t + 7)
470                 return false;
471             else {
472                 ins->oprs[c - 010].basereg = (d-t)+
473                     (ins->rex & REX_B ? 8 : 0);
474                 ins->oprs[c - 010].segment |= SEG_RMREG;
475             }
476             break;
477         }
478
479         case4(014):
480             ins->oprs[c - 014].offset = (int8_t)*data++;
481             ins->oprs[c - 014].segment |= SEG_SIGNED;
482             break;
483
484         case4(020):
485             ins->oprs[c - 020].offset = *data++;
486             break;
487
488         case4(024):
489             ins->oprs[c - 024].offset = *data++;
490             break;
491
492         case4(030):
493             ins->oprs[c - 030].offset = getu16(data);
494             data += 2;
495             break;
496
497         case4(034):
498             if (osize == 32) {
499                 ins->oprs[c - 034].offset = getu32(data);
500                 data += 4;
501             } else {
502                 ins->oprs[c - 034].offset = getu16(data);
503                 data += 2;
504             }
505             if (segsize != asize)
506                 ins->oprs[c - 034].disp_size = asize;
507             break;
508
509         case4(040):
510             ins->oprs[c - 040].offset = getu32(data);
511             data += 4;
512             break;
513
514         case4(044):
515             switch (asize) {
516             case 16:
517                 ins->oprs[c - 044].offset = getu16(data);
518                 data += 2;
519                 if (segsize != 16)
520                     ins->oprs[c - 044].disp_size = 16;
521                 break;
522             case 32:
523                 ins->oprs[c - 044].offset = getu32(data);
524                 data += 4;
525                 if (segsize == 16)
526                     ins->oprs[c - 044].disp_size = 32;
527                 break;
528             case 64:
529                 ins->oprs[c - 044].offset = getu64(data);
530                 ins->oprs[c - 044].disp_size = 64;
531                 data += 8;
532                 break;
533             }
534             break;
535
536         case4(050):
537             ins->oprs[c - 050].offset = gets8(data++);
538             ins->oprs[c - 050].segment |= SEG_RELATIVE;
539             break;
540
541         case4(054):
542             ins->oprs[c - 054].offset = getu64(data);
543             data += 8;
544             break;
545
546         case4(060):
547             ins->oprs[c - 060].offset = gets16(data);
548             data += 2;
549             ins->oprs[c - 060].segment |= SEG_RELATIVE;
550             ins->oprs[c - 060].segment &= ~SEG_32BIT;
551             break;
552
553         case4(064):
554             ins->oprs[c - 064].segment |= SEG_RELATIVE;
555             if (osize == 16) {
556                 ins->oprs[c - 064].offset = getu16(data);
557                 data += 2;
558                 ins->oprs[c - 064].segment &= ~(SEG_32BIT|SEG_64BIT);
559             } else if (osize == 32) {
560                 ins->oprs[c - 064].offset = getu32(data);
561                 data += 4;
562                 ins->oprs[c - 064].segment &= ~SEG_64BIT;
563                 ins->oprs[c - 064].segment |= SEG_32BIT;
564             }
565             if (segsize != osize) {
566                 ins->oprs[c - 064].type =
567                     (ins->oprs[c - 064].type & ~SIZE_MASK)
568                     | ((osize == 16) ? BITS16 : BITS32);
569             }
570             break;
571
572         case4(070):
573             ins->oprs[c - 070].offset = getu32(data);
574             data += 4;
575             ins->oprs[c - 070].segment |= SEG_32BIT | SEG_RELATIVE;
576             break;
577
578         case4(0100):
579         case4(0110):
580         case4(0120):
581         case4(0130):
582         {
583             int modrm = *data++;
584             ins->oprs[c & 07].segment |= SEG_RMREG;
585             data = do_ea(data, modrm, asize, segsize,
586                          &ins->oprs[(c >> 3) & 07], ins);
587             if (!data)
588                 return false;
589             ins->oprs[c & 07].basereg = ((modrm >> 3)&7)+
590                 (ins->rex & REX_R ? 8 : 0);
591             break;
592         }
593
594         case4(0140):
595             ins->oprs[c - 0140].offset = getu16(data);
596             data += 2;
597             break;
598
599         case4(0150):
600             ins->oprs[c - 0150].offset = getu32(data);
601             data += 4;
602             break;
603
604         case4(0160):
605             ins->rex |= REX_D;
606             ins->drexdst = c & 3;
607             break;
608
609         case4(0164):
610             ins->rex |= REX_D|REX_OC;
611             ins->drexdst = c & 3;
612             break;
613
614         case 0170:
615             if (*data++)
616                 return false;
617             break;
618
619         case 0171:
620             data = do_drex(data, ins);
621             if (!data)
622                 return false;
623             break;
624
625         case4(0200):
626         case4(0204):
627         case4(0210):
628         case4(0214):
629         case4(0220):
630         case4(0224):
631         case4(0230):
632         case4(0234):
633         {
634             int modrm = *data++;
635             if (((modrm >> 3) & 07) != (c & 07))
636                 return false;   /* spare field doesn't match up */
637             data = do_ea(data, modrm, asize, segsize,
638                          &ins->oprs[(c >> 3) & 07], ins);
639             if (!data)
640                 return false;
641             break;
642         }
643
644         case 0310:
645             if (asize != 16)
646                 return false;
647             else
648                 a_used = true;
649             break;
650
651         case 0311:
652             if (asize == 16)
653                 return false;
654             else
655                 a_used = true;
656             break;
657
658         case 0312:
659             if (asize != segsize)
660                 return false;
661             else
662                 a_used = true;
663             break;
664
665         case 0313:
666             if (asize != 64)
667                 return false;
668             else
669                 a_used = true;
670             break;
671
672         case 0314:
673             if (prefix->rex & REX_B)
674                 return false;
675             break;
676
677         case 0315:
678             if (prefix->rex & REX_X)
679                 return false;
680             break;
681
682         case 0316:
683             if (prefix->rex & REX_R)
684                 return false;
685             break;
686
687         case 0317:
688             if (prefix->rex & REX_W)
689                 return false;
690             break;
691
692         case 0320:
693             if (osize != 16)
694                 return false;
695             else
696                 o_used = true;
697             break;
698
699         case 0321:
700             if (osize != 32)
701                 return false;
702             else
703                 o_used = true;
704             break;
705
706         case 0322:
707             if (osize != (segsize == 16) ? 16 : 32)
708                 return false;
709             else
710                 o_used = true;
711             break;
712
713         case 0323:
714             ins->rex |= REX_W;  /* 64-bit only instruction */
715             osize = 64;
716             o_used = true;
717             break;
718
719         case 0324:
720             if (!(ins->rex & (REX_P|REX_W)) || osize != 64)
721                 return false;
722             o_used = true;
723             break;
724
725         case 0330:
726         {
727             int t = *r++, d = *data++;
728             if (d < t || d > t + 15)
729                 return false;
730             else
731                 ins->condition = d - t;
732             break;
733         }
734
735         case 0331:
736             if (prefix->rep)
737                 return false;
738             break;
739
740         case 0332:
741             if (prefix->rep != 0xF2)
742                 return false;
743             break;
744
745         case 0333:
746             if (prefix->rep != 0xF3)
747                 return false;
748             drep = 0;
749             break;
750
751         case 0334:
752             if (lock) {
753                 ins->rex |= REX_R;
754                 lock = 0;
755             }
756             break;
757
758         case 0335:
759             if (drep == P_REP)
760                 drep = P_REPE;
761             break;
762
763         case 0340:
764             return false;
765
766         case 0364:
767             if (prefix->osp)
768                 return false;
769             break;
770
771         case 0365:
772             if (prefix->asp)
773                 return false;
774             break;
775
776         case 0366:
777             if (!prefix->osp)
778                 return false;
779             o_used = true;
780             break;
781
782         case 0367:
783             if (!prefix->asp)
784                 return false;
785             a_used = true;
786             break;
787
788         default:
789             return false;       /* Unknown code */
790         }
791     }
792
793     /* REX cannot be combined with DREX */
794     if ((ins->rex & REX_D) && (prefix->rex))
795         return false;
796
797     /*
798      * Check for unused rep or a/o prefixes.
799      */
800     for (i = 0; i < t->operands; i++) {
801         if (ins->oprs[i].segment != SEG_RMREG)
802             a_used = true;
803     }
804
805     if (lock) {
806         if (ins->prefixes[PPS_LREP])
807             return false;
808         ins->prefixes[PPS_LREP] = P_LOCK;
809     }
810     if (drep) {
811         if (ins->prefixes[PPS_LREP])
812             return false;
813         ins->prefixes[PPS_LREP] = drep;
814     }
815     if (!o_used) {
816         if (osize != ((segsize == 16) ? 16 : 32)) {
817             enum prefixes pfx = 0;
818
819             switch (osize) {
820             case 16:
821                 pfx = P_O16;
822                 break;
823             case 32:
824                 pfx = P_O32;
825                 break;
826             case 64:
827                 pfx = P_O64;
828                 break;
829             }
830
831             if (ins->prefixes[PPS_OSIZE])
832                 return false;
833             ins->prefixes[PPS_OSIZE] = pfx;
834         }
835     }
836     if (!a_used && asize != segsize) {
837         if (ins->prefixes[PPS_ASIZE])
838             return false;
839         ins->prefixes[PPS_ASIZE] = asize == 16 ? P_A16 : P_A32;
840     }
841
842     /* Fix: check for redundant REX prefixes */
843
844     return data - origdata;
845 }
846
847 int32_t disasm(uint8_t *data, char *output, int outbufsize, int segsize,
848             int32_t offset, int autosync, uint32_t prefer)
849 {
850     const struct itemplate * const *p, * const *best_p;
851     const struct disasm_index *ix;
852     uint8_t *dp;
853     int length, best_length = 0;
854     char *segover;
855     int i, slen, colon, n;
856     uint8_t *origdata;
857     int works;
858     insn tmp_ins, ins;
859     uint32_t goodness, best;
860     int best_pref;
861     struct prefix_info prefix;
862     bool end_prefix;
863
864     memset(&ins, 0, sizeof ins);
865
866     /*
867      * Scan for prefixes.
868      */
869     memset(&prefix, 0, sizeof prefix);
870     prefix.asize = segsize;
871     prefix.osize = (segsize == 64) ? 32 : segsize;
872     segover = NULL;
873     origdata = data;
874
875     for (end_prefix = false; !end_prefix; ) {
876         switch (*data) {
877         case 0xF2:
878         case 0xF3:
879             prefix.rep = *data++;
880             break;
881         case 0xF0:
882             prefix.lock = *data++;
883             break;
884         case 0x2E:
885             segover = "cs", prefix.seg = *data++;
886             break;
887         case 0x36:
888             segover = "ss", prefix.seg = *data++;
889             break;
890         case 0x3E:
891             segover = "ds", prefix.seg = *data++;
892             break;
893         case 0x26:
894             segover = "es", prefix.seg = *data++;
895             break;
896         case 0x64:
897             segover = "fs", prefix.seg = *data++;
898             break;
899         case 0x65:
900             segover = "gs", prefix.seg = *data++;
901             break;
902         case 0x66:
903             prefix.osize = (segsize == 16) ? 32 : 16;
904             prefix.osp = *data++;
905             break;
906         case 0x67:
907             prefix.asize = (segsize == 32) ? 16 : 32;
908             prefix.asp = *data++;
909             break;
910         default:
911             if (segsize == 64 && (*data & 0xf0) == REX_P) {
912                 prefix.rex = *data++;
913                 if (prefix.rex & REX_W)
914                     prefix.osize = 64;
915                 end_prefix = true;
916             } else {
917                 end_prefix = true;
918             }
919         }
920     }
921
922     best = -1;                  /* Worst possible */
923     best_p = NULL;
924     best_pref = INT_MAX;
925
926     dp = data;
927     ix = itable + *dp++;
928     while (ix->n == -1) {
929         ix = (const struct disasm_index *)ix->p + *dp++;
930     }
931
932     p = (const struct itemplate * const *)ix->p;
933     for (n = ix->n; n; n--, p++) {
934         if ((length = matches(*p, data, &prefix, segsize, &tmp_ins))) {
935             works = true;
936             /*
937              * Final check to make sure the types of r/m match up.
938              * XXX: Need to make sure this is actually correct.
939              */
940             for (i = 0; i < (*p)->operands; i++) {
941                 if (!((*p)->opd[i] & SAME_AS) &&
942                     (
943                         /* If it's a mem-only EA but we have a
944                            register, die. */
945                         ((tmp_ins.oprs[i].segment & SEG_RMREG) &&
946                          !(MEMORY & ~(*p)->opd[i])) ||
947                         /* If it's a reg-only EA but we have a memory
948                            ref, die. */
949                         (!(tmp_ins.oprs[i].segment & SEG_RMREG) &&
950                          !(REG_EA & ~(*p)->opd[i]) &&
951                          !((*p)->opd[i] & REG_SMASK)) ||
952                         /* Register type mismatch (eg FS vs REG_DESS):
953                            die. */
954                         ((((*p)->opd[i] & (REGISTER | FPUREG)) ||
955                           (tmp_ins.oprs[i].segment & SEG_RMREG)) &&
956                          !whichreg((*p)->opd[i],
957                                    tmp_ins.oprs[i].basereg, tmp_ins.rex))
958                         )) {
959                     works = false;
960                     break;
961                 }
962             }
963
964             /*
965              * Note: we always prefer instructions which incorporate
966              * prefixes in the instructions themselves.  This is to allow
967              * e.g. PAUSE to be preferred to REP NOP, and deal with
968              * MMX/SSE instructions where prefixes are used to select
969              * between MMX and SSE register sets or outright opcode
970              * selection.
971              */
972             if (works) {
973                 int i, nprefix;
974                 goodness = ((*p)->flags & IF_PFMASK) ^ prefer;
975                 nprefix = 0;
976                 for (i = 0; i < MAXPREFIX; i++)
977                     if (tmp_ins.prefixes[i])
978                         nprefix++;
979                 if (nprefix < best_pref ||
980                     (nprefix == best_pref && goodness < best)) {
981                     /* This is the best one found so far */
982                     best = goodness;
983                     best_p = p;
984                     best_pref = nprefix;
985                     best_length = length;
986                     ins = tmp_ins;
987                 }
988             }
989         }
990     }
991
992     if (!best_p)
993         return 0;               /* no instruction was matched */
994
995     /* Pick the best match */
996     p = best_p;
997     length = best_length;
998
999     slen = 0;
1000
1001     /* TODO: snprintf returns the value that the string would have if
1002      *      the buffer were long enough, and not the actual length of
1003      *      the returned string, so each instance of using the return
1004      *      value of snprintf should actually be checked to assure that
1005      *      the return value is "sane."  Maybe a macro wrapper could
1006      *      be used for that purpose.
1007      */
1008     for (i = 0; i < MAXPREFIX; i++)
1009         switch (ins.prefixes[i]) {
1010         case P_LOCK:
1011             slen += snprintf(output + slen, outbufsize - slen, "lock ");
1012             break;
1013         case P_REP:
1014             slen += snprintf(output + slen, outbufsize - slen, "rep ");
1015             break;
1016         case P_REPE:
1017             slen += snprintf(output + slen, outbufsize - slen, "repe ");
1018             break;
1019         case P_REPNE:
1020             slen += snprintf(output + slen, outbufsize - slen, "repne ");
1021             break;
1022         case P_A16:
1023             slen += snprintf(output + slen, outbufsize - slen, "a16 ");
1024             break;
1025         case P_A32:
1026             slen += snprintf(output + slen, outbufsize - slen, "a32 ");
1027             break;
1028         case P_A64:
1029             slen += snprintf(output + slen, outbufsize - slen, "a64 ");
1030             break;
1031         case P_O16:
1032             slen += snprintf(output + slen, outbufsize - slen, "o16 ");
1033             break;
1034         case P_O32:
1035             slen += snprintf(output + slen, outbufsize - slen, "o32 ");
1036             break;
1037         case P_O64:
1038             slen += snprintf(output + slen, outbufsize - slen, "o64 ");
1039             break;
1040         default:
1041             break;
1042         }
1043
1044     for (i = 0; i < (int)elements(ico); i++)
1045         if ((*p)->opcode == ico[i]) {
1046             slen +=
1047                 snprintf(output + slen, outbufsize - slen, "%s%s", icn[i],
1048                          whichcond(ins.condition));
1049             break;
1050         }
1051     if (i >= (int)elements(ico))
1052         slen +=
1053             snprintf(output + slen, outbufsize - slen, "%s",
1054                      insn_names[(*p)->opcode]);
1055     colon = false;
1056     length += data - origdata;  /* fix up for prefixes */
1057     for (i = 0; i < (*p)->operands; i++) {
1058         opflags_t t = (*p)->opd[i];
1059         const operand *o = &ins.oprs[i];
1060         int64_t offs;
1061
1062         if (t & SAME_AS) {
1063             o = &ins.oprs[t & ~SAME_AS];
1064             t = (*p)->opd[t & ~SAME_AS];
1065         }
1066
1067         output[slen++] = (colon ? ':' : i == 0 ? ' ' : ',');
1068
1069         offs = o->offset;
1070         if (o->segment & SEG_RELATIVE) {
1071             offs += offset + length;
1072             /*
1073              * sort out wraparound
1074              */
1075             if (!(o->segment & (SEG_32BIT|SEG_64BIT)))
1076                 offs &= 0xffff;
1077             /*
1078              * add sync marker, if autosync is on
1079              */
1080             if (autosync)
1081                 add_sync(offs, 0L);
1082         }
1083
1084         if (t & COLON)
1085             colon = true;
1086         else
1087             colon = false;
1088
1089         if ((t & (REGISTER | FPUREG)) ||
1090             (o->segment & SEG_RMREG)) {
1091             enum reg_enum reg;
1092             reg = whichreg(t, o->basereg, ins.rex);
1093             if (t & TO)
1094                 slen += snprintf(output + slen, outbufsize - slen, "to ");
1095             slen += snprintf(output + slen, outbufsize - slen, "%s",
1096                              reg_names[reg - EXPR_REG_START]);
1097         } else if (!(UNITY & ~t)) {
1098             output[slen++] = '1';
1099         } else if (t & IMMEDIATE) {
1100             if (t & BITS8) {
1101                 slen +=
1102                     snprintf(output + slen, outbufsize - slen, "byte ");
1103                 if (o->segment & SEG_SIGNED) {
1104                     if (offs < 0) {
1105                         offs *= -1;
1106                         output[slen++] = '-';
1107                     } else
1108                         output[slen++] = '+';
1109                 }
1110             } else if (t & BITS16) {
1111                 slen +=
1112                     snprintf(output + slen, outbufsize - slen, "word ");
1113             } else if (t & BITS32) {
1114                 slen +=
1115                     snprintf(output + slen, outbufsize - slen, "dword ");
1116             } else if (t & BITS64) {
1117                 slen +=
1118                     snprintf(output + slen, outbufsize - slen, "qword ");
1119             } else if (t & NEAR) {
1120                 slen +=
1121                     snprintf(output + slen, outbufsize - slen, "near ");
1122             } else if (t & SHORT) {
1123                 slen +=
1124                     snprintf(output + slen, outbufsize - slen, "short ");
1125             }
1126             slen +=
1127                 snprintf(output + slen, outbufsize - slen, "0x%"PRIx64"",
1128                          offs);
1129         } else if (!(MEM_OFFS & ~t)) {
1130             slen +=
1131                 snprintf(output + slen, outbufsize - slen,
1132                          "[%s%s%s0x%"PRIx64"]",
1133                          (segover ? segover : ""),
1134                          (segover ? ":" : ""),
1135                          (o->disp_size == 64 ? "qword " :
1136                           o->disp_size == 32 ? "dword " :
1137                           o->disp_size == 16 ? "word " : ""), offs);
1138             segover = NULL;
1139         } else if (!(REGMEM & ~t)) {
1140             int started = false;
1141             if (t & BITS8)
1142                 slen +=
1143                     snprintf(output + slen, outbufsize - slen, "byte ");
1144             if (t & BITS16)
1145                 slen +=
1146                     snprintf(output + slen, outbufsize - slen, "word ");
1147             if (t & BITS32)
1148                 slen +=
1149                     snprintf(output + slen, outbufsize - slen, "dword ");
1150             if (t & BITS64)
1151                 slen +=
1152                     snprintf(output + slen, outbufsize - slen, "qword ");
1153             if (t & BITS80)
1154                 slen +=
1155                     snprintf(output + slen, outbufsize - slen, "tword ");
1156             if (t & BITS128)
1157                 slen +=
1158                     snprintf(output + slen, outbufsize - slen, "oword ");
1159             if (t & FAR)
1160                 slen += snprintf(output + slen, outbufsize - slen, "far ");
1161             if (t & NEAR)
1162                 slen +=
1163                     snprintf(output + slen, outbufsize - slen, "near ");
1164             output[slen++] = '[';
1165             if (o->disp_size)
1166                 slen += snprintf(output + slen, outbufsize - slen, "%s",
1167                                  (o->disp_size == 64 ? "qword " :
1168                                   o->disp_size == 32 ? "dword " :
1169                                   o->disp_size == 16 ? "word " :
1170                                   ""));
1171             if (o->eaflags & EAF_REL)
1172                 slen += snprintf(output + slen, outbufsize - slen, "rel ");
1173             if (segover) {
1174                 slen +=
1175                     snprintf(output + slen, outbufsize - slen, "%s:",
1176                              segover);
1177                 segover = NULL;
1178             }
1179             if (o->basereg != -1) {
1180                 slen += snprintf(output + slen, outbufsize - slen, "%s",
1181                                  reg_names[(o->basereg -
1182                                             EXPR_REG_START)]);
1183                 started = true;
1184             }
1185             if (o->indexreg != -1) {
1186                 if (started)
1187                     output[slen++] = '+';
1188                 slen += snprintf(output + slen, outbufsize - slen, "%s",
1189                                  reg_names[(o->indexreg -
1190                                             EXPR_REG_START)]);
1191                 if (o->scale > 1)
1192                     slen +=
1193                         snprintf(output + slen, outbufsize - slen, "*%d",
1194                                  o->scale);
1195                 started = true;
1196             }
1197
1198
1199             if (o->segment & SEG_DISP8) {
1200                 const char *prefix;
1201                 uint8_t offset = offs;
1202                 if ((int8_t)offset < 0) {
1203                     prefix = "-";
1204                     offset = -offset;
1205                 } else {
1206                     prefix = "+";
1207                 }
1208                 slen +=
1209                     snprintf(output + slen, outbufsize - slen, "%s0x%"PRIx8"",
1210                              prefix, offset);
1211             } else if (o->segment & SEG_DISP16) {
1212                 const char *prefix;
1213                 uint16_t offset = offs;
1214                 if ((int16_t)offset < 0 && started) {
1215                     offset = -offset;
1216                     prefix = "-";
1217                 } else {
1218                     prefix = started ? "+" : "";
1219                 }
1220                 slen +=
1221                     snprintf(output + slen, outbufsize - slen,
1222                              "%s0x%"PRIx16"", prefix, offset);
1223             } else if (o->segment & SEG_DISP32) {
1224                 if (prefix.asize == 64) {
1225                     const char *prefix;
1226                     uint64_t offset = (int64_t)(int32_t)offs;
1227                     if ((int32_t)offs < 0 && started) {
1228                         offset = -offset;
1229                         prefix = "-";
1230                     } else {
1231                         prefix = started ? "+" : "";
1232                     }
1233                     slen +=
1234                         snprintf(output + slen, outbufsize - slen,
1235                                  "%s0x%"PRIx64"", prefix, offset);
1236                 } else {
1237                     const char *prefix;
1238                     uint32_t offset = offs;
1239                     if ((int32_t) offset < 0 && started) {
1240                         offset = -offset;
1241                         prefix = "-";
1242                     } else {
1243                         prefix = started ? "+" : "";
1244                     }
1245                     slen +=
1246                         snprintf(output + slen, outbufsize - slen,
1247                                  "%s0x%"PRIx32"", prefix, offset);
1248                 }
1249             }
1250             output[slen++] = ']';
1251         } else {
1252             slen +=
1253                 snprintf(output + slen, outbufsize - slen, "<operand%d>",
1254                          i);
1255         }
1256     }
1257     output[slen] = '\0';
1258     if (segover) {              /* unused segment override */
1259         char *p = output;
1260         int count = slen + 1;
1261         while (count--)
1262             p[count + 3] = p[count];
1263         strncpy(output, segover, 2);
1264         output[2] = ' ';
1265     }
1266     return length;
1267 }
1268
1269 int32_t eatbyte(uint8_t *data, char *output, int outbufsize)
1270 {
1271     snprintf(output, outbufsize, "db 0x%02X", *data);
1272     return 1;
1273 }