bs3-cpu-generated-1-data.py@ 66162

Last change on this file since 66162 was 66134, checked in by vboxsync, 8 years ago
bs3-cpu-generated-1: Deal with instructions not available in 64-bit mode (invalid) and fixed form instruction w/o any operands (e.g. AAA).
Property svn:eol-style set to `LF` Property svn:executable set to ``* Property svn:keywords set to `Author Date Id Revision`
File size: 20.8 KB

Line
1	#!/usr/bin/env python
2	# -- coding: utf-8 --
3	# $Id: bs3-cpu-generated-1-data.py 66134 2017-03-16 15:45:31Z vboxsync $
4	# pylint: disable=invalid-name
5
6	"""
7	Generates testcases from @optest specifications in IEM.
8	"""
9
10	from __future__ import print_function;
11
12	__copyright__ = \
13	"""
14	Copyright (C) 2017 Oracle Corporation
15
16	This file is part of VirtualBox Open Source Edition (OSE), as
17	available from http://www.virtualbox.org. This file is free software;
18	you can redistribute it and/or modify it under the terms of the GNU
19	General Public License (GPL) as published by the Free Software
20	Foundation, in version 2 as it comes in the "COPYING" file of the
21	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
22	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
23
24	The contents of this file may alternatively be used under the terms
25	of the Common Development and Distribution License Version 1.0
26	(CDDL) only, as it comes in the "COPYING.CDDL" file of the
27	VirtualBox OSE distribution, in which case the provisions of the
28	CDDL are applicable instead of those of the GPL.
29
30	You may elect to license modified versions of this file under the
31	terms and conditions of either the GPL or the CDDL or both.
32	"""
33	__version__ = "$Revision: 66134 $"
34
35	# Standard python imports.
36	import os;
37	import sys;
38
39	# Only the main script needs to modify the path.
40	g_ksValidationKitDir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)));
41	g_ksVmmAllDir = os.path.join(os.path.dirname(g_ksValidationKitDir), 'VMM', 'VMMAll')
42	sys.path.append(g_ksVmmAllDir);
43
44	import IEMAllInstructionsPython as iai; # pylint: disable=import-error
45
46
47	# Python 3 hacks:
48	if sys.version_info[0] >= 3:
49	long = int; # pylint: disable=redefined-builtin,invalid-name
50
51
52	class Bs3Cg1TestEncoder(object):
53	"""
54	Does the encoding of a single test.
55	"""
56
57	def __init__(self, fLast):
58	self.fLast = fLast;
59	# Each list member (in all lists) are C expression of a byte.
60	self.asHdr = [];
61	self.asSelectors = [];
62	self.asInputs = [];
63	self.asOutputs = [];
64
65	@staticmethod
66	def _compileSelectors(aoSelectors): # (list(iai.TestSelector)) -> list(str)
67	"""
68	Compiles a list of iai.TestSelector predicate checks.
69	Returns C byte expression strings.
70	"""
71	asRet = [];
72	for oSelector in aoSelectors:
73	sConstant = oSelector.kdVariables[oSelector.sVariable][oSelector.sValue];
74	sConstant = sConstant.upper().replace('.', '_');
75	if oSelector.sOp == '==':
76	sByte = '(BS3CG1PRED_%s << BS3CG1SEL_OP_PRED_SHIFT) \| BS3CG1SEL_OP_IS_TRUE' % (sConstant,);
77	elif oSelector.sOp == '!=':
78	sByte = '(BS3CG1PRED_%s << BS3CG1SEL_OP_PRED_SHIFT) \| BS3CG1SEL_OP_IS_FALSE' % (sConstant,);
79	else:
80	raise Exception('Unknown selector operator: %s' % (oSelector.sOp,));
81	asRet.append(sByte);
82	return asRet;
83
84	kdSmallFields = {
85	'op1': 'BS3CG1_CTXOP_OP1',
86	'op2': 'BS3CG1_CTXOP_OP2',
87	'efl': 'BS3CG1_CTXOP_EFL',
88	};
89	kdOperators = {
90	'=': 'BS3CG1_CTXOP_ASSIGN',
91	'\|=': 'BS3CG1_CTXOP_OR',
92	'&=': 'BS3CG1_CTXOP_AND',
93	'&~=': 'BS3CG1_CTXOP_AND_INV',
94	};
95	kdSmallSizes = {
96	1: 'BS3CG1_CTXOP_1_BYTE',
97	2: 'BS3CG1_CTXOP_2_BYTES',
98	4: 'BS3CG1_CTXOP_4_BYTES',
99	8: 'BS3CG1_CTXOP_8_BYTES',
100	16: 'BS3CG1_CTXOP_16_BYTES',
101	32: 'BS3CG1_CTXOP_32_BYTES',
102	12: 'BS3CG1_CTXOP_12_BYTES',
103	};
104
105	@staticmethod
106	def _amendOutputs(aoOutputs, oInstr): # type: (list(iai.TestInOut), iai.Instruction) -> list(iai.TestInOut)
107	"""
108	Amends aoOutputs for instructions with special flag behaviour (undefined,
109	always set, always clear).
110
111	Undefined flags are copied from the result context as the very first
112	operation so they can be set to CPU vendor specific values later if
113	desired.
114
115	Always set or cleared flags are applied at the very end of the
116	modification operations so that we spot incorrect specifications.
117	"""
118	if oInstr.asFlUndefined or oInstr.asFlClear or oInstr.asFlSet:
119	aoOutputs = list(aoOutputs);
120
121	if oInstr.asFlUndefined:
122	fFlags = oInstr.getUndefinedFlagsMask();
123	assert fFlags != 0;
124	aoOutputs.insert(0, iai.TestInOut('efl_undef', '=', str(fFlags), 'uint'));
125
126	if oInstr.asFlClear:
127	fFlags = oInstr.getClearedFlagsMask();
128	assert fFlags != 0;
129	aoOutputs.append(iai.TestInOut('efl', '&~=', str(fFlags), 'uint'));
130
131	if oInstr.asFlSet:
132	fFlags = oInstr.getSetFlagsMask();
133	assert fFlags != 0;
134	aoOutputs.append(iai.TestInOut('efl', '\|=', str(fFlags), 'uint'));
135
136	return aoOutputs;
137
138	@staticmethod
139	def _compileContextModifers(aoOperations): # (list(iai.TestInOut))
140	"""
141	Compile a list of iai.TestInOut context modifiers.
142	"""
143	asRet = [];
144	for oOperation in aoOperations:
145	oType = iai.TestInOut.kdTypes[oOperation.sType];
146	aaoValues = oType.get(oOperation.sValue);
147	assert len(aaoValues) == 1 or len(aaoValues) == 2;
148
149	sOp = oOperation.sOp;
150	if sOp == '&\|=':
151	sOp = '\|=' if len(aaoValues) == 1 else '&~=';
152
153	for fSignExtend, abValue in aaoValues:
154	cbValue = len(abValue);
155
156	# The opcode byte.
157	sOpcode = Bs3Cg1TestEncoder.kdOperators[sOp];
158	sOpcode += ' \| ';
159	if oOperation.sField in Bs3Cg1TestEncoder.kdSmallFields:
160	sOpcode += Bs3Cg1TestEncoder.kdSmallFields[oOperation.sField];
161	else:
162	sOpcode += 'BS3CG1_CTXOP_DST_ESC';
163	sOpcode += ' \| ';
164	if cbValue in Bs3Cg1TestEncoder.kdSmallSizes:
165	sOpcode += Bs3Cg1TestEncoder.kdSmallSizes[cbValue];
166	else:
167	sOpcode += 'BS3CG1_CTXOP_SIZE_ESC';
168	if fSignExtend:
169	sOpcode += ' \| BS3CG1_CTXOP_SIGN_EXT';
170	asRet.append(sOpcode);
171
172	# Escaped field identifier.
173	if oOperation.sField not in Bs3Cg1TestEncoder.kdSmallFields:
174	asRet.append('BS3CG1DST_%s' % (oOperation.sField.upper().replace('.', '_'),));
175
176	# Escaped size byte?
177	if cbValue not in Bs3Cg1TestEncoder.kdSmallSizes:
178	if cbValue >= 256 or cbValue not in [ 1, 2, 4, 6, 8, 12, 16, 32, 64, 128, ]:
179	raise Exception('Invalid value size: %s' % (cbValue,));
180	asRet.append('0x%02x' % (cbValue,));
181
182	# The value bytes.
183	for b in abValue:
184	asRet.append('0x%02x' % (b,));
185
186	sOp = '\|=';
187
188	return asRet;
189
190	def _constructHeader(self):
191	"""
192	Returns C byte expression strings for BS3CG1TESTHDR.
193	"""
194	cbSelectors = len(self.asSelectors);
195	if cbSelectors >= 256:
196	raise Exception('Too many selectors: %s bytes, max 255 bytes' % (cbSelectors,))
197
198	cbInputs = len(self.asInputs);
199	if cbInputs >= 4096:
200	raise Exception('Too many input context modifiers: %s bytes, max 4095 bytes' % (cbInputs,))
201
202	cbOutputs = len(self.asOutputs);
203	if cbOutputs >= 2048:
204	raise Exception('Too many output context modifiers: %s bytes, max 2047 bytes' % (cbOutputs,))
205
206	return [
207	'%#04x' % (cbSelectors,), # 8-bit
208	'%#05x & 0xff' % (cbInputs,), # first 8 bits of cbInputs
209	'(%#05x >> 8) \| ((%#05x & 0xf) << 4)' % (cbInputs, cbOutputs,), # last 4 bits of cbInputs, lower 4 bits of cbOutputs.
210	'(%#05x >> 4) \| (%#05x << 7)' % (cbOutputs, self.fLast), # last 7 bits of cbOutputs and 1 bit fLast.
211	];
212
213	def encodeTest(self, oTest): # type: (iai.InstructionTest)
214	"""
215	Does the encoding.
216	"""
217	self.asSelectors = self._compileSelectors(oTest.aoSelectors);
218	self.asInputs = self._compileContextModifers(oTest.aoInputs);
219	self.asOutputs = self._compileContextModifers(self._amendOutputs(oTest.aoOutputs, oTest.oInstr));
220	self.asHdr = self._constructHeader();
221
222
223	class Bs3Cg1EncodedTests(object):
224	"""
225	Encodes the tests for an instruction.
226	"""
227
228	def __init__(self, oInstr):
229	self.offTests = -1;
230	self.cbTests = 0;
231	self.asLines = []; # type: list(str)
232	self.aoInstructions = []; # type: list(iai.Instruction)
233
234	# Encode the tests.
235	for iTest, oTest in enumerate(oInstr.aoTests):
236	oEncodedTest = Bs3Cg1TestEncoder(iTest + 1 == len(oInstr.aoTests));
237	oEncodedTest.encodeTest(oTest);
238
239	self.cbTests += len(oEncodedTest.asHdr) + len(oEncodedTest.asSelectors) \
240	+ len(oEncodedTest.asInputs) + len(oEncodedTest.asOutputs);
241
242	self.asLines.append(' /* test #%s: %s */' % (iTest, oTest,));
243	self.asLines += self.bytesToLines(' ', oEncodedTest.asHdr);
244	if oEncodedTest.asSelectors:
245	self.asLines += self.bytesToLines(' /sel:/ ', oEncodedTest.asSelectors);
246	if oEncodedTest.asInputs:
247	self.asLines += self.bytesToLines(' /* in:*/ ', oEncodedTest.asInputs);
248	if oEncodedTest.asOutputs:
249	self.asLines += self.bytesToLines(' /out:/ ', oEncodedTest.asOutputs);
250
251	@staticmethod
252	def bytesToLines(sPrefix, asBytes):
253	"""
254	Formats a series of bytes into one or more lines.
255	A byte ending with a newline indicates that we should start a new line,
256	and prefix it by len(sPrefix) spaces.
257
258	Returns list of lines.
259	"""
260	asRet = [];
261	sLine = sPrefix;
262	for sByte in asBytes:
263	if sByte[-1] == '\n':
264	sLine += sByte[:-1] + ',';
265	asRet.append(sLine);
266	sLine = ' ' * len(sPrefix);
267	else:
268	if len(sLine) + 2 + len(sByte) > 132 and len(sLine) > len(sPrefix):
269	asRet.append(sLine[:-1]);
270	sLine = ' ' * len(sPrefix);
271	sLine += sByte + ', ';
272
273
274	if len(sLine) > len(sPrefix):
275	asRet.append(sLine);
276	return asRet;
277
278
279	def isEqual(self, oOther):
280	""" Compares two encoded tests. """
281	if self.cbTests != oOther.cbTests:
282	return False;
283	if len(self.asLines) != len(oOther.asLines):
284	return False;
285	for iLine, sLines in enumerate(self.asLines):
286	if sLines != oOther.asLines[iLine]:
287	return False;
288	return True;
289
290
291
292	class Bs3Cg1Instruction(object):
293	"""
294	An instruction with tests.
295	"""
296
297	def __init__(self, oMap, oInstr, oTests):
298	self.oMap = oMap; # type: iai.InstructionMap
299	self.oInstr = oInstr; # type: iai.Instruction
300	self.oTests = oTests; # type: Bs3Cg1EncodedTests
301
302	self.asOpcodes = oMap.asLeadOpcodes + [ '0x%02x' % (oInstr.getOpcodeByte(),) ];
303	self.sEncoding = iai.g_kdEncodings[oInstr.sEncoding][0];
304	for oOp in oInstr.aoOperands:
305	self.sEncoding += '_' + oOp.sType;
306
307	self.asFlags = [];
308	if 'invalid_64' in oInstr.dHints:
309	self.asFlags.append('BS3CG1INSTR_F_INVALID_64BIT')
310
311	self.fAdvanceMnemonic = True; ##< Set by the caller.
312	if self.sEncoding == 'ModR/M':
313	if 'ignores_op_size' not in oInstr.dHints:
314	self.sPfxKind = 'BS3CGPFXKIND_MODRM';
315	else:
316	self.sPfxKind = 'BS3CGPFXKIND_MODRM_NO_OP_SIZES';
317	else:
318	self.sPfxKind = '0';
319
320
321	def getOperands(self):
322	""" Returns comma separated string of operand values for g_abBs3Cg1Operands. """
323	return ', '.join(['(uint8_t)BS3CG1OP_%s' % (oOp.sType,) for oOp in self.oInstr.aoOperands]);
324
325	def getInstructionEntry(self):
326	""" Returns an array of BS3CG1INSTR member initializers. """
327	return [
328	' /* cbOpcodes = */ %s,' % (len(self.asOpcodes),),
329	' /* cOperands = */ %s,' % (len(self.oInstr.aoOperands),),
330	' /* cchMnemonic = */ %s,' % (len(self.oInstr.sMnemonic),),
331	' /* fAdvanceMnemonic = */ %s,' % ('true' if self.fAdvanceMnemonic else 'false',),
332	' /* offTests = */ %s,' % (self.oTests.offTests,),
333	' /* enmEncoding = */ (unsigned)%s,' % (self.sEncoding,),
334	' /* enmPfxKind = */ (unsigned)%s,' % (self.sPfxKind,),
335	' /* uUnused = */ 0,',
336	' /* fFlags = */ %s' % (' \| '.join(self.asFlags) if self.asFlags else '0'),
337	];
338
339
340	class Bs3CpuGenerated1Generator(object):
341	"""
342	The generator code for bs3-cpu-generated-1.
343	"""
344
345	def __init__(self):
346	self.aoInstructions = []; # type: Bs3Cg1Instruction
347	self.aoTests = []; # type: Bs3Cg1EncodedTests
348	self.cbTests = 0;
349
350	def addTests(self, oTests, oInstr): # type: (Bs3Cg1EncodedTests, iai.Instruction) -> Bs3Cg1EncodedTests
351	"""
352	Adds oTests to self.aoTests, setting the oTests.offTests member.
353	Checks for and eliminates duplicates.
354	Returns the tests to use.
355	"""
356	# Check for duplicates.
357	for oExisting in self.aoTests:
358	if oTests.isEqual(oExisting):
359	oExisting.aoInstructions.append(oInstr);
360	return oExisting;
361
362	# New test, so add it.
363	oTests.offTests = self.cbTests;
364	self.aoTests.append(oTests);
365	self.cbTests += oTests.cbTests;
366
367	assert not oTests.aoInstructions;
368	oTests.aoInstructions.append(oInstr);
369
370	return oTests;
371
372	def processInstruction(self):
373	"""
374	Processes the IEM specified instructions.
375	Returns success indicator.
376	"""
377
378	#
379	# Group instructions by mnemonic to reduce the number of sub-tests.
380	#
381	for oInstr in sorted(iai.g_aoAllInstructions,
382	key = lambda oInstr: oInstr.sMnemonic + ''.join([oOp.sType for oOp in oInstr.aoOperands])
383	+ (oInstr.sOpcode if oInstr.sOpcode else 'zz')):
384	if oInstr.aoTests:
385	oTests = Bs3Cg1EncodedTests(oInstr);
386	oTests = self.addTests(oTests, oInstr);
387
388	for oMap in oInstr.aoMaps:
389	self.aoInstructions.append(Bs3Cg1Instruction(oMap, oInstr, oTests));
390
391	# Set fAdvanceMnemonic.
392	for iInstr, oInstr in enumerate(self.aoInstructions):
393	oInstr.fAdvanceMnemonic = iInstr + 1 >= len(self.aoInstructions) \
394	or oInstr.oInstr.sMnemonic != self.aoInstructions[iInstr + 1].oInstr.sMnemonic;
395
396	return True;
397
398	def generateCode(self, oOut):
399	"""
400	Generates the C code.
401	Returns success indicator.
402	"""
403
404	# First, a file header.
405	asLines = [
406	'/*',
407	' * Autogenerated by $Id: bs3-cpu-generated-1-data.py 66134 2017-03-16 15:45:31Z vboxsync $ ',
408	' * Do not edit!',
409	' */',
410	'',
411	'/*',
412	' * Copyright (C) 2017 Oracle Corporation',
413	' *',
414	' * This file is part of VirtualBox Open Source Edition (OSE), as',
415	' * available from http://www.virtualbox.org. This file is free software;',
416	' * you can redistribute it and/or modify it under the terms of the GNU',
417	' * General Public License (GPL) as published by the Free Software',
418	' * Foundation, in version 2 as it comes in the "COPYING" file of the',
419	' * VirtualBox OSE distribution. VirtualBox OSE is distributed in the',
420	' * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.',
421	' * ',
422	' * The contents of this file may alternatively be used under the terms',
423	' * of the Common Development and Distribution License Version 1.0',
424	' * (CDDL) only, as it comes in the "COPYING.CDDL" file of the',
425	' * VirtualBox OSE distribution, in which case the provisions of the',
426	' * CDDL are applicable instead of those of the GPL.',
427	' * ',
428	' * You may elect to license modified versions of this file under the',
429	' * terms and conditions of either the GPL or the CDDL or both.',
430	' */',
431	'',
432	'',
433	'#include "bs3-cpu-generated-1.h"',
434	'',
435	'',
436	'#pragma data_seg ("BS3DATA16")',
437	];
438
439	# Generate the g_achBs3Cg1Mnemonics array.
440	asLines += [
441	'const char BS3_FAR_DATA g_achBs3Cg1Mnemonics[] = ',
442	'{',
443	];
444	fAdvanceMnemonic = True;
445	for oInstr in self.aoInstructions:
446	if fAdvanceMnemonic:
447	asLines.append(' \"%s\"' % (oInstr.oInstr.sMnemonic,));
448	fAdvanceMnemonic = oInstr.fAdvanceMnemonic;
449	asLines += [
450	'};',
451	'',
452	'',
453	];
454
455	# Generate the g_abBs3Cg1Opcodes array.
456	asLines += [
457	'const uint8_t BS3_FAR_DATA g_abBs3Cg1Opcodes[] = ',
458	'{',
459	];
460	for oInstr in self.aoInstructions:
461	asLines.append(' ' + ', '.join(oInstr.asOpcodes) + ',');
462	asLines += [
463	'};',
464	'',
465	'',
466	];
467
468	# Generate the g_abBs3Cg1Opcodes array.
469	asLines += [
470	'const uint8_t BS3_FAR_DATA g_abBs3Cg1Operands[] = ',
471	'{',
472	];
473	cOperands = 0;
474	for oInstr in self.aoInstructions:
475	if oInstr.oInstr.aoOperands:
476	cOperands += len(oInstr.oInstr.aoOperands);
477	asLines.append(' ' + oInstr.getOperands() + ', /* %s */' % (oInstr.oInstr.sStats,));
478	else:
479	asLines.append(' /* none */');
480	if not cOperands:
481	asLines.append(' 0 /* dummy */');
482	asLines += [
483	'};',
484	'',
485	'',
486	];
487
488	# Generate the g_abBs3Cg1Operands array.
489	asLines += [
490	'const BS3CG1INSTR BS3_FAR_DATA g_aBs3Cg1Instructions[] = ',
491	'{',
492	];
493	for oInstr in self.aoInstructions:
494	asLines.append(' {');
495	asLines += oInstr.getInstructionEntry();
496	asLines.append(' },');
497	asLines += [
498	'};',
499	'const uint16_t BS3_FAR_DATA g_cBs3Cg1Instructions = RT_ELEMENTS(g_aBs3Cg1Instructions);',
500	'',
501	'',
502	];
503
504	# Generate the g_abBs3Cg1Tests array.
505	asLines += [
506	'const uint8_t BS3_FAR_DATA g_abBs3Cg1Tests[] = ',
507	'{',
508	];
509	for oTests in self.aoTests:
510	asLines.append(' /*');
511	asLines.append(' * offTests=%s' % (oTests.offTests,));
512	asLines.append(' * Instructions: %s' % (', '.join([oInstr.sStats for oInstr in oTests.aoInstructions]),));
513	asLines.append(' */');
514	asLines += oTests.asLines;
515	asLines += [
516	'};',
517	'',
518	];
519
520
521	#/** The test data that BS3CG1INSTR.
522	# * In order to simplify generating these, we use a byte array. */
523	#extern const uint8_t BS3_FAR_DATA g_abBs3Cg1Tests[];
524
525
526	oOut.write('\n'.join(asLines));
527	return True;
528
529
530	def usage(self):
531	""" Prints usage. """
532	print('usage: bs3-cpu-generated-1-data.py [output file\|-]');
533	return 0;
534
535	def main(self, asArgs):
536	"""
537	C-like main function.
538	Returns exit code.
539	"""
540
541	#
542	# Quick argument parsing.
543	#
544	if len(asArgs) == 1:
545	sOutFile = '-';
546	elif len(asArgs) != 2:
547	print('syntax error! Expected exactly one argument.');
548	return 2;
549	elif asArgs[1] in [ '-h', '-?', '--help' ]:
550	return self.usage();
551	else:
552	sOutFile = asArgs[1];
553
554	#
555	# Process the instructions specified in the IEM sources.
556	#
557	if self.processInstruction():
558
559	#
560	# Open the output file and generate the code.
561	#
562	if sOutFile == '-':
563	oOut = sys.stdout;
564	else:
565	try:
566	oOut = open(sOutFile, 'w');
567	except Exception as oXcpt:
568	print('error! Failed open "%s" for writing: %s' % (sOutFile, oXcpt,));
569	return 1;
570	if self.generateCode(oOut):
571	return 0;
572
573	return 1;
574
575
576	if __name__ == '__main__':
577	sys.exit(Bs3CpuGenerated1Generator().main(sys.argv));
578
579

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/ValidationKit/bootsectors/bs3-cpu-generated-1-data.py@ 66162

Download in other formats: