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