HLE: Implement the basic mechanism for XACQUIRE/XRELEASE
[platform/upstream/nasm.git] / disasm.c
1 /* ----------------------------------------------------------------------- *
2  *   
3  *   Copyright 1996-2010 The NASM Authors - All Rights Reserved
4  *   See the file AUTHORS included with the NASM distribution for
5  *   the specific copyright holders.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following
9  *   conditions are met:
10  *
11  *   * Redistributions of source code must retain the above copyright
12  *     notice, this list of conditions and the following disclaimer.
13  *   * Redistributions in binary form must reproduce the above
14  *     copyright notice, this list of conditions and the following
15  *     disclaimer in the documentation and/or other materials provided
16  *     with the distribution.
17  *     
18  *     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19  *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20  *     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21  *     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  *     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
23  *     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25  *     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  *     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  *     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  *     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  *     EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * ----------------------------------------------------------------------- */
33
34 /* 
35  * disasm.c   where all the _work_ gets done in the Netwide Disassembler
36  */
37
38 #include "compiler.h"
39
40 #include <stdio.h>
41 #include <string.h>
42 #include <limits.h>
43 #include <inttypes.h>
44
45 #include "nasm.h"
46 #include "disasm.h"
47 #include "sync.h"
48 #include "insns.h"
49 #include "tables.h"
50 #include "regdis.h"
51
52 /*
53  * Flags that go into the `segment' field of `insn' structures
54  * during disassembly.
55  */
56 #define SEG_RELATIVE      1
57 #define SEG_32BIT         2
58 #define SEG_RMREG         4
59 #define SEG_DISP8         8
60 #define SEG_DISP16       16
61 #define SEG_DISP32       32
62 #define SEG_NODISP       64
63 #define SEG_SIGNED      128
64 #define SEG_64BIT       256
65
66 /*
67  * Prefix information
68  */
69 struct prefix_info {
70     uint8_t osize;              /* Operand size */
71     uint8_t asize;              /* Address size */
72     uint8_t osp;                /* Operand size prefix present */
73     uint8_t asp;                /* Address size prefix present */
74     uint8_t rep;                /* Rep prefix present */
75     uint8_t seg;                /* Segment override prefix present */
76     uint8_t wait;               /* WAIT "prefix" present */
77     uint8_t lock;               /* Lock prefix present */
78     uint8_t vex[3];             /* VEX prefix present */
79     uint8_t vex_c;              /* VEX "class" (VEX, XOP, ...) */
80     uint8_t vex_m;              /* VEX.M field */
81     uint8_t vex_v;
82     uint8_t vex_lp;             /* VEX.LP fields */
83     uint32_t rex;               /* REX prefix present */
84 };
85
86 #define getu8(x) (*(uint8_t *)(x))
87 #if X86_MEMORY
88 /* Littleendian CPU which can handle unaligned references */
89 #define getu16(x) (*(uint16_t *)(x))
90 #define getu32(x) (*(uint32_t *)(x))
91 #define getu64(x) (*(uint64_t *)(x))
92 #else
93 static uint16_t getu16(uint8_t *data)
94 {
95     return (uint16_t)data[0] + ((uint16_t)data[1] << 8);
96 }
97 static uint32_t getu32(uint8_t *data)
98 {
99     return (uint32_t)getu16(data) + ((uint32_t)getu16(data+2) << 16);
100 }
101 static uint64_t getu64(uint8_t *data)
102 {
103     return (uint64_t)getu32(data) + ((uint64_t)getu32(data+4) << 32);
104 }
105 #endif
106
107 #define gets8(x) ((int8_t)getu8(x))
108 #define gets16(x) ((int16_t)getu16(x))
109 #define gets32(x) ((int32_t)getu32(x))
110 #define gets64(x) ((int64_t)getu64(x))
111
112 /* Important: regval must already have been adjusted for rex extensions */
113 static enum reg_enum whichreg(opflags_t regflags, int regval, int rex)
114 {
115     if (!(regflags & (REGISTER|REGMEM)))
116         return 0;               /* Registers not permissible?! */
117
118     regflags |= REGISTER;
119
120     if (!(REG_AL & ~regflags))
121         return R_AL;
122     if (!(REG_AX & ~regflags))
123         return R_AX;
124     if (!(REG_EAX & ~regflags))
125         return R_EAX;
126     if (!(REG_RAX & ~regflags))
127         return R_RAX;
128     if (!(REG_DL & ~regflags))
129         return R_DL;
130     if (!(REG_DX & ~regflags))
131         return R_DX;
132     if (!(REG_EDX & ~regflags))
133         return R_EDX;
134     if (!(REG_RDX & ~regflags))
135         return R_RDX;
136     if (!(REG_CL & ~regflags))
137         return R_CL;
138     if (!(REG_CX & ~regflags))
139         return R_CX;
140     if (!(REG_ECX & ~regflags))
141         return R_ECX;
142     if (!(REG_RCX & ~regflags))
143         return R_RCX;
144     if (!(FPU0 & ~regflags))
145         return R_ST0;
146     if (!(XMM0 & ~regflags))
147         return R_XMM0;
148     if (!(YMM0 & ~regflags))
149         return R_YMM0;
150     if (!(REG_CS & ~regflags))
151         return (regval == 1) ? R_CS : 0;
152     if (!(REG_DESS & ~regflags))
153         return (regval == 0 || regval == 2
154                 || regval == 3 ? nasm_rd_sreg[regval] : 0);
155     if (!(REG_FSGS & ~regflags))
156         return (regval == 4 || regval == 5 ? nasm_rd_sreg[regval] : 0);
157     if (!(REG_SEG67 & ~regflags))
158         return (regval == 6 || regval == 7 ? nasm_rd_sreg[regval] : 0);
159
160     /* All the entries below look up regval in an 16-entry array */
161     if (regval < 0 || regval > 15)
162         return 0;
163
164     if (!(REG8 & ~regflags)) {
165         if (rex & (REX_P|REX_NH))
166             return nasm_rd_reg8_rex[regval];
167         else
168             return nasm_rd_reg8[regval];
169     }
170     if (!(REG16 & ~regflags))
171         return nasm_rd_reg16[regval];
172     if (!(REG32 & ~regflags))
173         return nasm_rd_reg32[regval];
174     if (!(REG64 & ~regflags))
175         return nasm_rd_reg64[regval];
176     if (!(REG_SREG & ~regflags))
177         return nasm_rd_sreg[regval & 7]; /* Ignore REX */
178     if (!(REG_CREG & ~regflags))
179         return nasm_rd_creg[regval];
180     if (!(REG_DREG & ~regflags))
181         return nasm_rd_dreg[regval];
182     if (!(REG_TREG & ~regflags)) {
183         if (regval > 7)
184             return 0;           /* TR registers are ill-defined with rex */
185         return nasm_rd_treg[regval];
186     }
187     if (!(FPUREG & ~regflags))
188         return nasm_rd_fpureg[regval & 7]; /* Ignore REX */
189     if (!(MMXREG & ~regflags))
190         return nasm_rd_mmxreg[regval & 7]; /* Ignore REX */
191     if (!(XMMREG & ~regflags))
192         return nasm_rd_xmmreg[regval];
193     if (!(YMMREG & ~regflags))
194         return nasm_rd_ymmreg[regval];
195
196     return 0;
197 }
198
199 /*
200  * Process an effective address (ModRM) specification.
201  */
202 static uint8_t *do_ea(uint8_t *data, int modrm, int asize,
203                       int segsize, enum ea_type type,
204                       operand *op, insn *ins)
205 {
206     int mod, rm, scale, index, base;
207     int rex;
208     uint8_t sib = 0;
209
210     mod = (modrm >> 6) & 03;
211     rm = modrm & 07;
212
213     if (mod != 3 && asize != 16 && rm == 4)
214         sib = *data++;
215
216     rex = ins->rex;
217
218     if (mod == 3) {             /* pure register version */
219         op->basereg = rm+(rex & REX_B ? 8 : 0);
220         op->segment |= SEG_RMREG;
221         return data;
222     }
223
224     op->disp_size = 0;
225     op->eaflags = 0;
226
227     if (asize == 16) {
228         /*
229          * <mod> specifies the displacement size (none, byte or
230          * word), and <rm> specifies the register combination.
231          * Exception: mod=0,rm=6 does not specify [BP] as one might
232          * expect, but instead specifies [disp16].
233          */
234
235         if (type != EA_SCALAR)
236             return NULL;
237
238         op->indexreg = op->basereg = -1;
239         op->scale = 1;          /* always, in 16 bits */
240         switch (rm) {
241         case 0:
242             op->basereg = R_BX;
243             op->indexreg = R_SI;
244             break;
245         case 1:
246             op->basereg = R_BX;
247             op->indexreg = R_DI;
248             break;
249         case 2:
250             op->basereg = R_BP;
251             op->indexreg = R_SI;
252             break;
253         case 3:
254             op->basereg = R_BP;
255             op->indexreg = R_DI;
256             break;
257         case 4:
258             op->basereg = R_SI;
259             break;
260         case 5:
261             op->basereg = R_DI;
262             break;
263         case 6:
264             op->basereg = R_BP;
265             break;
266         case 7:
267             op->basereg = R_BX;
268             break;
269         }
270         if (rm == 6 && mod == 0) {      /* special case */
271             op->basereg = -1;
272             if (segsize != 16)
273                 op->disp_size = 16;
274             mod = 2;            /* fake disp16 */
275         }
276         switch (mod) {
277         case 0:
278             op->segment |= SEG_NODISP;
279             break;
280         case 1:
281             op->segment |= SEG_DISP8;
282             op->offset = (int8_t)*data++;
283             break;
284         case 2:
285             op->segment |= SEG_DISP16;
286             op->offset = *data++;
287             op->offset |= ((unsigned)*data++) << 8;
288             break;
289         }
290         return data;
291     } else {
292         /*
293          * Once again, <mod> specifies displacement size (this time
294          * none, byte or *dword*), while <rm> specifies the base
295          * register. Again, [EBP] is missing, replaced by a pure
296          * disp32 (this time that's mod=0,rm=*5*) in 32-bit mode,
297          * and RIP-relative addressing in 64-bit mode.
298          *
299          * However, rm=4
300          * indicates not a single base register, but instead the
301          * presence of a SIB byte...
302          */
303         int a64 = asize == 64;
304
305         op->indexreg = -1;
306
307         if (a64)
308             op->basereg = nasm_rd_reg64[rm | ((rex & REX_B) ? 8 : 0)];
309         else
310             op->basereg = nasm_rd_reg32[rm | ((rex & REX_B) ? 8 : 0)];
311
312         if (rm == 5 && mod == 0) {
313             if (segsize == 64) {
314                 op->eaflags |= EAF_REL;
315                 op->segment |= SEG_RELATIVE;
316                 mod = 2;        /* fake disp32 */
317             }
318
319             if (asize != 64)
320                 op->disp_size = asize;
321
322             op->basereg = -1;
323             mod = 2;            /* fake disp32 */
324         }
325
326
327         if (rm == 4) {          /* process SIB */
328             scale = (sib >> 6) & 03;
329             index = (sib >> 3) & 07;
330             base = sib & 07;
331
332             op->scale = 1 << scale;
333
334             if (type == EA_XMMVSIB)
335                 op->indexreg = nasm_rd_xmmreg[index | ((rex & REX_X) ? 8 : 0)];
336             else if (type == EA_YMMVSIB)
337                 op->indexreg = nasm_rd_ymmreg[index | ((rex & REX_X) ? 8 : 0)];
338             else if (index == 4 && !(rex & REX_X))
339                 op->indexreg = -1; /* ESP/RSP cannot be an index */
340             else if (a64)
341                 op->indexreg = nasm_rd_reg64[index | ((rex & REX_X) ? 8 : 0)];
342             else
343                 op->indexreg = nasm_rd_reg32[index | ((rex & REX_X) ? 8 : 0)];
344
345             if (base == 5 && mod == 0) {
346                 op->basereg = -1;
347                 mod = 2;        /* Fake disp32 */
348             } else if (a64)
349                 op->basereg = nasm_rd_reg64[base | ((rex & REX_B) ? 8 : 0)];
350             else
351                 op->basereg = nasm_rd_reg32[base | ((rex & REX_B) ? 8 : 0)];
352
353             if (segsize == 16)
354                 op->disp_size = 32;
355         } else if (type != EA_SCALAR) {
356             /* Can't have VSIB without SIB */
357             return NULL;
358         }
359
360         switch (mod) {
361         case 0:
362             op->segment |= SEG_NODISP;
363             break;
364         case 1:
365             op->segment |= SEG_DISP8;
366             op->offset = gets8(data);
367             data++;
368             break;
369         case 2:
370             op->segment |= SEG_DISP32;
371             op->offset = gets32(data);
372             data += 4;
373             break;
374         }
375         return data;
376     }
377 }
378
379 /*
380  * Determine whether the instruction template in t corresponds to the data
381  * stream in data. Return the number of bytes matched if so.
382  */
383 #define case4(x) case (x): case (x)+1: case (x)+2: case (x)+3
384
385 static int matches(const struct itemplate *t, uint8_t *data,
386                    const struct prefix_info *prefix, int segsize, insn *ins)
387 {
388     uint8_t *r = (uint8_t *)(t->code);
389     uint8_t *origdata = data;
390     bool a_used = false, o_used = false;
391     enum prefixes drep = 0;
392     enum prefixes dwait = 0;
393     uint8_t lock = prefix->lock;
394     int osize = prefix->osize;
395     int asize = prefix->asize;
396     int i, c;
397     int op1, op2;
398     struct operand *opx, *opy;
399     uint8_t opex = 0;
400     int s_field_for = -1;       /* No 144/154 series code encountered */
401     bool vex_ok = false;
402     int regmask = (segsize == 64) ? 15 : 7;
403     enum ea_type eat = EA_SCALAR;
404
405     for (i = 0; i < MAX_OPERANDS; i++) {
406         ins->oprs[i].segment = ins->oprs[i].disp_size =
407             (segsize == 64 ? SEG_64BIT : segsize == 32 ? SEG_32BIT : 0);
408     }
409     ins->condition = -1;
410     ins->rex = prefix->rex;
411     memset(ins->prefixes, 0, sizeof ins->prefixes);
412
413     if (t->flags & (segsize == 64 ? IF_NOLONG : IF_LONG))
414         return false;
415
416     if (prefix->rep == 0xF2)
417         drep = P_REPNE;
418     else if (prefix->rep == 0xF3)
419         drep = P_REP;
420
421     dwait = prefix->wait ? P_WAIT : 0;
422
423     while ((c = *r++) != 0) {
424         op1 = (c & 3) + ((opex & 1) << 2);
425         op2 = ((c >> 3) & 3) + ((opex & 2) << 1);
426         opx = &ins->oprs[op1];
427         opy = &ins->oprs[op2];
428         opex = 0;
429
430         switch (c) {
431         case 01:
432         case 02:
433         case 03:
434         case 04:
435             while (c--)
436                 if (*r++ != *data++)
437                     return false;
438             break;
439
440         case 05:
441         case 06:
442         case 07:
443             opex = c;
444             break;
445
446         case4(010):
447         {
448             int t = *r++, d = *data++;
449             if (d < t || d > t + 7)
450                 return false;
451             else {
452                 opx->basereg = (d-t)+
453                     (ins->rex & REX_B ? 8 : 0);
454                 opx->segment |= SEG_RMREG;
455             }
456             break;
457         }
458
459         case4(014):
460         case4(0274):
461             opx->offset = (int8_t)*data++;
462             opx->segment |= SEG_SIGNED;
463             break;
464
465         case4(020):
466             opx->offset = *data++;
467             break;
468
469         case4(024):
470             opx->offset = *data++;
471             break;
472
473         case4(030):
474             opx->offset = getu16(data);
475             data += 2;
476             break;
477
478         case4(034):
479             if (osize == 32) {
480                 opx->offset = getu32(data);
481                 data += 4;
482             } else {
483                 opx->offset = getu16(data);
484                 data += 2;
485             }
486             if (segsize != asize)
487                 opx->disp_size = asize;
488             break;
489
490         case4(040):
491         case4(0254):
492             opx->offset = getu32(data);
493             data += 4;
494             break;
495
496         case4(044):
497             switch (asize) {
498             case 16:
499                 opx->offset = getu16(data);
500                 data += 2;
501                 if (segsize != 16)
502                     opx->disp_size = 16;
503                 break;
504             case 32:
505                 opx->offset = getu32(data);
506                 data += 4;
507                 if (segsize == 16)
508                     opx->disp_size = 32;
509                 break;
510             case 64:
511                 opx->offset = getu64(data);
512                 opx->disp_size = 64;
513                 data += 8;
514                 break;
515             }
516             break;
517
518         case4(050):
519             opx->offset = gets8(data++);
520             opx->segment |= SEG_RELATIVE;
521             break;
522
523         case4(054):
524             opx->offset = getu64(data);
525             data += 8;
526             break;
527
528         case4(060):
529             opx->offset = gets16(data);
530             data += 2;
531             opx->segment |= SEG_RELATIVE;
532             opx->segment &= ~SEG_32BIT;
533             break;
534
535         case4(064):
536             opx->segment |= SEG_RELATIVE;
537             if (osize == 16) {
538                 opx->offset = gets16(data);
539                 data += 2;
540                 opx->segment &= ~(SEG_32BIT|SEG_64BIT);
541             } else if (osize == 32) {
542                 opx->offset = gets32(data);
543                 data += 4;
544                 opx->segment &= ~SEG_64BIT;
545                 opx->segment |= SEG_32BIT;
546             }
547             if (segsize != osize) {
548                 opx->type =
549                     (opx->type & ~SIZE_MASK)
550                     | ((osize == 16) ? BITS16 : BITS32);
551             }
552             break;
553
554         case4(070):
555             opx->offset = gets32(data);
556             data += 4;
557             opx->segment |= SEG_32BIT | SEG_RELATIVE;
558             break;
559
560         case4(0100):
561         case4(0110):
562         case4(0120):
563         case4(0130):
564         {
565             int modrm = *data++;
566             opx->segment |= SEG_RMREG;
567             data = do_ea(data, modrm, asize, segsize, eat, opy, ins);
568             if (!data)
569                 return false;
570             opx->basereg = ((modrm >> 3) & 7) + (ins->rex & REX_R ? 8 : 0);
571             break;
572         }
573
574         case4(0140):
575             if (s_field_for == op1) {
576                 opx->offset = gets8(data);
577                 data++;
578             } else {
579                 opx->offset = getu16(data);
580                 data += 2;
581             }
582             break;
583
584         case4(0144):
585         case4(0154):
586             s_field_for = (*data & 0x02) ? op1 : -1;
587             if ((*data++ & ~0x02) != *r++)
588                 return false;
589             break;
590
591         case4(0150):
592             if (s_field_for == op1) {
593                 opx->offset = gets8(data);
594                 data++;
595             } else {
596                 opx->offset = getu32(data);
597                 data += 4;
598             }
599             break;
600
601         case 0172:
602         {
603             uint8_t ximm = *data++;
604             c = *r++;
605             ins->oprs[c >> 3].basereg = (ximm >> 4) & regmask;
606             ins->oprs[c >> 3].segment |= SEG_RMREG;
607             ins->oprs[c & 7].offset = ximm & 15;
608         }
609         break;
610
611         case 0173:
612         {
613             uint8_t ximm = *data++;
614             c = *r++;
615
616             if ((c ^ ximm) & 15)
617                 return false;
618
619             ins->oprs[c >> 4].basereg = (ximm >> 4) & regmask;
620             ins->oprs[c >> 4].segment |= SEG_RMREG;
621         }
622         break;
623
624         case4(0174):
625         {
626             uint8_t ximm = *data++;
627
628             opx->basereg = (ximm >> 4) & regmask;
629             opx->segment |= SEG_RMREG;
630         }
631         break;
632
633         case4(0200):
634         case4(0204):
635         case4(0210):
636         case4(0214):
637         case4(0220):
638         case4(0224):
639         case4(0230):
640         case4(0234):
641         {
642             int modrm = *data++;
643             if (((modrm >> 3) & 07) != (c & 07))
644                 return false;   /* spare field doesn't match up */
645             data = do_ea(data, modrm, asize, segsize, eat, opy, ins);
646             if (!data)
647                 return false;
648             break;
649         }
650
651         case4(0250):
652             if (s_field_for == op1) {
653                 opx->offset = gets8(data);
654                 data++;
655             } else {
656                 opx->offset = gets32(data);
657                 data += 4;
658             }
659             break;
660
661         case4(0260):
662         case 0270:
663         {
664             int vexm   = *r++;
665             int vexwlp = *r++;
666
667             ins->rex |= REX_V;
668             if ((prefix->rex & (REX_V|REX_P)) != REX_V)
669                 return false;
670
671             if ((vexm & 0x1f) != prefix->vex_m)
672                 return false;
673
674             switch (vexwlp & 060) {
675             case 000:
676                 if (prefix->rex & REX_W)
677                     return false;
678                 break;
679             case 020:
680                 if (!(prefix->rex & REX_W))
681                     return false;
682                 ins->rex &= ~REX_W;
683                 break;
684             case 040:           /* VEX.W is a don't care */
685                 ins->rex &= ~REX_W;
686                 break;
687             case 060:
688                 break;
689             }
690
691             /* The 010 bit of vexwlp is set if VEX.L is ignored */
692             if ((vexwlp ^ prefix->vex_lp) & ((vexwlp & 010) ? 03 : 07))
693                 return false;
694
695             if (c == 0270) {
696                 if (prefix->vex_v != 0)
697                     return false;
698             } else {
699                 opx->segment |= SEG_RMREG;
700                 opx->basereg = prefix->vex_v;
701             }
702             vex_ok = true;
703             break;
704         }
705
706         case 0271:
707             if (prefix->rep == 0xF3)
708                 drep = P_XRELEASE;
709             break;
710
711         case 0272:
712             if (prefix->rep == 0xF2)
713                 drep = P_XACQUIRE;
714             else if (prefix->rep == 0xF3)
715                 drep = P_XRELEASE;
716             break;
717
718         case 0273:
719             if (prefix->lock == 0xF0) {
720                 if (prefix->rep == 0xF2)
721                     drep = P_XACQUIRE;
722                 else if (prefix->rep == 0xF3)
723                     drep = P_XRELEASE;
724             }
725             break;
726
727         case 0310:
728             if (asize != 16)
729                 return false;
730             else
731                 a_used = true;
732             break;
733
734         case 0311:
735             if (asize != 32)
736                 return false;
737             else
738                 a_used = true;
739             break;
740
741         case 0312:
742             if (asize != segsize)
743                 return false;
744             else
745                 a_used = true;
746             break;
747
748         case 0313:
749             if (asize != 64)
750                 return false;
751             else
752                 a_used = true;
753             break;
754
755         case 0314:
756             if (prefix->rex & REX_B)
757                 return false;
758             break;
759
760         case 0315:
761             if (prefix->rex & REX_X)
762                 return false;
763             break;
764
765         case 0316:
766             if (prefix->rex & REX_R)
767                 return false;
768             break;
769
770         case 0317:
771             if (prefix->rex & REX_W)
772                 return false;
773             break;
774
775         case 0320:
776             if (osize != 16)
777                 return false;
778             else
779                 o_used = true;
780             break;
781
782         case 0321:
783             if (osize != 32)
784                 return false;
785             else
786                 o_used = true;
787             break;
788
789         case 0322:
790             if (osize != (segsize == 16) ? 16 : 32)
791                 return false;
792             else
793                 o_used = true;
794             break;
795
796         case 0323:
797             ins->rex |= REX_W;  /* 64-bit only instruction */
798             osize = 64;
799             o_used = true;
800             break;
801
802         case 0324:
803             if (osize != 64)
804                 return false;
805             o_used = true;
806             break;
807
808         case 0325:
809             ins->rex |= REX_NH;
810             break;
811
812         case 0330:
813         {
814             int t = *r++, d = *data++;
815             if (d < t || d > t + 15)
816                 return false;
817             else
818                 ins->condition = d - t;
819             break;
820         }
821
822         case 0331:
823             if (prefix->rep)
824                 return false;
825             break;
826
827         case 0332:
828             if (prefix->rep != 0xF2)
829                 return false;
830             drep = 0;
831             break;
832
833         case 0333:
834             if (prefix->rep != 0xF3)
835                 return false;
836             drep = 0;
837             break;
838
839         case 0334:
840             if (lock) {
841                 ins->rex |= REX_R;
842                 lock = 0;
843             }
844             break;
845
846         case 0335:
847             if (drep == P_REP)
848                 drep = P_REPE;
849             break;
850
851         case 0336:
852         case 0337:
853             break;
854
855         case 0340:
856             return false;
857
858         case 0341:
859             if (prefix->wait != 0x9B)
860                 return false;
861             dwait = 0;
862             break;
863
864         case4(0344):
865             ins->oprs[0].basereg = (*data++ >> 3) & 7;
866             break;
867
868         case 0360:
869             if (prefix->osp || prefix->rep)
870                 return false;
871             break;
872
873         case 0361:
874             if (!prefix->osp || prefix->rep)
875                 return false;
876             o_used = true;
877             break;
878
879         case 0362:
880             if (prefix->osp || prefix->rep != 0xf2)
881                 return false;
882             drep = 0;
883             break;
884
885         case 0363:
886             if (prefix->osp || prefix->rep != 0xf3)
887                 return false;
888             drep = 0;
889             break;
890
891         case 0364:
892             if (prefix->osp)
893                 return false;
894             break;
895
896         case 0365:
897             if (prefix->asp)
898                 return false;
899             break;
900
901         case 0366:
902             if (!prefix->osp)
903                 return false;
904             o_used = true;
905             break;
906
907         case 0367:
908             if (!prefix->asp)
909                 return false;
910             a_used = true;
911             break;
912
913         case 0374:
914             eat = EA_XMMVSIB;
915             break;
916
917         case 0375:
918             eat = EA_YMMVSIB;
919             break;
920
921         default:
922             return false;       /* Unknown code */
923         }
924     }
925
926     if (!vex_ok && (ins->rex & REX_V))
927         return false;
928
929     /* REX cannot be combined with VEX */
930     if ((ins->rex & REX_V) && (prefix->rex & REX_P))
931         return false;
932
933     /*
934      * Check for unused rep or a/o prefixes.
935      */
936     for (i = 0; i < t->operands; i++) {
937         if (ins->oprs[i].segment != SEG_RMREG)
938             a_used = true;
939     }
940
941     if (lock) {
942         if (ins->prefixes[PPS_LOCK])
943             return false;
944         ins->prefixes[PPS_LOCK] = P_LOCK;
945     }
946     if (drep) {
947         if (ins->prefixes[PPS_REP])
948             return false;
949         ins->prefixes[PPS_REP] = drep;
950     }
951     ins->prefixes[PPS_WAIT] = dwait;
952     if (!o_used) {
953         if (osize != ((segsize == 16) ? 16 : 32)) {
954             enum prefixes pfx = 0;
955
956             switch (osize) {
957             case 16:
958                 pfx = P_O16;
959                 break;
960             case 32:
961                 pfx = P_O32;
962                 break;
963             case 64:
964                 pfx = P_O64;
965                 break;
966             }
967
968             if (ins->prefixes[PPS_OSIZE])
969                 return false;
970             ins->prefixes[PPS_OSIZE] = pfx;
971         }
972     }
973     if (!a_used && asize != segsize) {
974         if (ins->prefixes[PPS_ASIZE])
975             return false;
976         ins->prefixes[PPS_ASIZE] = asize == 16 ? P_A16 : P_A32;
977     }
978
979     /* Fix: check for redundant REX prefixes */
980
981     return data - origdata;
982 }
983
984 /* Condition names for disassembly, sorted by x86 code */
985 static const char * const condition_name[16] = {
986     "o", "no", "c", "nc", "z", "nz", "na", "a",
987     "s", "ns", "pe", "po", "l", "nl", "ng", "g"
988 };
989
990 int32_t disasm(uint8_t *data, char *output, int outbufsize, int segsize,
991             int32_t offset, int autosync, uint32_t prefer)
992 {
993     const struct itemplate * const *p, * const *best_p;
994     const struct disasm_index *ix;
995     uint8_t *dp;
996     int length, best_length = 0;
997     char *segover;
998     int i, slen, colon, n;
999     uint8_t *origdata;
1000     int works;
1001     insn tmp_ins, ins;
1002     uint32_t goodness, best;
1003     int best_pref;
1004     struct prefix_info prefix;
1005     bool end_prefix;
1006
1007     memset(&ins, 0, sizeof ins);
1008
1009     /*
1010      * Scan for prefixes.
1011      */
1012     memset(&prefix, 0, sizeof prefix);
1013     prefix.asize = segsize;
1014     prefix.osize = (segsize == 64) ? 32 : segsize;
1015     segover = NULL;
1016     origdata = data;
1017
1018     ix = itable;
1019
1020     end_prefix = false;
1021     while (!end_prefix) {
1022         switch (*data) {
1023         case 0xF2:
1024         case 0xF3:
1025             prefix.rep = *data++;
1026             break;
1027
1028         case 0x9B:
1029             prefix.wait = *data++;
1030             break;
1031
1032         case 0xF0:
1033             prefix.lock = *data++;
1034             break;
1035
1036         case 0x2E:
1037             segover = "cs", prefix.seg = *data++;
1038             break;
1039         case 0x36:
1040             segover = "ss", prefix.seg = *data++;
1041             break;
1042         case 0x3E:
1043             segover = "ds", prefix.seg = *data++;
1044             break;
1045         case 0x26:
1046             segover = "es", prefix.seg = *data++;
1047             break;
1048         case 0x64:
1049             segover = "fs", prefix.seg = *data++;
1050             break;
1051         case 0x65:
1052             segover = "gs", prefix.seg = *data++;
1053             break;
1054
1055         case 0x66:
1056             prefix.osize = (segsize == 16) ? 32 : 16;
1057             prefix.osp = *data++;
1058             break;
1059         case 0x67:
1060             prefix.asize = (segsize == 32) ? 16 : 32;
1061             prefix.asp = *data++;
1062             break;
1063
1064         case 0xC4:
1065         case 0xC5:
1066             if (segsize == 64 || (data[1] & 0xc0) == 0xc0) {
1067                 prefix.vex[0] = *data++;
1068                 prefix.vex[1] = *data++;
1069
1070                 prefix.rex = REX_V;
1071                 prefix.vex_c = RV_VEX;
1072
1073                 if (prefix.vex[0] == 0xc4) {
1074                     prefix.vex[2] = *data++;
1075                     prefix.rex |= (~prefix.vex[1] >> 5) & 7; /* REX_RXB */
1076                     prefix.rex |= (prefix.vex[2] >> (7-3)) & REX_W;
1077                     prefix.vex_m = prefix.vex[1] & 0x1f;
1078                     prefix.vex_v = (~prefix.vex[2] >> 3) & 15;
1079                     prefix.vex_lp = prefix.vex[2] & 7;
1080                 } else {
1081                     prefix.rex |= (~prefix.vex[1] >> (7-2)) & REX_R;
1082                     prefix.vex_m = 1;
1083                     prefix.vex_v = (~prefix.vex[1] >> 3) & 15;
1084                     prefix.vex_lp = prefix.vex[1] & 7;
1085                 }
1086
1087                 ix = itable_vex[RV_VEX][prefix.vex_m][prefix.vex_lp & 3];
1088             }
1089             end_prefix = true;
1090             break;
1091
1092         case 0x8F:
1093             if ((data[1] & 030) != 0 &&
1094                 (segsize == 64 || (data[1] & 0xc0) == 0xc0)) {
1095                 prefix.vex[0] = *data++;
1096                 prefix.vex[1] = *data++;
1097                 prefix.vex[2] = *data++;
1098
1099                 prefix.rex = REX_V;
1100                 prefix.vex_c = RV_XOP;
1101
1102                 prefix.rex |= (~prefix.vex[1] >> 5) & 7; /* REX_RXB */
1103                 prefix.rex |= (prefix.vex[2] >> (7-3)) & REX_W;
1104                 prefix.vex_m = prefix.vex[1] & 0x1f;
1105                 prefix.vex_v = (~prefix.vex[2] >> 3) & 15;
1106                 prefix.vex_lp = prefix.vex[2] & 7;
1107
1108                 ix = itable_vex[RV_XOP][prefix.vex_m][prefix.vex_lp & 3];
1109             }
1110             end_prefix = true;
1111             break;
1112
1113         case REX_P + 0x0:
1114         case REX_P + 0x1:
1115         case REX_P + 0x2:
1116         case REX_P + 0x3:
1117         case REX_P + 0x4:
1118         case REX_P + 0x5:
1119         case REX_P + 0x6:
1120         case REX_P + 0x7:
1121         case REX_P + 0x8:
1122         case REX_P + 0x9:
1123         case REX_P + 0xA:
1124         case REX_P + 0xB:
1125         case REX_P + 0xC:
1126         case REX_P + 0xD:
1127         case REX_P + 0xE:
1128         case REX_P + 0xF:
1129             if (segsize == 64) {
1130                 prefix.rex = *data++;
1131                 if (prefix.rex & REX_W)
1132                     prefix.osize = 64;
1133             }
1134             end_prefix = true;
1135             break;
1136
1137         default:
1138             end_prefix = true;
1139             break;
1140         }
1141     }
1142
1143     best = -1;                  /* Worst possible */
1144     best_p = NULL;
1145     best_pref = INT_MAX;
1146
1147     if (!ix)
1148         return 0;               /* No instruction table at all... */
1149
1150     dp = data;
1151     ix += *dp++;
1152     while (ix->n == -1) {
1153         ix = (const struct disasm_index *)ix->p + *dp++;
1154     }
1155
1156     p = (const struct itemplate * const *)ix->p;
1157     for (n = ix->n; n; n--, p++) {
1158         if ((length = matches(*p, data, &prefix, segsize, &tmp_ins))) {
1159             works = true;
1160             /*
1161              * Final check to make sure the types of r/m match up.
1162              * XXX: Need to make sure this is actually correct.
1163              */
1164             for (i = 0; i < (*p)->operands; i++) {
1165                 if (!((*p)->opd[i] & SAME_AS) &&
1166                     (
1167                         /* If it's a mem-only EA but we have a
1168                            register, die. */
1169                         ((tmp_ins.oprs[i].segment & SEG_RMREG) &&
1170                          is_class(MEMORY, (*p)->opd[i])) ||
1171                         /* If it's a reg-only EA but we have a memory
1172                            ref, die. */
1173                         (!(tmp_ins.oprs[i].segment & SEG_RMREG) &&
1174                          !(REG_EA & ~(*p)->opd[i]) &&
1175                          !((*p)->opd[i] & REG_SMASK)) ||
1176                         /* Register type mismatch (eg FS vs REG_DESS):
1177                            die. */
1178                         ((((*p)->opd[i] & (REGISTER | FPUREG)) ||
1179                           (tmp_ins.oprs[i].segment & SEG_RMREG)) &&
1180                          !whichreg((*p)->opd[i],
1181                                    tmp_ins.oprs[i].basereg, tmp_ins.rex))
1182                         )) {
1183                     works = false;
1184                     break;
1185                 }
1186             }
1187
1188             /*
1189              * Note: we always prefer instructions which incorporate
1190              * prefixes in the instructions themselves.  This is to allow
1191              * e.g. PAUSE to be preferred to REP NOP, and deal with
1192              * MMX/SSE instructions where prefixes are used to select
1193              * between MMX and SSE register sets or outright opcode
1194              * selection.
1195              */
1196             if (works) {
1197                 int i, nprefix;
1198                 goodness = ((*p)->flags & IF_PFMASK) ^ prefer;
1199                 nprefix = 0;
1200                 for (i = 0; i < MAXPREFIX; i++)
1201                     if (tmp_ins.prefixes[i])
1202                         nprefix++;
1203                 if (nprefix < best_pref ||
1204                     (nprefix == best_pref && goodness < best)) {
1205                     /* This is the best one found so far */
1206                     best = goodness;
1207                     best_p = p;
1208                     best_pref = nprefix;
1209                     best_length = length;
1210                     ins = tmp_ins;
1211                 }
1212             }
1213         }
1214     }
1215
1216     if (!best_p)
1217         return 0;               /* no instruction was matched */
1218
1219     /* Pick the best match */
1220     p = best_p;
1221     length = best_length;
1222
1223     slen = 0;
1224
1225     /* TODO: snprintf returns the value that the string would have if
1226      *      the buffer were long enough, and not the actual length of
1227      *      the returned string, so each instance of using the return
1228      *      value of snprintf should actually be checked to assure that
1229      *      the return value is "sane."  Maybe a macro wrapper could
1230      *      be used for that purpose.
1231      */
1232     for (i = 0; i < MAXPREFIX; i++) {
1233         const char *prefix = prefix_name(ins.prefixes[i]);
1234         if (prefix)
1235             slen += snprintf(output+slen, outbufsize-slen, "%s ", prefix);
1236     }
1237
1238     i = (*p)->opcode;
1239     if (i >= FIRST_COND_OPCODE)
1240         slen += snprintf(output + slen, outbufsize - slen, "%s%s",
1241                          nasm_insn_names[i], condition_name[ins.condition]);
1242     else
1243         slen += snprintf(output + slen, outbufsize - slen, "%s",
1244                          nasm_insn_names[i]);
1245
1246     colon = false;
1247     length += data - origdata;  /* fix up for prefixes */
1248     for (i = 0; i < (*p)->operands; i++) {
1249         opflags_t t = (*p)->opd[i];
1250         const operand *o = &ins.oprs[i];
1251         int64_t offs;
1252
1253         if (t & SAME_AS) {
1254             o = &ins.oprs[t & ~SAME_AS];
1255             t = (*p)->opd[t & ~SAME_AS];
1256         }
1257
1258         output[slen++] = (colon ? ':' : i == 0 ? ' ' : ',');
1259
1260         offs = o->offset;
1261         if (o->segment & SEG_RELATIVE) {
1262             offs += offset + length;
1263             /*
1264              * sort out wraparound
1265              */
1266             if (!(o->segment & (SEG_32BIT|SEG_64BIT)))
1267                 offs &= 0xffff;
1268             else if (segsize != 64)
1269                 offs &= 0xffffffff;
1270
1271             /*
1272              * add sync marker, if autosync is on
1273              */
1274             if (autosync)
1275                 add_sync(offs, 0L);
1276         }
1277
1278         if (t & COLON)
1279             colon = true;
1280         else
1281             colon = false;
1282
1283         if ((t & (REGISTER | FPUREG)) ||
1284             (o->segment & SEG_RMREG)) {
1285             enum reg_enum reg;
1286             reg = whichreg(t, o->basereg, ins.rex);
1287             if (t & TO)
1288                 slen += snprintf(output + slen, outbufsize - slen, "to ");
1289             slen += snprintf(output + slen, outbufsize - slen, "%s",
1290                              nasm_reg_names[reg-EXPR_REG_START]);
1291         } else if (!(UNITY & ~t)) {
1292             output[slen++] = '1';
1293         } else if (t & IMMEDIATE) {
1294             if (t & BITS8) {
1295                 slen +=
1296                     snprintf(output + slen, outbufsize - slen, "byte ");
1297                 if (o->segment & SEG_SIGNED) {
1298                     if (offs < 0) {
1299                         offs *= -1;
1300                         output[slen++] = '-';
1301                     } else
1302                         output[slen++] = '+';
1303                 }
1304             } else if (t & BITS16) {
1305                 slen +=
1306                     snprintf(output + slen, outbufsize - slen, "word ");
1307             } else if (t & BITS32) {
1308                 slen +=
1309                     snprintf(output + slen, outbufsize - slen, "dword ");
1310             } else if (t & BITS64) {
1311                 slen +=
1312                     snprintf(output + slen, outbufsize - slen, "qword ");
1313             } else if (t & NEAR) {
1314                 slen +=
1315                     snprintf(output + slen, outbufsize - slen, "near ");
1316             } else if (t & SHORT) {
1317                 slen +=
1318                     snprintf(output + slen, outbufsize - slen, "short ");
1319             }
1320             slen +=
1321                 snprintf(output + slen, outbufsize - slen, "0x%"PRIx64"",
1322                          offs);
1323         } else if (!(MEM_OFFS & ~t)) {
1324             slen +=
1325                 snprintf(output + slen, outbufsize - slen,
1326                          "[%s%s%s0x%"PRIx64"]",
1327                          (segover ? segover : ""),
1328                          (segover ? ":" : ""),
1329                          (o->disp_size == 64 ? "qword " :
1330                           o->disp_size == 32 ? "dword " :
1331                           o->disp_size == 16 ? "word " : ""), offs);
1332             segover = NULL;
1333         } else if (is_class(REGMEM, t)) {
1334             int started = false;
1335             if (t & BITS8)
1336                 slen +=
1337                     snprintf(output + slen, outbufsize - slen, "byte ");
1338             if (t & BITS16)
1339                 slen +=
1340                     snprintf(output + slen, outbufsize - slen, "word ");
1341             if (t & BITS32)
1342                 slen +=
1343                     snprintf(output + slen, outbufsize - slen, "dword ");
1344             if (t & BITS64)
1345                 slen +=
1346                     snprintf(output + slen, outbufsize - slen, "qword ");
1347             if (t & BITS80)
1348                 slen +=
1349                     snprintf(output + slen, outbufsize - slen, "tword ");
1350             if (t & BITS128)
1351                 slen +=
1352                     snprintf(output + slen, outbufsize - slen, "oword ");
1353             if (t & BITS256)
1354                 slen +=
1355                     snprintf(output + slen, outbufsize - slen, "yword ");
1356             if (t & FAR)
1357                 slen += snprintf(output + slen, outbufsize - slen, "far ");
1358             if (t & NEAR)
1359                 slen +=
1360                     snprintf(output + slen, outbufsize - slen, "near ");
1361             output[slen++] = '[';
1362             if (o->disp_size)
1363                 slen += snprintf(output + slen, outbufsize - slen, "%s",
1364                                  (o->disp_size == 64 ? "qword " :
1365                                   o->disp_size == 32 ? "dword " :
1366                                   o->disp_size == 16 ? "word " :
1367                                   ""));
1368             if (o->eaflags & EAF_REL)
1369                 slen += snprintf(output + slen, outbufsize - slen, "rel ");
1370             if (segover) {
1371                 slen +=
1372                     snprintf(output + slen, outbufsize - slen, "%s:",
1373                              segover);
1374                 segover = NULL;
1375             }
1376             if (o->basereg != -1) {
1377                 slen += snprintf(output + slen, outbufsize - slen, "%s",
1378                                  nasm_reg_names[(o->basereg-EXPR_REG_START)]);
1379                 started = true;
1380             }
1381             if (o->indexreg != -1) {
1382                 if (started)
1383                     output[slen++] = '+';
1384                 slen += snprintf(output + slen, outbufsize - slen, "%s",
1385                                  nasm_reg_names[(o->indexreg-EXPR_REG_START)]);
1386                 if (o->scale > 1)
1387                     slen +=
1388                         snprintf(output + slen, outbufsize - slen, "*%d",
1389                                  o->scale);
1390                 started = true;
1391             }
1392
1393
1394             if (o->segment & SEG_DISP8) {
1395                 const char *prefix;
1396                 uint8_t offset = offs;
1397                 if ((int8_t)offset < 0) {
1398                     prefix = "-";
1399                     offset = -offset;
1400                 } else {
1401                     prefix = "+";
1402                 }
1403                 slen +=
1404                     snprintf(output + slen, outbufsize - slen, "%s0x%"PRIx8"",
1405                              prefix, offset);
1406             } else if (o->segment & SEG_DISP16) {
1407                 const char *prefix;
1408                 uint16_t offset = offs;
1409                 if ((int16_t)offset < 0 && started) {
1410                     offset = -offset;
1411                     prefix = "-";
1412                 } else {
1413                     prefix = started ? "+" : "";
1414                 }
1415                 slen +=
1416                     snprintf(output + slen, outbufsize - slen,
1417                              "%s0x%"PRIx16"", prefix, offset);
1418             } else if (o->segment & SEG_DISP32) {
1419                 if (prefix.asize == 64) {
1420                     const char *prefix;
1421                     uint64_t offset = (int64_t)(int32_t)offs;
1422                     if ((int32_t)offs < 0 && started) {
1423                         offset = -offset;
1424                         prefix = "-";
1425                     } else {
1426                         prefix = started ? "+" : "";
1427                     }
1428                     slen +=
1429                         snprintf(output + slen, outbufsize - slen,
1430                                  "%s0x%"PRIx64"", prefix, offset);
1431                 } else {
1432                     const char *prefix;
1433                     uint32_t offset = offs;
1434                     if ((int32_t) offset < 0 && started) {
1435                         offset = -offset;
1436                         prefix = "-";
1437                     } else {
1438                         prefix = started ? "+" : "";
1439                     }
1440                     slen +=
1441                         snprintf(output + slen, outbufsize - slen,
1442                                  "%s0x%"PRIx32"", prefix, offset);
1443                 }
1444             }
1445             output[slen++] = ']';
1446         } else {
1447             slen +=
1448                 snprintf(output + slen, outbufsize - slen, "<operand%d>",
1449                          i);
1450         }
1451     }
1452     output[slen] = '\0';
1453     if (segover) {              /* unused segment override */
1454         char *p = output;
1455         int count = slen + 1;
1456         while (count--)
1457             p[count + 3] = p[count];
1458         strncpy(output, segover, 2);
1459         output[2] = ' ';
1460     }
1461     return length;
1462 }
1463
1464 /*
1465  * This is called when we don't have a complete instruction.  If it
1466  * is a standalone *single-byte* prefix show it as such, otherwise
1467  * print it as a literal.
1468  */
1469 int32_t eatbyte(uint8_t *data, char *output, int outbufsize, int segsize)
1470 {
1471     uint8_t byte = *data;
1472     const char *str = NULL;
1473     
1474     switch (byte) {
1475     case 0xF2:
1476         str = "repne";
1477         break;
1478     case 0xF3:
1479         str = "rep";
1480         break;
1481     case 0x9B:
1482         str = "wait";
1483         break;
1484     case 0xF0:
1485         str = "lock";
1486         break;
1487     case 0x2E:
1488         str = "cs";
1489         break;
1490     case 0x36:
1491         str = "ss";
1492         break;
1493     case 0x3E:
1494         str = "ss";
1495         break;
1496     case 0x26:
1497         str = "es";
1498         break;
1499     case 0x64:
1500         str = "fs";
1501         break;
1502     case 0x65:
1503         str = "gs";
1504         break;
1505     case 0x66:
1506         str = (segsize == 16) ? "o32" : "o16";
1507         break;
1508     case 0x67:
1509         str = (segsize == 32) ? "a16" : "a32";
1510         break;
1511     case REX_P + 0x0:
1512     case REX_P + 0x1:
1513     case REX_P + 0x2:
1514     case REX_P + 0x3:
1515     case REX_P + 0x4:
1516     case REX_P + 0x5:
1517     case REX_P + 0x6:
1518     case REX_P + 0x7:
1519     case REX_P + 0x8:
1520     case REX_P + 0x9:
1521     case REX_P + 0xA:
1522     case REX_P + 0xB:
1523     case REX_P + 0xC:
1524     case REX_P + 0xD:
1525     case REX_P + 0xE:
1526     case REX_P + 0xF:
1527         if (segsize == 64) {
1528             snprintf(output, outbufsize, "rex%s%s%s%s%s",
1529                      (byte == REX_P) ? "" : ".",
1530                      (byte & REX_W) ? "w" : "",
1531                      (byte & REX_R) ? "r" : "",
1532                      (byte & REX_X) ? "x" : "",
1533                      (byte & REX_B) ? "b" : "");
1534             break;
1535         }
1536         /* else fall through */
1537     default:
1538         snprintf(output, outbufsize, "db 0x%02x", byte);
1539         break;
1540     }
1541
1542     if (str)
1543         snprintf(output, outbufsize, "%s", str);
1544
1545     return 1;
1546 }