1# SPDX-License-Identifier: GPL-2.0
2# Makefile for nolibc tests
3# we're in ".../tools/testing/selftests/nolibc"
4ifeq ($(srctree),)
5srctree := $(patsubst %/tools/testing/selftests/,%,$(dir $(CURDIR)))
6endif
7
8include $(srctree)/tools/scripts/utilities.mak
9# We need this for the "__cc-option" macro.
10include $(srctree)/scripts/Makefile.compiler
11
12ifneq ($(O),)
13ifneq ($(call is-absolute,$(O)),y)
14$(error Only absolute O= parameters are supported)
15endif
16objtree := $(O)
17else
18objtree ?= $(srctree)
19endif
20
21ifeq ($(ARCH),)
22include $(srctree)/scripts/subarch.include
23ARCH = $(SUBARCH)
24endif
25
26cc-option = $(call __cc-option, $(CC),$(CLANG_CROSS_FLAGS),$(1),$(2))
27
28# XARCH extends the kernel's ARCH with a few variants of the same
29# architecture that only differ by the configuration, the toolchain
30# and the Qemu program used. It is copied as-is into ARCH except for
31# a few specific values which are mapped like this:
32#
33#  XARCH        | ARCH      | config
34#  -------------|-----------|-------------------------
35#  ppc          | powerpc   | 32 bits
36#  ppc64        | powerpc   | 64 bits big endian
37#  ppc64le      | powerpc   | 64 bits little endian
38#
39# It is recommended to only use XARCH, though it does not harm if
40# ARCH is already set. For simplicity, ARCH is sufficient for all
41# architectures where both are equal.
42
43# configure default variants for target kernel supported architectures
44XARCH_powerpc    = ppc
45XARCH_mips       = mips32le
46XARCH_riscv      = riscv64
47XARCH            = $(or $(XARCH_$(ARCH)),$(ARCH))
48
49# map from user input variants to their kernel supported architectures
50ARCH_ppc         = powerpc
51ARCH_ppc64       = powerpc
52ARCH_ppc64le     = powerpc
53ARCH_mips32le    = mips
54ARCH_mips32be    = mips
55ARCH_riscv32     = riscv
56ARCH_riscv64     = riscv
57ARCH            := $(or $(ARCH_$(XARCH)),$(XARCH))
58
59# kernel image names by architecture
60IMAGE_i386       = arch/x86/boot/bzImage
61IMAGE_x86_64     = arch/x86/boot/bzImage
62IMAGE_x86        = arch/x86/boot/bzImage
63IMAGE_arm64      = arch/arm64/boot/Image
64IMAGE_arm        = arch/arm/boot/zImage
65IMAGE_mips32le   = vmlinuz
66IMAGE_mips32be   = vmlinuz
67IMAGE_ppc        = vmlinux
68IMAGE_ppc64      = vmlinux
69IMAGE_ppc64le    = arch/powerpc/boot/zImage
70IMAGE_riscv      = arch/riscv/boot/Image
71IMAGE_riscv32    = arch/riscv/boot/Image
72IMAGE_riscv64    = arch/riscv/boot/Image
73IMAGE_s390       = arch/s390/boot/bzImage
74IMAGE_loongarch  = arch/loongarch/boot/vmlinuz.efi
75IMAGE            = $(objtree)/$(IMAGE_$(XARCH))
76IMAGE_NAME       = $(notdir $(IMAGE))
77
78# default kernel configurations that appear to be usable
79DEFCONFIG_i386       = defconfig
80DEFCONFIG_x86_64     = defconfig
81DEFCONFIG_x86        = defconfig
82DEFCONFIG_arm64      = defconfig
83DEFCONFIG_arm        = multi_v7_defconfig
84DEFCONFIG_mips32le   = malta_defconfig
85DEFCONFIG_mips32be   = malta_defconfig generic/eb.config
86DEFCONFIG_ppc        = pmac32_defconfig
87DEFCONFIG_ppc64      = powernv_be_defconfig
88DEFCONFIG_ppc64le    = powernv_defconfig
89DEFCONFIG_riscv      = defconfig
90DEFCONFIG_riscv32    = rv32_defconfig
91DEFCONFIG_riscv64    = defconfig
92DEFCONFIG_s390       = defconfig
93DEFCONFIG_loongarch  = defconfig
94DEFCONFIG            = $(DEFCONFIG_$(XARCH))
95
96EXTRACONFIG           = $(EXTRACONFIG_$(XARCH))
97
98# optional tests to run (default = all)
99TEST =
100
101# QEMU_ARCH: arch names used by qemu
102QEMU_ARCH_i386       = i386
103QEMU_ARCH_x86_64     = x86_64
104QEMU_ARCH_x86        = x86_64
105QEMU_ARCH_arm64      = aarch64
106QEMU_ARCH_arm        = arm
107QEMU_ARCH_mips32le   = mipsel  # works with malta_defconfig
108QEMU_ARCH_mips32be  = mips
109QEMU_ARCH_ppc        = ppc
110QEMU_ARCH_ppc64      = ppc64
111QEMU_ARCH_ppc64le    = ppc64
112QEMU_ARCH_riscv      = riscv64
113QEMU_ARCH_riscv32    = riscv32
114QEMU_ARCH_riscv64    = riscv64
115QEMU_ARCH_s390       = s390x
116QEMU_ARCH_loongarch  = loongarch64
117QEMU_ARCH            = $(QEMU_ARCH_$(XARCH))
118
119QEMU_ARCH_USER_ppc64le = ppc64le
120QEMU_ARCH_USER         = $(or $(QEMU_ARCH_USER_$(XARCH)),$(QEMU_ARCH_$(XARCH)))
121
122QEMU_BIOS_DIR = /usr/share/edk2/
123QEMU_BIOS_loongarch = $(QEMU_BIOS_DIR)/loongarch64/OVMF_CODE.fd
124
125ifneq ($(QEMU_BIOS_$(XARCH)),)
126QEMU_ARGS_BIOS = -bios $(QEMU_BIOS_$(XARCH))
127endif
128
129# QEMU_ARGS : some arch-specific args to pass to qemu
130QEMU_ARGS_i386       = -M pc -append "console=ttyS0,9600 i8042.noaux panic=-1 $(TEST:%=NOLIBC_TEST=%)"
131QEMU_ARGS_x86_64     = -M pc -append "console=ttyS0,9600 i8042.noaux panic=-1 $(TEST:%=NOLIBC_TEST=%)"
132QEMU_ARGS_x86        = -M pc -append "console=ttyS0,9600 i8042.noaux panic=-1 $(TEST:%=NOLIBC_TEST=%)"
133QEMU_ARGS_arm64      = -M virt -cpu cortex-a53 -append "panic=-1 $(TEST:%=NOLIBC_TEST=%)"
134QEMU_ARGS_arm        = -M virt -append "panic=-1 $(TEST:%=NOLIBC_TEST=%)"
135QEMU_ARGS_mips32le   = -M malta -append "panic=-1 $(TEST:%=NOLIBC_TEST=%)"
136QEMU_ARGS_mips32be   = -M malta -append "panic=-1 $(TEST:%=NOLIBC_TEST=%)"
137QEMU_ARGS_ppc        = -M g3beige -append "console=ttyS0 panic=-1 $(TEST:%=NOLIBC_TEST=%)"
138QEMU_ARGS_ppc64      = -M powernv -append "console=hvc0 panic=-1 $(TEST:%=NOLIBC_TEST=%)"
139QEMU_ARGS_ppc64le    = -M powernv -append "console=hvc0 panic=-1 $(TEST:%=NOLIBC_TEST=%)"
140QEMU_ARGS_riscv      = -M virt -append "console=ttyS0 panic=-1 $(TEST:%=NOLIBC_TEST=%)"
141QEMU_ARGS_riscv32    = -M virt -append "console=ttyS0 panic=-1 $(TEST:%=NOLIBC_TEST=%)"
142QEMU_ARGS_riscv64    = -M virt -append "console=ttyS0 panic=-1 $(TEST:%=NOLIBC_TEST=%)"
143QEMU_ARGS_s390       = -M s390-ccw-virtio -append "console=ttyS0 panic=-1 $(TEST:%=NOLIBC_TEST=%)"
144QEMU_ARGS_loongarch  = -M virt -append "console=ttyS0,115200 panic=-1 $(TEST:%=NOLIBC_TEST=%)"
145QEMU_ARGS            = -m 1G $(QEMU_ARGS_$(XARCH)) $(QEMU_ARGS_BIOS) $(QEMU_ARGS_EXTRA)
146
147# OUTPUT is only set when run from the main makefile, otherwise
148# it defaults to this nolibc directory.
149OUTPUT ?= $(CURDIR)/
150
151ifeq ($(V),1)
152Q=
153else
154Q=@
155endif
156
157CFLAGS_i386 = $(call cc-option,-m32)
158CFLAGS_ppc = -m32 -mbig-endian -mno-vsx $(call cc-option,-mmultiple)
159CFLAGS_ppc64 = -m64 -mbig-endian -mno-vsx $(call cc-option,-mmultiple)
160CFLAGS_ppc64le = -m64 -mlittle-endian -mno-vsx $(call cc-option,-mabi=elfv2)
161CFLAGS_s390 = -m64
162CFLAGS_mips32le = -EL -mabi=32 -fPIC
163CFLAGS_mips32be = -EB -mabi=32
164CFLAGS_STACKPROTECTOR ?= $(call cc-option,-mstack-protector-guard=global $(call cc-option,-fstack-protector-all))
165CFLAGS  ?= -Os -fno-ident -fno-asynchronous-unwind-tables -std=c89 -W -Wall -Wextra \
166		$(call cc-option,-fno-stack-protector) $(call cc-option,-Wmissing-prototypes) \
167		$(CFLAGS_$(XARCH)) $(CFLAGS_STACKPROTECTOR) $(CFLAGS_EXTRA)
168LDFLAGS :=
169
170LIBGCC := -lgcc
171
172ifneq ($(LLVM),)
173# Not needed for clang
174LIBGCC :=
175endif
176
177# Modify CFLAGS based on LLVM=
178include $(srctree)/tools/scripts/Makefile.include
179
180# GCC uses "s390", clang "systemz"
181CLANG_CROSS_FLAGS := $(subst --target=s390-linux,--target=systemz-linux,$(CLANG_CROSS_FLAGS))
182
183REPORT  ?= awk '/\[OK\][\r]*$$/{p++} /\[FAIL\][\r]*$$/{if (!f) printf("\n"); f++; print;} /\[SKIPPED\][\r]*$$/{s++} \
184		END{ printf("\n%3d test(s): %3d passed, %3d skipped, %3d failed => status: ", p+s+f, p, s, f); \
185		if (f || !p) printf("failure\n"); else if (s) printf("warning\n"); else printf("success\n");; \
186		printf("\nSee all results in %s\n", ARGV[1]); }'
187
188help:
189	@echo "Supported targets under selftests/nolibc:"
190	@echo "  all               call the \"run\" target below"
191	@echo "  help              this help"
192	@echo "  sysroot           create the nolibc sysroot here (uses \$$ARCH)"
193	@echo "  nolibc-test       build the executable (uses \$$CC and \$$CROSS_COMPILE)"
194	@echo "  libc-test         build an executable using the compiler's default libc instead"
195	@echo "  run-user          runs the executable under QEMU (uses \$$XARCH, \$$TEST)"
196	@echo "  initramfs.cpio    prepare the initramfs archive with nolibc-test"
197	@echo "  initramfs         prepare the initramfs tree with nolibc-test"
198	@echo "  defconfig         create a fresh new default config (uses \$$XARCH)"
199	@echo "  kernel            (re)build the kernel (uses \$$XARCH)"
200	@echo "  kernel-standalone (re)build the kernel with the initramfs (uses \$$XARCH)"
201	@echo "  run               runs the kernel in QEMU after building it (uses \$$XARCH, \$$TEST)"
202	@echo "  rerun             runs a previously prebuilt kernel in QEMU (uses \$$XARCH, \$$TEST)"
203	@echo "  clean             clean the sysroot, initramfs, build and output files"
204	@echo ""
205	@echo "The output file is \"run.out\". Test ranges may be passed using \$$TEST."
206	@echo ""
207	@echo "Currently using the following variables:"
208	@echo "  ARCH          = $(ARCH)"
209	@echo "  XARCH         = $(XARCH)"
210	@echo "  CROSS_COMPILE = $(CROSS_COMPILE)"
211	@echo "  CC            = $(CC)"
212	@echo "  OUTPUT        = $(OUTPUT)"
213	@echo "  TEST          = $(TEST)"
214	@echo "  QEMU_ARCH     = $(if $(QEMU_ARCH),$(QEMU_ARCH),UNKNOWN_ARCH) [determined from \$$XARCH]"
215	@echo "  IMAGE_NAME    = $(if $(IMAGE_NAME),$(IMAGE_NAME),UNKNOWN_ARCH) [determined from \$$XARCH]"
216	@echo ""
217
218all: run
219
220sysroot: sysroot/$(ARCH)/include
221
222sysroot/$(ARCH)/include: | defconfig
223	$(Q)rm -rf sysroot/$(ARCH) sysroot/sysroot
224	$(QUIET_MKDIR)mkdir -p sysroot
225	$(Q)$(MAKE) -C $(srctree) outputmakefile
226	$(Q)$(MAKE) -C $(srctree)/tools/include/nolibc ARCH=$(ARCH) OUTPUT=$(CURDIR)/sysroot/ headers_standalone
227	$(Q)mv sysroot/sysroot sysroot/$(ARCH)
228
229ifneq ($(NOLIBC_SYSROOT),0)
230nolibc-test: nolibc-test.c nolibc-test-linkage.c sysroot/$(ARCH)/include
231	$(QUIET_CC)$(CC) $(CFLAGS) $(LDFLAGS) -o $@ \
232	  -nostdlib -nostdinc -static -Isysroot/$(ARCH)/include nolibc-test.c nolibc-test-linkage.c $(LIBGCC)
233else
234nolibc-test: nolibc-test.c nolibc-test-linkage.c
235	$(QUIET_CC)$(CC) $(CFLAGS) $(LDFLAGS) -o $@ \
236	  -nostdlib -static -include $(srctree)/tools/include/nolibc/nolibc.h nolibc-test.c nolibc-test-linkage.c $(LIBGCC)
237endif
238
239libc-test: nolibc-test.c nolibc-test-linkage.c
240	$(QUIET_CC)$(HOSTCC) -o $@ nolibc-test.c nolibc-test-linkage.c
241
242# local libc-test
243run-libc-test: libc-test
244	$(Q)./libc-test > "$(CURDIR)/run.out" || :
245	$(Q)$(REPORT) $(CURDIR)/run.out
246
247# local nolibc-test
248run-nolibc-test: nolibc-test
249	$(Q)./nolibc-test > "$(CURDIR)/run.out" || :
250	$(Q)$(REPORT) $(CURDIR)/run.out
251
252# qemu user-land test
253run-user: nolibc-test
254	$(Q)qemu-$(QEMU_ARCH_USER) ./nolibc-test > "$(CURDIR)/run.out" || :
255	$(Q)$(REPORT) $(CURDIR)/run.out
256
257initramfs.cpio: kernel nolibc-test
258	$(QUIET_GEN)echo 'file /init nolibc-test 755 0 0' | $(objtree)/usr/gen_init_cpio - > initramfs.cpio
259
260initramfs: nolibc-test
261	$(QUIET_MKDIR)mkdir -p initramfs
262	$(call QUIET_INSTALL, initramfs/init)
263	$(Q)cp nolibc-test initramfs/init
264
265defconfig:
266	$(Q)$(MAKE) -C $(srctree) ARCH=$(ARCH) CC=$(CC) CROSS_COMPILE=$(CROSS_COMPILE) $(DEFCONFIG)
267	$(Q)if [ -n "$(EXTRACONFIG)" ]; then \
268		$(srctree)/scripts/config --file $(objtree)/.config $(EXTRACONFIG); \
269		$(MAKE) -C $(srctree) ARCH=$(ARCH) CC=$(CC) CROSS_COMPILE=$(CROSS_COMPILE) olddefconfig < /dev/null; \
270	fi
271
272kernel: | defconfig
273	$(Q)$(MAKE) -C $(srctree) ARCH=$(ARCH) CC=$(CC) CROSS_COMPILE=$(CROSS_COMPILE) $(IMAGE_NAME) < /dev/null
274
275kernel-standalone: initramfs | defconfig
276	$(Q)$(MAKE) -C $(srctree) ARCH=$(ARCH) CC=$(CC) CROSS_COMPILE=$(CROSS_COMPILE) $(IMAGE_NAME) CONFIG_INITRAMFS_SOURCE=$(CURDIR)/initramfs < /dev/null
277
278# run the tests after building the kernel
279run: kernel initramfs.cpio
280	$(Q)qemu-system-$(QEMU_ARCH) -display none -no-reboot -kernel "$(IMAGE)" -initrd initramfs.cpio -serial stdio $(QEMU_ARGS) > "$(CURDIR)/run.out"
281	$(Q)$(REPORT) $(CURDIR)/run.out
282
283# re-run the tests from an existing kernel
284rerun:
285	$(Q)qemu-system-$(QEMU_ARCH) -display none -no-reboot -kernel "$(IMAGE)" -initrd initramfs.cpio -serial stdio $(QEMU_ARGS) > "$(CURDIR)/run.out"
286	$(Q)$(REPORT) $(CURDIR)/run.out
287
288# report with existing test log
289report:
290	$(Q)$(REPORT) $(CURDIR)/run.out
291
292clean:
293	$(call QUIET_CLEAN, sysroot)
294	$(Q)rm -rf sysroot
295	$(call QUIET_CLEAN, nolibc-test)
296	$(Q)rm -f nolibc-test
297	$(call QUIET_CLEAN, libc-test)
298	$(Q)rm -f libc-test
299	$(call QUIET_CLEAN, initramfs.cpio)
300	$(Q)rm -rf initramfs.cpio
301	$(call QUIET_CLEAN, initramfs)
302	$(Q)rm -rf initramfs
303	$(call QUIET_CLEAN, run.out)
304	$(Q)rm -rf run.out
305
306.PHONY: sysroot/$(ARCH)/include
307