1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
; X86ISA Library
; Note: The license below is based on the template at:
; http://opensource.org/licenses/BSD-3-Clause
; Copyright (C) 2018, Shilpi Goel
; All rights reserved.
; Redistribution and use in source and binary forms, with or without
; modification, are permitted provided that the following conditions are
; met:
; o Redistributions of source code must retain the above copyright
; notice, this list of conditions and the following disclaimer.
; o Redistributions in binary form must reproduce the above copyright
; notice, this list of conditions and the following disclaimer in the
; documentation and/or other materials provided with the distribution.
; o Neither the name of the copyright holders nor the names of its
; contributors may be used to endorse or promote products derived
; from this software without specific prior written permission.
; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
; A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
; HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
; LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
; DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
; THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
; OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
; Original Author(s):
; Shilpi Goel <shigoel@gmail.com>
(in-package "X86ISA")
(include-book "instructions/top"
:ttags (:syscall-exec :other-non-det :undef-flg))
(include-book "prefix-modrm-sib-decoding")
(include-book "dispatch-macros")
(include-book "cpuid")
(include-book "std/strings/hexify" :dir :system)
(local (include-book "dispatch-creator"))
(local (include-book "centaur/bitops/ihs-extensions" :dir :system))
(local (include-book "centaur/bitops/signed-byte-p" :dir :system))
(local (in-theory (e/d ()
(app-view-rml08-no-error
(:meta acl2::mv-nth-cons-meta)
rme08-value-when-error
member-equal))))
(local (xdoc::set-default-parents x86-decoder))
;; ----------------------------------------------------------------------
(make-event
(b* ((dispatch
(create-dispatch-for-opcodes
#ux0F_38_00 256 :0F-38-three-byte (w state))))
`(define first-three-byte-opcode-execute
((proc-mode :type (integer 0 #.*num-proc-modes-1*))
(start-rip :type (signed-byte #.*max-linear-address-size*))
(temp-rip :type (signed-byte #.*max-linear-address-size*))
(prefixes :type (unsigned-byte #.*prefixes-width*))
(mandatory-prefix :type (unsigned-byte 8))
(rex-byte :type (unsigned-byte 8))
(opcode :type (unsigned-byte 8))
(modr/m :type (unsigned-byte 8))
(sib :type (unsigned-byte 8))
x86)
;; #x0F #x38 are the first two opcode bytes.
:parents (x86-decoder)
;; The following arg will avoid binding __function__ to
;; first-three-byte-opcode-execute. The automatic __function__ binding
;; that comes with define causes stack overflows during the guard proof
;; of this function.
:no-function t
:ignore-ok t
:short "First three-byte opcode dispatch function."
:long "<p>@('first-three-byte-opcode-execute') is the doorway to the
first three-byte opcode map, i.e., to all three-byte opcodes whose first
two opcode bytes are @('0F 38').</p>"
:guard-hints (("Goal"
:do-not '(preprocess)
:in-theory
(e/d
()
(unsigned-byte-p signed-byte-p))))
:guard (rip-guard-okp proc-mode temp-rip)
(case opcode ,@dispatch)
///
(defthm x86p-first-three-byte-opcode-execute
(implies (x86p x86)
(x86p
(first-three-byte-opcode-execute
proc-mode start-rip temp-rip prefixes
mandatory-prefix rex-byte opcode modr/m sib x86)))))))
(make-event
(b* ((dispatch
(create-dispatch-for-opcodes
#ux0F_3A_00 256 :0F-3A-three-byte (w state))))
`(define second-three-byte-opcode-execute
((proc-mode :type (integer 0 #.*num-proc-modes-1*))
(start-rip :type (signed-byte #.*max-linear-address-size*))
(temp-rip :type (signed-byte #.*max-linear-address-size*))
(prefixes :type (unsigned-byte #.*prefixes-width*))
(mandatory-prefix :type (unsigned-byte 8))
(rex-byte :type (unsigned-byte 8))
(opcode :type (unsigned-byte 8))
(modr/m :type (unsigned-byte 8))
(sib :type (unsigned-byte 8))
x86)
;; #x0F #x3A are the first two opcode bytes.
:parents (x86-decoder)
;; The following arg will avoid binding __function__ to
;; second-three-byte-opcode-execute. The automatic __function__ binding that
;; comes with define causes stack overflows during the guard proof of this
;; function.
:no-function t
:ignore-ok t
:short "Second three-byte opcode dispatch function."
:long "<p>@('second-three-byte-opcode-execute') is the doorway to the second
three-byte opcode map, i.e., to all three-byte opcodes whose second two
opcode bytes are @('0F 3A').</p>"
:guard (rip-guard-okp proc-mode temp-rip)
:guard-hints (("Goal"
:do-not '(preprocess)
:in-theory (e/d () (unsigned-byte-p signed-byte-p))))
(case opcode ,@dispatch)
///
(defthm x86p-second-three-byte-opcode-execute
(implies (x86p x86)
(x86p (second-three-byte-opcode-execute
proc-mode start-rip temp-rip prefixes
mandatory-prefix rex-byte opcode modr/m sib x86)))))))
(local (defthm unsigned-byte-p-when-lte-loghead
(implies (and (natp x)
(natp n)
(<= x (loghead n y)))
(unsigned-byte-p n x))
:hints(("Goal" :in-theory (enable unsigned-byte-p)
:use ((:instance acl2::unsigned-byte-p-loghead
(size n) (size1 n) (i y)))))))
(define three-byte-opcode-decode-and-execute
((proc-mode :type (integer 0 #.*num-proc-modes-1*))
(start-rip :type (signed-byte #.*max-linear-address-size*))
(temp-rip :type (signed-byte #.*max-linear-address-size*))
(prefixes :type (unsigned-byte #.*prefixes-width*))
(rex-byte :type (unsigned-byte 8))
(second-escape-byte :type (unsigned-byte 8))
x86)
:ignore-ok t
:guard (or (equal second-escape-byte #x38)
(equal second-escape-byte #x3A))
:guard-hints (("Goal" :do-not '(preprocess)
:in-theory (e/d*
(add-to-*ip add-to-*ip-is-i48p-rewrite-rule)
(unsigned-byte-p
(:type-prescription bitops::logand-natp-type-2)
(:type-prescription bitops::ash-natp-type)
acl2::loghead-identity
not
tau-system
(tau-system)))))
:parents (x86-decoder)
:short "Decoder and dispatch function for three-byte opcodes, where @('0x0F
0x38') are the first two opcode bytes"
:long "<p>Source: Intel Manual, Volume 2, Appendix A-2</p>"
(b* ((ctx 'three-byte-opcode-decode-and-execute)
((mv flg0 (the (unsigned-byte 8) opcode) x86)
(rme08 proc-mode temp-rip #.*cs* :x x86))
((when flg0)
(!!ms-fresh :opcode-byte-access-error flg0))
;; Possible values of opcode: all values denote opcodes of the first or
;; second three-byte map, depending on the value of second-escape-byte.
;; The function first-three-byte-opcode-execute or
;; second-three-byte-opcode-execute case-splits on this opcode byte and
;; calls the appropriate instruction semantic function.
((mv flg temp-rip) (add-to-*ip proc-mode temp-rip 1 x86))
((when flg) (!!ms-fresh :increment-error flg))
;; ((mv msg (the (unsigned-byte 8) mandatory-prefix))
;; (compute-mandatory-prefix-for-three-byte-opcode
;; proc-mode second-escape-byte opcode prefixes))
;; ((when msg)
;; (x86-illegal-instruction msg start-rip temp-rip x86))
((the (unsigned-byte 8) mandatory-prefix)
(compute-mandatory-prefix-for-three-byte-opcode
proc-mode second-escape-byte opcode prefixes))
(modr/m?
(three-byte-opcode-ModR/M-p
proc-mode mandatory-prefix second-escape-byte opcode))
((mv flg1 (the (unsigned-byte 8) modr/m) x86)
(if modr/m?
(rme08 proc-mode temp-rip #.*cs* :x x86)
(mv nil 0 x86)))
((when flg1) (!!ms-fresh :modr/m-byte-read-error flg1))
((mv flg temp-rip) (if modr/m?
(add-to-*ip proc-mode temp-rip 1 x86)
(mv nil temp-rip)))
((when flg) (!!ms-fresh :increment-error flg))
(sib? (and modr/m?
(b* ((p4? (eql #.*addr-size-override*
(prefixes->adr prefixes)))
(16-bit-addressp (eql 2 (select-address-size proc-mode p4? x86))))
(x86-decode-SIB-p modr/m 16-bit-addressp))))
((mv flg2 (the (unsigned-byte 8) sib) x86)
(if sib?
(rme08 proc-mode temp-rip #.*cs* :x x86)
(mv nil 0 x86)))
((when flg2)
(!!ms-fresh :sib-byte-read-error flg2))
((mv flg temp-rip) (if sib?
(add-to-*ip proc-mode temp-rip 1 x86)
(mv nil temp-rip)))
((when flg) (!!ms-fresh :increment-error flg)))
(case second-escape-byte
(#x38
(first-three-byte-opcode-execute
proc-mode start-rip temp-rip prefixes mandatory-prefix
rex-byte opcode modr/m sib x86))
(#x3A
(second-three-byte-opcode-execute
proc-mode start-rip temp-rip prefixes mandatory-prefix
rex-byte opcode modr/m sib x86))
(otherwise
;; Unreachable.
(!!ms-fresh :illegal-value-of-second-escape-byte second-escape-byte))))
///
(defrule x86p-three-byte-opcode-decode-and-execute
(implies (x86p x86)
(x86p (three-byte-opcode-decode-and-execute
proc-mode start-rip temp-rip prefixes rex-byte escape-byte x86)))
:enable add-to-*ip-is-i48p-rewrite-rule
:disable signed-byte-p))
;; ----------------------------------------------------------------------
|
