Makefile.kmk@ 105756

Last change on this file since 105756 was 105756, checked in by vboxsync, 5 months ago
Runtime/script: Add a simple lexer API to turn a stream of characters into tokens for a defined configuration, bugref:10394 [scm]
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 11.9 KB

Line
1	# $Id: Makefile.kmk 105756 2024-08-21 11:05:15Z vboxsync $
2	## @file
3	# Sub-Makefile for the VBox Disassembler.
4	#
5
6	#
7	# Copyright (C) 2006-2023 Oracle and/or its affiliates.
8	#
9	# This file is part of VirtualBox base platform packages, as
10	# available from https://www.virtualbox.org.
11	#
12	# This program is free software; you can redistribute it and/or
13	# modify it under the terms of the GNU General Public License
14	# as published by the Free Software Foundation, in version 3 of the
15	# License.
16	#
17	# This program is distributed in the hope that it will be useful, but
18	# WITHOUT ANY WARRANTY; without even the implied warranty of
19	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20	# General Public License for more details.
21	#
22	# You should have received a copy of the GNU General Public License
23	# along with this program; if not, see <https://www.gnu.org/licenses>.
24	#
25	# SPDX-License-Identifier: GPL-3.0-only
26	#
27
28	SUB_DEPTH = ../../../..
29	include $(KBUILD_PATH)/subheader.kmk
30	ifdef VBOX_WITH_TESTCASES
31
32
33	if1of ($(KBUILD_TARGET_ARCH), amd64 x86)
34	PROGRAMS += tstDisasm-1
35	tstDisasm-1_TEMPLATE = VBoxR3TstExe
36	tstDisasm-1_DEFS = IN_DIS
37	tstDisasm-1_SOURCES = \
38	tstDisasm-1.cpp \
39	tstDisasm-1A.asm
40	tstDisasm-1_LIBS = \
41	$(PATH_STAGE_LIB)/DisasmR3$(VBOX_SUFF_LIB) \
42	$(LIB_RUNTIME)
43
44	PROGRAMS += tstDisasmCore-1
45	tstDisasmCore-1_EXTENDS = tstDisasm-1
46	tstDisasmCore-1_DEFS = IN_DIS DIS_CORE_ONLY
47	tstDisasmCore-1_LIBS = \
48	$(PATH_STAGE_LIB)/DisasmCoreR3$(VBOX_SUFF_LIB) \
49	$(LIB_RUNTIME)
50	endif
51
52
53	PROGRAMS += tstDisasm-2
54	tstDisasm-2_TEMPLATE = VBoxR3TstExe
55	tstDisasm-2_DEFS = IN_DIS
56	tstDisasm-2_SOURCES = \
57	tstDisasm-2.cpp
58	tstDisasm-2_LIBS = \
59	$(PATH_STAGE_LIB)/DisasmR3$(VBOX_SUFF_LIB) \
60	$(LIB_RUNTIME)
61
62
63	ifeq ($(KBUILD_TARGET_ARCH),arm64)
64	#
65	# tstDisasmArmv8-1 assembly files -> .cpp
66	#
67	TST_DISASM_ARMV8_1_FILE = $(tstDisasmArmv8-1_0_OUTDIR)/tstDisasmArmv8-1-asm.cpp
68	TST_DISASM_ARMV8_1_SOURCES := \
69	tstDisasmArmv8_1=tstDisasmArmv8-1-asm.S
70
71	TST_DISASM_ARMV8_1_NAMES := $(foreach cert,$(VBOX_SVC_CERTS),$(firstword $(subst =,$(SP),$(cert))))
72	TST_DISASM_ARMV8_1_PATH_SOURCES := $(PATH_SUB_CURRENT)
73
74	$$(TST_DISASM_ARMV8_1_FILE): $(MAKEFILE_CURRENT) \
75	$(foreach source,$(TST_DISASM_ARMV8_1_SOURCES),$(TST_DISASM_ARMV8_1_PATH_SOURCES)/$(lastword $(subst =,$(SP),$(source)))) \
76	$(VBOX_BIN2C) \
77	\| $$(dir $$@)
78	$(QUIET)$(RM) -f -- $@
79	$(QUIET)$(APPEND) -n "$@" \
80	'' \
81	'#include "tstDisasmArmv8-1-tests.h"' \
82	''
83	$(foreach source,$(TST_DISASM_ARMV8_1_SOURCES), $(NLTAB)$(VBOX_BIN2C) -ascii --append \
84	"$(firstword $(subst =,$(SP),$(source)))" \
85	"$(TST_DISASM_ARMV8_1_PATH_SOURCES)/$(lastword $(subst =,$(SP),$(source)))" \
86	"$@")
87
88	OTHER_CLEAN += $(TST_DISASM_ARMV8_1_FILE)
89
90	PROGRAMS += tstDisasmArmv8-1
91	tstDisasmArmv8-1_TEMPLATE = VBoxR3TstExe
92	tstDisasmArmv8-1_DEFS = IN_DIS
93	tstDisasmArmv8-1_INCS = \
94	.
95	tstDisasmArmv8-1_SOURCES = \
96	$(TST_DISASM_ARMV8_1_FILE) \
97	tstDisasmArmv8-1-asm.S \
98	tstDisasmArmv8-1.cpp
99	tstDisasmArmv8-1_LIBS = \
100	$(PATH_STAGE_LIB)/DisasmR3$(VBOX_SUFF_LIB) \
101	$(LIB_RUNTIME)
102	endif
103
104	# Tests that will be build, disassembled and re-build from disassembly.
105	VBOX_DISAS_TESTS_BUILD = \
106	tstAsmFnstsw-1.asm \
107	tstAsmLock-1.asm \
108	tstAsmMovFixedReg-1.asm \
109	tstAsmMovSeg-1.asm \
110	tstAsmMovzx-1.asm \
111	tstAsmPop-1.asm \
112	tstAsmPush-1.asm \
113	tstAsmSignExtend-1.asm \
114	tstAsmRegs-1.asm \
115	tstAsm3DNow-1.asm
116
117	# Tests that only contains invalid/undefined instructions.
118	VBOX_DISAS_TESTS_INVALID = \
119	tstAsmLock-2.asm \
120	tstAsmLock-3.asm
121
122	# Tests that will be disassembled and re-build from disassembly (list of binaries).
123	## @todo tstBinMovzx-1.bin: does C7 imply 32-bit reg in 16-bit mode, or what exactly does it do?
124	VBOX_DISAS_TESTS_BINARIES := \
125	tstBinMovzx-1.bin \
126	tstBinFnstsw-1.bin
127	ifeq ($(USER)x,bird)
128	VBOX_DISAS_TESTS_BINARIES += \
129	tstBin-1.bin \
130	tstBin-2.bin \
131	tstBin-3.bin \
132	tstBin-4.bin \
133	tstBin-5.bin \
134	tstBin-6.bin
135	# $(PATH_STAGE_BIN)/testcase/tstDisasm-2$(SUFF_EXEC)
136	endif
137	VBOX_DISAS_TESTS_BINARIES_NOT_16BIT := \
138	tstBinFnstsw-1.bin
139	VBOX_DISAS_TESTS_BINARIES_NOT_32BIT :=
140	VBOX_DISAS_TESTS_BINARIES_NOT_64BIT :=
141
142
143	#
144	# The gory bits...
145	#
146
147	# Where we put the output files from the testcases.
148	VBOX_DISAS_TEST_OUT_DIR := $(PATH_TARGET)/Disassembler/testcase
149	BLDDIRS += $(VBOX_DISAS_TEST_OUT_DIR)
150
151	# Generate the rules for creating the .bin files.
152	VBOX_DISAS_TESTS_BIN = $(VBOX_DISAS_TESTS_BUILD) $(VBOX_DISAS_TESTS_INVALID)
153	VBOX_DISAS_TEST_CLEAN += $(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, \
154	$(VBOX_DISAS_TESTS_BIN:.asm=-16.bin) \
155	$(VBOX_DISAS_TESTS_BIN:.asm=-32.bin) \
156	$(VBOX_DISAS_TESTS_BIN:.asm=-64.bin))
157
158	$(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, $(VBOX_DISAS_TESTS_BIN:.asm=-16.bin)): $(PATH_SUB_CURRENT)/$$(patsubst %-16.bin,%.asm,$$(notdir $$(@))) \| $$(dir $$@)
159	@$(ECHO) "Assembling: $(<F) into $(@F)"
160	$(TOOL_YASM_AS) -f bin -a x86 --force-strict -DTEST_BITS=16 -o $@ $<
161
162	$(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, $(VBOX_DISAS_TESTS_BIN:.asm=-32.bin)): $(PATH_SUB_CURRENT)/$$(patsubst %-32.bin,%.asm,$$(notdir $$(@))) \| $$(dir $$@)
163	@$(ECHO) "Assembling: $(<F) into $(@F)"
164	$(TOOL_YASM_AS) -f bin -a x86 --force-strict -DTEST_BITS=32 -o $@ $<
165
166	$(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, $(VBOX_DISAS_TESTS_BIN:.asm=-64.bin)): $(PATH_SUB_CURRENT)/$$(patsubst %-64.bin,%.asm,$$(notdir $$(@))) \| $$(dir $$@)
167	@$(ECHO) "Assembling: $(<F) into $(@F)"
168	$(TOOL_YASM_AS) -f bin -a x86 --force-strict -DTEST_BITS=64 -o $@ $<
169
170
171	# Generate the rules for the 'build' tests.
172	VBOX_DISAS_TEST_CLEAN += $(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, \
173	$(VBOX_DISAS_TESTS_BUILD:.asm=-16-disas.asm) \
174	$(VBOX_DISAS_TESTS_BUILD:.asm=-32-disas.asm) \
175	$(VBOX_DISAS_TESTS_BUILD:.asm=-64-disas.asm))
176
177	$(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, $(VBOX_DISAS_TESTS_BUILD:.asm=-16-disas.asm)): $$(subst -disas.asm,.bin,$$@) $$(tstDisasm-2_1_STAGE_TARGET) \| $$(dir $$@)
178	@$(ECHO) "Generating: $(@F) from $(<F)"
179	$(REDIRECT) -E VBOX_LOG_DEST=nofile -o $@ -- $(tstDisasm-2_1_STAGE_TARGET) --style=yasm --cpumode=16 $<
180
181	$(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, $(VBOX_DISAS_TESTS_BUILD:.asm=-32-disas.asm)): $$(subst -disas.asm,.bin,$$@) $$(tstDisasm-2_1_STAGE_TARGET) \| $$(dir $$@)
182	@$(ECHO) "Generating: $(@F) from $(<F)"
183	$(REDIRECT) -E VBOX_LOG_DEST=nofile -o $@ -- $(tstDisasm-2_1_STAGE_TARGET) --style=yasm --cpumode=32 $<
184
185	$(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, $(VBOX_DISAS_TESTS_BUILD:.asm=-64-disas.asm)): $$(subst -disas.asm,.bin,$$@) $$(tstDisasm-2_1_STAGE_TARGET) \| $$(dir $$@)
186	@$(ECHO) "Generating: $(@F) from $(<F)"
187	$(REDIRECT) -E VBOX_LOG_DEST=nofile -o $@ -- $(tstDisasm-2_1_STAGE_TARGET) --style=yasm --cpumode=64 $<
188
189
190	VBOX_DISAS_TEST_CLEAN += $(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, \
191	$(VBOX_DISAS_TESTS_BUILD:.asm=-16-disas.bin) \
192	$(VBOX_DISAS_TESTS_BUILD:.asm=-32-disas.bin) \
193	$(VBOX_DISAS_TESTS_BUILD:.asm=-64-disas.bin))
194
195	$(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, $(VBOX_DISAS_TESTS_BUILD:.asm=-16-disas.bin)): $$(subst .bin,.asm,$$@) \| $$(dir $$@)
196	@$(ECHO) "Re-assembling: $(<F) into $(@F)"
197	$(TOOL_YASM_AS) -f bin -a x86 --force-strict -DTEST_BITS=16 -o $@ $<
198
199	$(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, $(VBOX_DISAS_TESTS_BUILD:.asm=-32-disas.bin)): $$(subst .bin,.asm,$$@) \| $$(dir $$@)
200	@$(ECHO) "Re-assembling: $(<F) into $(@F)"
201	$(TOOL_YASM_AS) -f bin -a x86 --force-strict -DTEST_BITS=32 -o $@ $<
202
203	$(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, $(VBOX_DISAS_TESTS_BUILD:.asm=-64-disas.bin)): $$(subst .bin,.asm,$$@) \| $$(dir $$@)
204	@$(ECHO) "Re-assembling: $(<F) into $(@F)"
205	$(TOOL_YASM_AS) -f bin -a x86 --force-strict -DTEST_BITS=64 -o $@ $<
206
207
208	VBOX_DISAS_TESTS += $(foreach test, $(VBOX_DISAS_TESTS_BUILD:.asm=), $(test)-16.tst $(test)-32.tst $(test)-64.tst)
209	$(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, \
210	$(VBOX_DISAS_TESTS_BUILD:.asm=-16.tst) \
211	$(VBOX_DISAS_TESTS_BUILD:.asm=-32.tst) \
212	$(VBOX_DISAS_TESTS_BUILD:.asm=-64.tst) ): $$(subst .tst,-disas.bin,$$@) \| $$(dir $$@)
213	@$(ECHO) "Verifying build: $(<F) and $(@F:.tst=.bin)"
214	@$(RM) -f $@
215	$(CMP) $(@:.tst=.bin) $<
216	@$(APPEND) $@ "done"
217	@$(ECHO) " PASSED: $(<F) [re-assembled]"
218
219
220
221	# Generate the rules for the 'invalid' tests.
222	VBOX_DISAS_TESTS += $(foreach test, $(VBOX_DISAS_TESTS_INVALID:.asm=), $(test)-16.tst $(test)-32.tst $(test)-64.tst)
223
224	$(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, $(VBOX_DISAS_TESTS_INVALID:.asm=-16.tst)): $$(patsubst %.tst,%.bin,$$@) $$(tstDisasm-2_1_STAGE_TARGET) \| $$(dir $$@)
225	@$(ECHO) "TESTING: $(@F) [--undef-op=all]"
226	@$(RM) -f $@
227	$(REDIRECT) -E VBOX_LOG_DEST=nofile -- $(tstDisasm-2_1_STAGE_TARGET) --undef-op=all --cpumode=16 $<
228	@$(APPEND) $@ "done"
229	@$(ECHO) " PASSED: $(@F) [--undef-op=all]"
230
231	$(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, $(VBOX_DISAS_TESTS_INVALID:.asm=-32.tst)): $$(patsubst %.tst,%.bin,$$@) $$(tstDisasm-2_1_STAGE_TARGET) \| $$(dir $$@)
232	@$(ECHO) "TESTING: $(@F) [--undef-op=all]"
233	@$(RM) -f $@
234	$(REDIRECT) -E VBOX_LOG_DEST=nofile -- $(tstDisasm-2_1_STAGE_TARGET) --undef-op=all --cpumode=32 $<
235	@$(APPEND) $@ "done"
236	@$(ECHO) " PASSED: $(@F) [--undef-op=all]"
237
238	$(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, $(VBOX_DISAS_TESTS_INVALID:.asm=-64.tst)): $$(patsubst %.tst,%.bin,$$@) $$(tstDisasm-2_1_STAGE_TARGET) \| $$(dir $$@)
239	@$(ECHO) "TESTING: $(@F) [--undef-op=all]"
240	@$(RM) -f $@
241	$(REDIRECT) -E VBOX_LOG_DEST=nofile -- $(tstDisasm-2_1_STAGE_TARGET) --undef-op=all --cpumode=64 $<
242	@$(APPEND) $@ "done"
243	@$(ECHO) " PASSED: $(@F) [--undef-op=all]"
244
245
246	# Generate the rules for the binary tests.
247	define def_vbox_disas_binary_rules
248	$(outbase).asm: $(full_binary) $$$$(tstDisasm-2_1_STAGE_TARGET) \| $(VBOX_DISAS_TEST_OUT_DIR)/
249	@$$(ECHO) "Generating: $$(@F) from $$(<F)"
250	$$(REDIRECT) -E VBOX_LOG_DEST=nofile -o $$@ -- $$(tstDisasm-2_1_STAGE_TARGET) --style=yasm --cpumode=$(bits) --undef-op=db $$<
251
252	$(outbase).bin + $(outbase).lst: $(outbase).asm
253	@$$(ECHO) "Re-assembling: $$(<F) into $$(@F)"
254	$$(TOOL_YASM_AS) -f bin -a x86 --force-strict -l $(outbase).lst -o $$@ $$<
255
256	$(outbase).tst: $(outbase).bin
257	@$$(ECHO) "Verifying build: $$(<F) against $(not-dir $(full_binary))"
258	@$$(RM) -f $$@
259	$$(CMP) -l $(full_binary) $$<
260	@$$(APPEND) $$@ "done"
261	@$$(ECHO) " PASSED: $$(<F) [binary]"
262
263	$(name).tst:: $(outbase).tst
264	VBOX_DISAS_TEST_CLEAN += $(outbase).tst $(outbase).bin $(outbase).asm
265	VBOX_DISAS_TESTS += $(name)-rebuild-$(bits).tst
266	endef # def_vbox_disas_binary_rules
267
268	define def_vbox_disas_binary
269	local name := $(notdir $(basename $(binary)))
270	local full_binary := $(abspathex $(binary),$(PATH_SUB_CURRENT))
271	local outbase := $(VBOX_DISAS_TEST_OUT_DIR)/$(name)-rebuild-$(bits)
272	$(eval $(def_vbox_disas_binary_rules))
273	endef # def_vbox_disas_binary
274
275	## @todo 64-bit is problematic because of bugs like POP RDI ending up as POP EDI (incorrect default opmode).
276	#$(foreach bits, 64, $(foreach binary, $(VBOX_DISAS_TESTS_BINARIES), $(evalvalctx def_vbox_disas_binary)))
277	$(foreach bits, 32 16, $(foreach binary, $(filter-out $(VBOX_DISAS_TESTS_BINARIES_NOT_$(bits)BIT), $(VBOX_DISAS_TESTS_BINARIES)) \
278	, $(evalvalctx def_vbox_disas_binary)))
279
280
281	# Add the .tst to the clean up.
282	VBOX_DISAS_TEST_CLEAN += $(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/, $(VBOX_DISAS_TESTS))
283	OTHER_CLEAN += $(VBOX_DISAS_TEST_CLEAN)
284
285
286	#
287	# Add the tests to the target list for the testing pass.
288	# (kBuild r1646)
289	#
290	TESTING += $(addprefix $(VBOX_DISAS_TEST_OUT_DIR)/,$(VBOX_DISAS_TESTS))
291
292
293	#
294	# The test aliases
295	#
296	# To run the tstAsmLock-3.asm test: kmk tstAsmLock-3.tst
297	# To run the 64-bit tstAsmLock-3.asm test: kmk tstAsmLock-3-64.tst
298	#
299	define def_vbox_test_aliases
300	local test_base := $(basename $(test))
301	local test_root := $(patsubst %-16,%,$(patsubst %-32,%,$(patsubst %-64,%,$(test_base))))
302	$(test_base).tst:: $(VBOX_DISAS_TEST_OUT_DIR)/$(test)
303	$(test_root).tst:: $(test_base).tst
304	$(test_base).o:: $(test_base).tst
305	$(test_base).obj:: $(test_base).tst
306	$(test_root).o:: $(test_root).tst
307	$(test_root).obj:: $(test_root).tst
308	endef
309	$(foreach test,$(VBOX_DISAS_TESTS),$(evalvalctx def_vbox_test_aliases))
310
311	endif # VBOX_WITH_TESTCASES
312	include $(FILE_KBUILD_SUB_FOOTER)
313

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

Download in other formats:

Original Format