1/*
2 * Copyright (c) 2007 The Hewlett-Packard Development Company
3 * All rights reserved.
4 *
5 * Redistribution and use of this software in source and binary forms,
6 * with or without modification, are permitted provided that the
7 * following conditions are met:
8 *
9 * The software must be used only for Non-Commercial Use which means any
10 * use which is NOT directed to receiving any direct monetary
11 * compensation for, or commercial advantage from such use. Illustrative
12 * examples of non-commercial use are academic research, personal study,
13 * teaching, education and corporate research & development.
14 * Illustrative examples of commercial use are distributing products for
15 * commercial advantage and providing services using the software for
16 * commercial advantage.
17 *
18 * If you wish to use this software or functionality therein that may be
19 * covered by patents for commercial use, please contact:
20 * Director of Intellectual Property Licensing
21 * Office of Strategy and Technology
22 * Hewlett-Packard Company
23 * 1501 Page Mill Road
24 * Palo Alto, California 94304
25 *
26 * Redistributions of source code must retain the above copyright notice,
27 * this list of conditions and the following disclaimer. Redistributions
28 * in binary form must reproduce the above copyright notice, this list of
29 * conditions and the following disclaimer in the documentation and/or
30 * other materials provided with the distribution. Neither the name of
31 * the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
32 * contributors may be used to endorse or promote products derived from
33 * this software without specific prior written permission. No right of
34 * sublicense is granted herewith. Derivatives of the software and
35 * output created using the software may be prepared, but only for
36 * Non-Commercial Uses. Derivatives of the software may be shared with
37 * others provided: (i) the others agree to abide by the list of
38 * conditions herein which includes the Non-Commercial Use restrictions;
39 * and (ii) such Derivatives of the software include the above copyright
40 * notice to acknowledge the contribution from this software where
41 * applicable, this list of conditions and the disclaimer below.
42 *
43 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
44 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
45 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
46 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
47 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
49 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
50 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
51 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
52 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
53 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54 *
55 * Authors: Gabe Black
56 */
57
58#ifndef __ARCH_X86_TYPES_HH__
59#define __ARCH_X86_TYPES_HH__
60
61#include <inttypes.h>
62#include <iostream>
63
64#include "base/bitfield.hh"
65#include "base/cprintf.hh"
66
67namespace X86ISA
68{
69 //This really determines how many bytes are passed to the predecoder.
70 typedef uint64_t MachInst;
71
72 enum Prefixes {
73 NoOverride = 0,
74 CSOverride = 1,
75 DSOverride = 2,
76 ESOverride = 3,
77 FSOverride = 4,
78 GSOverride = 5,
79 SSOverride = 6,
80 //The Rex prefix obviously doesn't fit in with the above, but putting
81 //it here lets us save double the space the enums take up.
82 RexPrefix = 7,
83 //There can be only one segment override, so they share the
84 //first 3 bits in the legacyPrefixes bitfield.
85 SegmentOverride = 0x7,
86 OperandSizeOverride = 8,
87 AddressSizeOverride = 16,
88 Lock = 32,
89 Rep = 64,
90 Repne = 128
91 };
92
93 BitUnion8(ModRM)
94 Bitfield<7,6> mod;
95 Bitfield<5,3> reg;
96 Bitfield<2,0> rm;
97 EndBitUnion(ModRM)
98
99 BitUnion8(Sib)
100 Bitfield<7,6> scale;
101 Bitfield<5,3> index;
102 Bitfield<2,0> base;
103 EndBitUnion(Sib)
104
105 BitUnion8(Rex)
106 Bitfield<3> w;
107 Bitfield<2> r;
108 Bitfield<1> x;
109 Bitfield<0> b;
110 EndBitUnion(Rex)
111
112 BitUnion8(Opcode)
113 Bitfield<7,3> top5;
114 Bitfield<2,0> bottom3;
115 EndBitUnion(Opcode)
116
117 //The intermediate structure the x86 predecoder returns.
118 struct ExtMachInst
119 {
120 //Prefixes
121 uint8_t legacy;
122 Rex rex;
123 //This holds all of the bytes of the opcode
124 struct
125 {
126 //The number of bytes in this opcode. Right now, we ignore that
127 //this can be 3 in some cases
128 uint8_t num;
129 //The first byte detected in a 2+ byte opcode. Should be 0xF0.
130 uint8_t prefixA;
131 //The second byte detected in a 3+ byte opcode. Could be 0xF0 for
132 //3dnow instructions, or 0x38-0x3F for some SSE instructions.
133 uint8_t prefixB;
134 //The main opcode byte. The highest addressed byte in the opcode.
135 Opcode op;
136 } opcode;
137 //Modifier bytes
138 ModRM modRM;
139 uint8_t sib;
140 //Immediate fields
141 uint64_t immediate;
142 uint64_t displacement;
143 };
144
145 inline static std::ostream &
146 operator << (std::ostream & os, const ExtMachInst & emi)
147 {
148 ccprintf(os, "\n{\n\tleg = %#x,\n\trex = %#x,\n\t"
149 "op = {\n\t\tnum = %d,\n\t\top = %#x,\n\t\t"
150 "prefixA = %#x,\n\t\tprefixB = %#x\n\t},\n\t"
151 "modRM = %#x,\n\tsib = %#x,\n\t"
152 "immediate = %#x,\n\tdisplacement = %#x\n}\n",
153 emi.legacy, (uint8_t)emi.rex,
154 emi.opcode.num, emi.opcode.op,
155 emi.opcode.prefixA, emi.opcode.prefixB,
156 (uint8_t)emi.modRM, (uint8_t)emi.sib,
157 emi.immediate, emi.displacement);
158 return os;
159 }
160
161 inline static bool
162 operator == (const ExtMachInst &emi1, const ExtMachInst &emi2)
163 {
| 1/*
2 * Copyright (c) 2007 The Hewlett-Packard Development Company
3 * All rights reserved.
4 *
5 * Redistribution and use of this software in source and binary forms,
6 * with or without modification, are permitted provided that the
7 * following conditions are met:
8 *
9 * The software must be used only for Non-Commercial Use which means any
10 * use which is NOT directed to receiving any direct monetary
11 * compensation for, or commercial advantage from such use. Illustrative
12 * examples of non-commercial use are academic research, personal study,
13 * teaching, education and corporate research & development.
14 * Illustrative examples of commercial use are distributing products for
15 * commercial advantage and providing services using the software for
16 * commercial advantage.
17 *
18 * If you wish to use this software or functionality therein that may be
19 * covered by patents for commercial use, please contact:
20 * Director of Intellectual Property Licensing
21 * Office of Strategy and Technology
22 * Hewlett-Packard Company
23 * 1501 Page Mill Road
24 * Palo Alto, California 94304
25 *
26 * Redistributions of source code must retain the above copyright notice,
27 * this list of conditions and the following disclaimer. Redistributions
28 * in binary form must reproduce the above copyright notice, this list of
29 * conditions and the following disclaimer in the documentation and/or
30 * other materials provided with the distribution. Neither the name of
31 * the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
32 * contributors may be used to endorse or promote products derived from
33 * this software without specific prior written permission. No right of
34 * sublicense is granted herewith. Derivatives of the software and
35 * output created using the software may be prepared, but only for
36 * Non-Commercial Uses. Derivatives of the software may be shared with
37 * others provided: (i) the others agree to abide by the list of
38 * conditions herein which includes the Non-Commercial Use restrictions;
39 * and (ii) such Derivatives of the software include the above copyright
40 * notice to acknowledge the contribution from this software where
41 * applicable, this list of conditions and the disclaimer below.
42 *
43 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
44 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
45 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
46 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
47 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
49 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
50 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
51 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
52 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
53 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54 *
55 * Authors: Gabe Black
56 */
57
58#ifndef __ARCH_X86_TYPES_HH__
59#define __ARCH_X86_TYPES_HH__
60
61#include <inttypes.h>
62#include <iostream>
63
64#include "base/bitfield.hh"
65#include "base/cprintf.hh"
66
67namespace X86ISA
68{
69 //This really determines how many bytes are passed to the predecoder.
70 typedef uint64_t MachInst;
71
72 enum Prefixes {
73 NoOverride = 0,
74 CSOverride = 1,
75 DSOverride = 2,
76 ESOverride = 3,
77 FSOverride = 4,
78 GSOverride = 5,
79 SSOverride = 6,
80 //The Rex prefix obviously doesn't fit in with the above, but putting
81 //it here lets us save double the space the enums take up.
82 RexPrefix = 7,
83 //There can be only one segment override, so they share the
84 //first 3 bits in the legacyPrefixes bitfield.
85 SegmentOverride = 0x7,
86 OperandSizeOverride = 8,
87 AddressSizeOverride = 16,
88 Lock = 32,
89 Rep = 64,
90 Repne = 128
91 };
92
93 BitUnion8(ModRM)
94 Bitfield<7,6> mod;
95 Bitfield<5,3> reg;
96 Bitfield<2,0> rm;
97 EndBitUnion(ModRM)
98
99 BitUnion8(Sib)
100 Bitfield<7,6> scale;
101 Bitfield<5,3> index;
102 Bitfield<2,0> base;
103 EndBitUnion(Sib)
104
105 BitUnion8(Rex)
106 Bitfield<3> w;
107 Bitfield<2> r;
108 Bitfield<1> x;
109 Bitfield<0> b;
110 EndBitUnion(Rex)
111
112 BitUnion8(Opcode)
113 Bitfield<7,3> top5;
114 Bitfield<2,0> bottom3;
115 EndBitUnion(Opcode)
116
117 //The intermediate structure the x86 predecoder returns.
118 struct ExtMachInst
119 {
120 //Prefixes
121 uint8_t legacy;
122 Rex rex;
123 //This holds all of the bytes of the opcode
124 struct
125 {
126 //The number of bytes in this opcode. Right now, we ignore that
127 //this can be 3 in some cases
128 uint8_t num;
129 //The first byte detected in a 2+ byte opcode. Should be 0xF0.
130 uint8_t prefixA;
131 //The second byte detected in a 3+ byte opcode. Could be 0xF0 for
132 //3dnow instructions, or 0x38-0x3F for some SSE instructions.
133 uint8_t prefixB;
134 //The main opcode byte. The highest addressed byte in the opcode.
135 Opcode op;
136 } opcode;
137 //Modifier bytes
138 ModRM modRM;
139 uint8_t sib;
140 //Immediate fields
141 uint64_t immediate;
142 uint64_t displacement;
143 };
144
145 inline static std::ostream &
146 operator << (std::ostream & os, const ExtMachInst & emi)
147 {
148 ccprintf(os, "\n{\n\tleg = %#x,\n\trex = %#x,\n\t"
149 "op = {\n\t\tnum = %d,\n\t\top = %#x,\n\t\t"
150 "prefixA = %#x,\n\t\tprefixB = %#x\n\t},\n\t"
151 "modRM = %#x,\n\tsib = %#x,\n\t"
152 "immediate = %#x,\n\tdisplacement = %#x\n}\n",
153 emi.legacy, (uint8_t)emi.rex,
154 emi.opcode.num, emi.opcode.op,
155 emi.opcode.prefixA, emi.opcode.prefixB,
156 (uint8_t)emi.modRM, (uint8_t)emi.sib,
157 emi.immediate, emi.displacement);
158 return os;
159 }
160
161 inline static bool
162 operator == (const ExtMachInst &emi1, const ExtMachInst &emi2)
163 {
|