2 # gen-insn-attr-x86.awk: Instruction attribute table generator
3 # Written by Masami Hiramatsu <mhiramat@redhat.com>
5 # Usage: awk -f gen-insn-attr-x86.awk x86-opcode-map.txt > inat-tables.c
7 # Awk implementation sanity check
8 function check_awk_implement() {
9 if (sprintf("%x", 0) != "0")
10 return "Your awk has a printf-format problem."
15 function clear_vars() {
27 # Implementation error checking
28 awkchecked = check_awk_implement()
29 if (awkchecked != "") {
30 print "Error: " awkchecked > "/dev/stderr"
31 print "Please try to use gawk." > "/dev/stderr"
35 # Setup generating tables
36 print "/* x86 opcode map generated from x86-opcode-map.txt */"
37 print "/* Do not change this code. */\n"
45 opnd_expr = "^[A-Za-z/]"
48 group_expr = "^Grp[0-9A-Za-z]+"
50 imm_expr = "^[IJAOL][a-z]"
51 imm_flag["Ib"] = "INAT_MAKE_IMM(INAT_IMM_BYTE)"
52 imm_flag["Jb"] = "INAT_MAKE_IMM(INAT_IMM_BYTE)"
53 imm_flag["Iw"] = "INAT_MAKE_IMM(INAT_IMM_WORD)"
54 imm_flag["Id"] = "INAT_MAKE_IMM(INAT_IMM_DWORD)"
55 imm_flag["Iq"] = "INAT_MAKE_IMM(INAT_IMM_QWORD)"
56 imm_flag["Ap"] = "INAT_MAKE_IMM(INAT_IMM_PTR)"
57 imm_flag["Iz"] = "INAT_MAKE_IMM(INAT_IMM_VWORD32)"
58 imm_flag["Jz"] = "INAT_MAKE_IMM(INAT_IMM_VWORD32)"
59 imm_flag["Iv"] = "INAT_MAKE_IMM(INAT_IMM_VWORD)"
60 imm_flag["Ob"] = "INAT_MOFFSET"
61 imm_flag["Ov"] = "INAT_MOFFSET"
62 imm_flag["Lx"] = "INAT_MAKE_IMM(INAT_IMM_BYTE)"
64 modrm_expr = "^([CDEGMNPQRSUVW/][a-z]+|NTA|T[012])"
65 force64_expr = "\\([df]64\\)"
66 rex_expr = "^REX(\\.[XRWB]+)*"
67 fpu_expr = "^ESC" # TODO
69 lprefix1_expr = "\\((66|!F3)\\)"
70 lprefix2_expr = "\\(F3\\)"
71 lprefix3_expr = "\\((F2|!F3|66&F2)\\)"
72 lprefix_expr = "\\((66|F2|F3)\\)"
75 # All opcodes starting with lower-case 'v', 'k' or with (v1) superscript
77 vexok_opcode_expr = "^[vk].*"
78 vexok_expr = "\\(v1\\)"
79 # All opcodes with (v) superscript supports *only* VEX prefix
80 vexonly_expr = "\\(v\\)"
81 # All opcodes with (ev) superscript supports *only* EVEX prefix
82 evexonly_expr = "\\(ev\\)"
84 prefix_expr = "\\(Prefix\\)"
85 prefix_num["Operand-Size"] = "INAT_PFX_OPNDSZ"
86 prefix_num["REPNE"] = "INAT_PFX_REPNE"
87 prefix_num["REP/REPE"] = "INAT_PFX_REPE"
88 prefix_num["XACQUIRE"] = "INAT_PFX_REPNE"
89 prefix_num["XRELEASE"] = "INAT_PFX_REPE"
90 prefix_num["LOCK"] = "INAT_PFX_LOCK"
91 prefix_num["SEG=CS"] = "INAT_PFX_CS"
92 prefix_num["SEG=DS"] = "INAT_PFX_DS"
93 prefix_num["SEG=ES"] = "INAT_PFX_ES"
94 prefix_num["SEG=FS"] = "INAT_PFX_FS"
95 prefix_num["SEG=GS"] = "INAT_PFX_GS"
96 prefix_num["SEG=SS"] = "INAT_PFX_SS"
97 prefix_num["Address-Size"] = "INAT_PFX_ADDRSZ"
98 prefix_num["VEX+1byte"] = "INAT_PFX_VEX2"
99 prefix_num["VEX+2byte"] = "INAT_PFX_VEX3"
100 prefix_num["EVEX"] = "INAT_PFX_EVEX"
105 function semantic_error(msg) {
106 print "Semantic error at " NR ": " msg > "/dev/stderr"
110 function debug(msg) {
114 function array_size(arr, i,c) {
124 semantic_error("Hit Table: before EndTable:.");
129 # escape opcode table
131 for (i = 2; i <= NF; i++)
134 tname = sprintf("inat_escape_table_%d", eid)
140 # AVX/escape opcode table
144 if (tname == "") # AVX only opcode table
145 tname = sprintf("inat_avx_table_%d", $2)
147 if (aid == -1 && eid == -1) # primary opcode table
148 tname = "inat_primary_table"
154 semantic_error("No group: " $2 )
156 tname = "inat_group_table_" gid
159 function print_table(tbl,name,fmt,n)
161 print "const insn_attr_t " name " = {"
162 for (i = 0; i < n; i++) {
165 print " [" id "] = " tbl[id] ","
173 if (array_size(table) != 0) {
174 print_table(table, tname "[INAT_GROUP_TABLE_SIZE]",
176 gtable[gid,0] = tname
178 if (array_size(lptable1) != 0) {
179 print_table(lptable1, tname "_1[INAT_GROUP_TABLE_SIZE]",
181 gtable[gid,1] = tname "_1"
183 if (array_size(lptable2) != 0) {
184 print_table(lptable2, tname "_2[INAT_GROUP_TABLE_SIZE]",
186 gtable[gid,2] = tname "_2"
188 if (array_size(lptable3) != 0) {
189 print_table(lptable3, tname "_3[INAT_GROUP_TABLE_SIZE]",
191 gtable[gid,3] = tname "_3"
194 # print primary/escaped tables
195 if (array_size(table) != 0) {
196 print_table(table, tname "[INAT_OPCODE_TABLE_SIZE]",
198 etable[eid,0] = tname
200 atable[aid,0] = tname
202 if (array_size(lptable1) != 0) {
203 print_table(lptable1,tname "_1[INAT_OPCODE_TABLE_SIZE]",
205 etable[eid,1] = tname "_1"
207 atable[aid,1] = tname "_1"
209 if (array_size(lptable2) != 0) {
210 print_table(lptable2,tname "_2[INAT_OPCODE_TABLE_SIZE]",
212 etable[eid,2] = tname "_2"
214 atable[aid,2] = tname "_2"
216 if (array_size(lptable3) != 0) {
217 print_table(lptable3,tname "_3[INAT_OPCODE_TABLE_SIZE]",
219 etable[eid,3] = tname "_3"
221 atable[aid,3] = tname "_3"
228 function add_flags(old,new) {
237 # convert operands to flags.
238 function convert_operands(count,opnd, i,j,imm,mod)
242 for (j = 1; j <= count; j++) {
244 if (match(i, imm_expr) == 1) {
246 semantic_error("Unknown imm opnd: " i)
249 semantic_error("Second IMM error")
250 imm = add_flags(imm, "INAT_SCNDIMM")
253 } else if (match(i, modrm_expr))
256 return add_flags(imm, mod)
263 idx = "0x" substr($1, 1, index($1,":") - 1)
265 semantic_error("Redefine " idx " in " tname)
267 # check if escaped opcode
268 if ("escape" == $2) {
270 semantic_error("No escaped name")
272 for (i = 4; i <= NF; i++)
275 semantic_error("Redefine escape (" ref ")")
278 table[idx] = "INAT_MAKE_ESCAPE(" escape[ref] ")"
292 if (match($i, opnd_expr)) {
294 count = split($(i++), opnds, ",")
295 flags = convert_operands(count, opnds)
297 if (match($i, ext_expr))
299 if (match($i, sep_expr))
302 semantic_error($i " is not a separator")
304 # check if group opcode
305 if (match(opcode, group_expr)) {
306 if (!(opcode in group)) {
310 flags = add_flags(flags, "INAT_MAKE_GROUP(" group[opcode] ")")
312 # check force(or default) 64bit
313 if (match(ext, force64_expr))
314 flags = add_flags(flags, "INAT_FORCE64")
317 if (match(opcode, rex_expr))
318 flags = add_flags(flags, "INAT_MAKE_PREFIX(INAT_PFX_REX)")
320 # check coprocessor escape : TODO
321 if (match(opcode, fpu_expr))
322 flags = add_flags(flags, "INAT_MODRM")
325 if (match(ext, evexonly_expr))
326 flags = add_flags(flags, "INAT_VEXOK | INAT_EVEXONLY")
327 else if (match(ext, vexonly_expr))
328 flags = add_flags(flags, "INAT_VEXOK | INAT_VEXONLY")
329 else if (match(ext, vexok_expr) || match(opcode, vexok_opcode_expr))
330 flags = add_flags(flags, "INAT_VEXOK")
333 if (match(ext, prefix_expr)) {
334 if (!prefix_num[opcode])
335 semantic_error("Unknown prefix: " opcode)
336 flags = add_flags(flags, "INAT_MAKE_PREFIX(" prefix_num[opcode] ")")
338 if (length(flags) == 0)
340 # check if last prefix
341 if (match(ext, lprefix1_expr)) {
342 lptable1[idx] = add_flags(lptable1[idx],flags)
343 variant = "INAT_VARIANT"
345 if (match(ext, lprefix2_expr)) {
346 lptable2[idx] = add_flags(lptable2[idx],flags)
347 variant = "INAT_VARIANT"
349 if (match(ext, lprefix3_expr)) {
350 lptable3[idx] = add_flags(lptable3[idx],flags)
351 variant = "INAT_VARIANT"
353 if (!match(ext, lprefix_expr)){
354 table[idx] = add_flags(table[idx],flags)
358 table[idx] = add_flags(table[idx],variant)
362 if (awkchecked != "")
364 # print escape opcode map's array
365 print "/* Escape opcode map array */"
366 print "const insn_attr_t * const inat_escape_tables[INAT_ESC_MAX + 1]" \
367 "[INAT_LSTPFX_MAX + 1] = {"
368 for (i = 0; i < geid; i++)
369 for (j = 0; j < max_lprefix; j++)
371 print " ["i"]["j"] = "etable[i,j]","
373 # print group opcode map's array
374 print "/* Group opcode map array */"
375 print "const insn_attr_t * const inat_group_tables[INAT_GRP_MAX + 1]"\
376 "[INAT_LSTPFX_MAX + 1] = {"
377 for (i = 0; i < ggid; i++)
378 for (j = 0; j < max_lprefix; j++)
380 print " ["i"]["j"] = "gtable[i,j]","
382 # print AVX opcode map's array
383 print "/* AVX opcode map array */"
384 print "const insn_attr_t * const inat_avx_tables[X86_VEX_M_MAX + 1]"\
385 "[INAT_LSTPFX_MAX + 1] = {"
386 for (i = 0; i < gaid; i++)
387 for (j = 0; j < max_lprefix; j++)
389 print " ["i"]["j"] = "atable[i,j]","