Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 1 | # SPDX-License-Identifier: GPL-2.0-only |
| 2 | |
| 3 | # This file contains common definitions, macros and targets for depthcharge |
| 4 | # unit-tests and screenshot utility. It requires list of defined variables: |
| 5 | # - src - source directory |
| 6 | # - testobj - build directory of tests |
| 7 | # - objutil - utility programs/libraries output directory |
| 8 | |
| 9 | testsrc := $(top)/tests |
| 10 | |
| 11 | cmockasrc := 3rdparty/cmocka |
| 12 | cmockaobj := $(objutil)/cmocka |
| 13 | coverage_dir := coverage_reports |
| 14 | |
| 15 | CMOCKA_LIB := $(cmockaobj)/src/libcmocka.so |
| 16 | |
| 17 | CMAKE := cmake |
| 18 | OBJCOPY ?= objcopy |
| 19 | OBJDUMP ?= objdump |
| 20 | |
Jakub Czapiga | ab06861 | 2022-11-25 15:02:44 +0100 | [diff] [blame] | 21 | TEST_DEFAULT_CONFIG ?= $(top)/configs/config.emulation_qemu_x86_i440fx |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 22 | TEST_DOTCONFIG := $(testobj)/.config |
| 23 | TEST_KCONFIG_AUTOHEADER := $(testobj)/config.src.h |
| 24 | TEST_KCONFIG_AUTOCONFIG := $(testobj)/auto.conf |
| 25 | TEST_KCONFIG_DEPENDENCIES := $(testobj)/auto.conf.cmd |
| 26 | TEST_KCONFIG_SPLITCONFIG := $(testobj)/config/ |
| 27 | TEST_KCONFIG_TRISTATE := $(testobj)/tristate.conf |
| 28 | |
Bill XIE | 348909a | 2022-07-09 10:16:20 +0800 | [diff] [blame] | 29 | # Include order should be same as in real build |
Jakub Czapiga | e744ba6 | 2022-11-14 11:22:59 +0100 | [diff] [blame] | 30 | TEST_INCLUDES := -include $(src)/include/kconfig.h \ |
Bill XIE | 348909a | 2022-07-09 10:16:20 +0800 | [diff] [blame] | 31 | -include $(src)/include/rules.h \ |
| 32 | -include $(src)/commonlib/bsd/include/commonlib/bsd/compiler.h |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 33 | |
| 34 | # Include generic test mock headers, before original ones |
Jakub Czapiga | e744ba6 | 2022-11-14 11:22:59 +0100 | [diff] [blame] | 35 | TEST_INCLUDES += -I$(testsrc)/include/mocks -I$(testsrc)/include |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 36 | |
Jakub Czapiga | e744ba6 | 2022-11-14 11:22:59 +0100 | [diff] [blame] | 37 | TEST_INCLUDES += -I$(src) -I$(src)/include -I$(src)/commonlib/include \ |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 38 | -I$(src)/commonlib/bsd/include -I$(src)/arch/x86/include \ |
Felix Singer | 26e7c1e | 2023-11-16 13:50:50 +0000 | [diff] [blame] | 39 | -I$(top)/3rdparty/vboot/firmware/include |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 40 | |
Jakub Czapiga | e744ba6 | 2022-11-14 11:22:59 +0100 | [diff] [blame] | 41 | # Path for Kconfig autoheader |
| 42 | TEST_INCLUDES += -I$(dir $(TEST_KCONFIG_AUTOHEADER)) |
| 43 | |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 44 | # Note: This is intentionally just a subset of the warnings in the toplevel |
Martin Roth | ba3a719 | 2024-01-18 18:16:12 -0700 | [diff] [blame] | 45 | # Makefile.mk. We don't need to be as strict with test code, and things like |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 46 | # -Wmissing-prototypes just make working with the test framework cumbersome. |
| 47 | # Only put conservative warnings here that really detect code that's obviously |
| 48 | # unintentional. |
| 49 | TEST_CFLAGS += -Wall -Werror -Wundef -Wstrict-prototypes -Wno-inline-asm |
| 50 | TEST_CFLAGS += -Wno-unknown-warning-option -Wno-source-mgr -Wno-main-return-type |
Jakub Czapiga | 9007290 | 2022-09-08 16:38:50 +0200 | [diff] [blame] | 51 | TEST_CFLAGS += -Wno-array-compare -Wno-packed-not-aligned -Wno-trigraphs |
| 52 | TEST_CFLAGS += -Wno-unused-but-set-variables |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 53 | |
Julius Werner | f02e00a | 2024-03-06 15:22:56 -0800 | [diff] [blame] | 54 | TEST_CFLAGS += -std=gnu11 -ffunction-sections -fdata-sections -fno-builtin |
| 55 | |
| 56 | ifneq ($(filter-out 0,$(DEBUG)),) |
| 57 | TEST_CFLAGS += -Og -ggdb3 |
| 58 | else |
| 59 | TEST_CFLAGS += -Os |
| 60 | endif |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 61 | |
Maximilian Brune | b3e336c | 2023-09-16 19:49:39 +0200 | [diff] [blame^] | 62 | TEST_CFLAGS += -D__TEST__ -D__COREBOOT__ |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 63 | |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 64 | ifneq ($(filter-out 0,$(TEST_PRINT)),) |
| 65 | TEST_CFLAGS += -DTEST_PRINT=1 |
| 66 | endif |
| 67 | |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 68 | TEST_LDFLAGS += -Wl,--gc-sections |
| 69 | |
| 70 | # Some memlayout symbols don't work with userspace relocation -- disable it. |
| 71 | TEST_CFLAGS += -fno-pie -fno-pic |
| 72 | TEST_LDFLAGS += -no-pie |
| 73 | |
| 74 | # Extra attributes for unit tests, declared per test |
Jakub Czapiga | 3088e43 | 2022-12-08 11:50:47 +0100 | [diff] [blame] | 75 | # srcs - sources linked with coreboot libc symbols |
| 76 | # syssrcs - sources linked with system libc, no coreboot includes |
| 77 | # cflags - attribute with additional CFLAGS |
| 78 | # config - Kconfig and defines override (`gcc -D` style) |
| 79 | # mocks - list of symbols to mock |
| 80 | # no_test_framework - set to `1` not to link test framework |
| 81 | # stage - name of stage e.g. romstage, bootblock, etc. |
Jakub Czapiga | e744ba6 | 2022-11-14 11:22:59 +0100 | [diff] [blame] | 82 | attributes := srcs syssrcs cflags config mocks no_test_framework stage |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 83 | |
| 84 | # Copy attributes of one test to another. |
| 85 | # $1 - input test name |
| 86 | # $2 - output test name |
| 87 | copy-test = $(foreach attr,$(attributes), \ |
| 88 | $(eval $(strip $(2))-$(attr) := $($(strip $(1))-$(attr)))) |
| 89 | |
| 90 | # Create actual targets for unit test binaries |
| 91 | # $1 - test name |
| 92 | define TEST_CC_template |
| 93 | |
| 94 | # Generate custom config.h redefining given config symbols, and declaring mocked |
| 95 | # functions weak. It is important that the compiler already sees that they are |
| 96 | # weak (and they aren't just turned weak at a later stage) to prevent certain |
| 97 | # optimizations that would break if the function gets replaced. (For clang this |
| 98 | # file needs to be marked `system_header` to prevent it from warning about |
| 99 | # #pragma weak entries without a matching function declaration, since there's no |
| 100 | # -Wno-xxx command line option for that.) |
| 101 | $(1)-config-file := $(testobj)/$(1)/config.h |
| 102 | $$($(1)-config-file): $(TEST_KCONFIG_AUTOHEADER) |
| 103 | mkdir -p $$(dir $$@) |
Martin Roth | ba3a719 | 2024-01-18 18:16:12 -0700 | [diff] [blame] | 104 | printf '// File generated by tests/Makefile.mk\n// Do not change\n' > $$@ |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 105 | printf '#include <%s>\n\n' "$(notdir $(TEST_KCONFIG_AUTOHEADER))" >> $$@ |
| 106 | for kv in $$($(1)-config); do \ |
| 107 | key="`echo $$$$kv | cut -d '=' -f -1`"; \ |
| 108 | value="`echo $$$$kv | cut -d '=' -f 2-`"; \ |
| 109 | printf '#undef %s\n' "$$$$key" >> $$@; \ |
| 110 | printf '#define %s %s\n\n' "$$$$key" "$$$$value" >> $$@; \ |
| 111 | done |
| 112 | printf '#ifdef __clang__\n' >> $$@; |
| 113 | printf '#pragma clang system_header\n' >> $$@; |
| 114 | printf '#endif\n' >> $$@; |
| 115 | printf '#ifdef __TEST_SRCOBJ__\n' >> $$@; |
| 116 | for m in $$($(1)-mocks); do \ |
| 117 | printf '#pragma weak %s\n' "$$$$m" >> $$@; \ |
| 118 | done |
| 119 | printf '#endif\n' >> $$@; |
| 120 | |
| 121 | $($(1)-objs): TEST_CFLAGS += -I$$(dir $$($(1)-config-file)) \ |
| 122 | -D__$$(shell echo $$($(1)-stage) | tr '[:lower:]' '[:upper:]')__ \ |
| 123 | -D__TEST_NAME__=\"$(subst /,_,$(1))\" \ |
| 124 | -D__TEST_DATA_DIR__=\"$(testsrc)/data\" |
| 125 | |
| 126 | # Give us a way to distinguish between coreboot source files and test files in code. |
| 127 | $($(1)-srcobjs): TEST_CFLAGS += -D__TEST_SRCOBJ__ |
| 128 | |
Jakub Czapiga | e744ba6 | 2022-11-14 11:22:59 +0100 | [diff] [blame] | 129 | # Add coreboot, vboot, kconfig etc. includes only to non-system libc linked objects |
| 130 | $(filter-out $($(1)-sysobjs),$($(1)-objs)): TEST_CFLAGS += $(TEST_INCLUDES) |
| 131 | |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 132 | # Compile sources and apply mocking/wrapping of selected symbols. |
| 133 | # For each listed mock add new symbol with prefix `__real_`, |
| 134 | # and pointing to the same section:address. |
| 135 | $($(1)-objs): $(testobj)/$(1)/%.o: $$$$*.c $$($(1)-config-file) |
| 136 | mkdir -p $$(dir $$@) |
Jakub Czapiga | e744ba6 | 2022-11-14 11:22:59 +0100 | [diff] [blame] | 137 | $(HOSTCC) $(HOSTCFLAGS) $$(TEST_CFLAGS) $$(TEST_INCLUDES) $($(1)-cflags) -MMD \ |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 138 | -MF $$(basename $$@).d -MT $$@ -c $$< -o $$@.orig |
| 139 | objcopy_wrap_flags=''; \ |
| 140 | for sym in $$($(1)-mocks); do \ |
| 141 | sym_line="$$$$($(OBJDUMP) -t $$@.orig \ |
| 142 | | grep -E "[0-9a-fA-F]+\\s+w\\s+F\\s+.*\\s$$$$sym$$$$")"; \ |
| 143 | if [ ! -z "$$$$sym_line" ] ; then \ |
| 144 | addr="$$$$(echo "$$$$sym_line" | awk '{ print $$$$1 }')"; \ |
| 145 | section="$$$$(echo "$$$$sym_line" | awk '{ print $$$$(NF - 2) }')"; \ |
| 146 | objcopy_wrap_flags="$$$$objcopy_wrap_flags --add-symbol __real_$$$${sym}=$$$${section}:0x$$$${addr},function,global"; \ |
| 147 | fi \ |
| 148 | done ; \ |
| 149 | $(OBJCOPY) $$@.orig $$$$objcopy_wrap_flags $$@ |
| 150 | |
Jakub Czapiga | e744ba6 | 2022-11-14 11:22:59 +0100 | [diff] [blame] | 151 | # Compile system-side sources linked with system libc, without mocking symbols |
| 152 | # or code-under-test includes. |
| 153 | $($(1)-sysobjs): $(testobj)/$(1)/%.o: $$$$*.c $$($(1)-config-file) |
| 154 | mkdir -p $$(dir $$@) |
| 155 | $(HOSTCC) $(HOSTCFLAGS) $$(TEST_CFLAGS) $($(1)-cflags) -MMD \ |
| 156 | -MF $$(basename $$@).d -MT $$@ -c $$< -o $$@ |
| 157 | |
Jakub Czapiga | 3c8a3d1 | 2022-11-09 10:38:11 +0100 | [diff] [blame] | 158 | # Link against Cmocka if not disabled |
| 159 | ifeq ($(strip $(filter-out 0 n no,$($(1)-no_test_framework))),) |
| 160 | $($(1)-objs): TEST_CFLAGS += -I$(cmockasrc)/include |
| 161 | $($(1)-bin): TEST_LDFLAGS += -L$(cmockaobj)/src -lcmocka -Wl,-rpath=$(cmockaobj)/src |
| 162 | $($(1)-bin): TEST_CFLAGS += -I$(cmockasrc)/include |
| 163 | $($(1)-bin): $(CMOCKA_LIB) |
| 164 | endif |
| 165 | |
Jakub Czapiga | e744ba6 | 2022-11-14 11:22:59 +0100 | [diff] [blame] | 166 | $($(1)-bin): $($(1)-objs) $($(1)-sysobjs) |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 167 | $(HOSTCC) $$^ $($(1)-cflags) $$(TEST_LDFLAGS) -o $$@ |
| 168 | |
| 169 | endef |
| 170 | |
| 171 | # Build cmocka |
| 172 | $(CMOCKA_LIB): |
| 173 | echo "*** Building CMOCKA ***" |
| 174 | mkdir -p $(cmockaobj) |
| 175 | cd $(cmockaobj) && $(CMAKE) $(abspath $(cmockasrc)) |
| 176 | $(MAKE) -C $(cmockaobj) |
| 177 | |
| 178 | # Kconfig targets |
| 179 | $(TEST_DOTCONFIG): |
| 180 | mkdir -p $(dir $@) |
| 181 | cp $(TEST_DEFAULT_CONFIG) $(TEST_DOTCONFIG) |
| 182 | |
| 183 | # Don't override default Kconfig variables, since this will affect all |
| 184 | # Kconfig targets. Change them only when calling sub-make instead. |
| 185 | $(TEST_KCONFIG_AUTOHEADER): TEST_KCONFIG_FLAGS := DOTCONFIG=$(TEST_DOTCONFIG) \ |
| 186 | KCONFIG_AUTOHEADER=$(TEST_KCONFIG_AUTOHEADER) \ |
| 187 | KCONFIG_AUTOCONFIG=$(TEST_KCONFIG_AUTOCONFIG) \ |
| 188 | KCONFIG_DEPENDENCIES=$(TEST_KCONFIG_DEPENDENCIES) \ |
| 189 | KCONFIG_SPLITCONFIG=$(TEST_KCONFIG_SPLITCONFIG) \ |
| 190 | KCONFIG_TRISTATE=$(TEST_KCONFIG_TRISTATE) \ |
| 191 | KBUILD_DEFCONFIG=$(TEST_DEFAULT_CONFIG) |
| 192 | |
Jakub Czapiga | d190e0f | 2022-12-05 08:49:35 +0100 | [diff] [blame] | 193 | $(TEST_KCONFIG_AUTOHEADER): $(TEST_DOTCONFIG) |
Jakub Czapiga | 9ebc6c1 | 2022-04-14 13:56:02 +0200 | [diff] [blame] | 194 | mkdir -p $(dir $@) |
| 195 | $(MAKE) $(TEST_KCONFIG_FLAGS) olddefconfig |
| 196 | $(MAKE) $(TEST_KCONFIG_FLAGS) syncconfig |
| 197 | |
| 198 | $(TEST_KCONFIG_AUTOCONFIG): $(TEST_KCONFIG_AUTOHEADER) |
| 199 | true |
Jakub Czapiga | a0e36d8 | 2022-09-06 10:42:16 +0200 | [diff] [blame] | 200 | |
| 201 | TEST_COMMON_DEPENDENCIES := $(CMOCKA_LIB) $(TEST_KCONFIG_AUTOCONFIG) |