Makefile revision a3eac79f5070747e326da631c1eec155f0389919 
1# Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
2# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
5# This Makefile normally builds in a 'build' subdir, but use
6#
7#    make BUILD=<dir>
8#
9# to put the output somewhere else.
10
11##############################################################################
12# Make variables come in two flavors, immediate or deferred.
13#
14#   Variable definitions are parsed like this:
15#
16#        IMMEDIATE = DEFERRED
17#    or
18#        IMMEDIATE := IMMEDIATE
19#
20#   Rules are parsed this way:
21#
22#        IMMEDIATE : IMMEDIATE
23#           DEFERRED
24#
25# So you can assign variables in any order if they're only to be used in
26# actions, but if you use a variable in either the target or prerequisite of a
27# rule, the rule will be constructed using only the top-down, immediate value.
28#
29# So we'll try to define all the variables first. Then the rules.
30#
31
32##############################################################################
33# Configuration variables come first.
34#
35# Our convention is that we only use := for variables that will never be
36# changed or appended. They must be defined before being used anywhere.
37
38# we should only run pwd once, not every time we refer to ${BUILD}.
39SRCDIR := $(shell pwd)
40BUILD ?= $(SRCDIR)/build
41export BUILD
42
43# Target for 'make install'
44DESTDIR ?= /usr/bin
45INSTALL ?= install
46
47# Where to install the (exportable) executables for testing?
48TEST_INSTALL_DIR = ${BUILD}/install_for_test
49
50# Verbose? Use V=1
51ifeq (${V},)
52Q := @
53endif
54
55# Architecture detection
56_machname := $(shell uname -m)
57HOST_ARCH ?= ${_machname}
58
59# ARCH and/or FIRMWARE_ARCH are defined by the Chromium OS ebuild.
60# Pick a sane target architecture if none is defined.
61ifeq (${ARCH},)
62  ARCH := ${HOST_ARCH}
63else ifeq (${ARCH},i386)
64  override ARCH := x86
65else ifeq (${ARCH},amd64)
66  override ARCH := x86_64
67endif
68
69# FIRMWARE_ARCH is only defined by the Chromium OS ebuild if compiling
70# for a firmware target (such as u-boot or depthcharge). It must map
71# to the same consistent set of architectures as the host.
72ifeq (${FIRMWARE_ARCH},i386)
73  override FIRMWARE_ARCH := x86
74else ifeq (${FIRMWARE_ARCH},amd64)
75  override FIRMWARE_ARCH := x86_64
76endif
77
78# Provide default CC and CFLAGS for firmware builds; if you have any -D flags,
79# please add them after this point (e.g., -DVBOOT_DEBUG).
80#
81# TODO(crosbug.com/16808) We hard-code u-boot's compiler flags here just
82# temporarily. As we are still investigating which flags are necessary for
83# maintaining a compatible ABI, etc. between u-boot and vboot_reference.
84#
85# As a first step, this makes the setting of CC and CFLAGS here optional, to
86# permit a calling script or Makefile to set these.
87#
88# Flag ordering: arch, then -f, then -m, then -W
89DEBUG_FLAGS := $(if ${DEBUG},-g -O0,-Os)
90COMMON_FLAGS := -nostdinc -pipe \
91	-ffreestanding -fno-builtin -fno-stack-protector \
92	-Werror -Wall -Wstrict-prototypes ${DEBUG_FLAGS}
93
94# Note: FIRMWARE_ARCH is defined by the Chromium OS ebuild.
95ifeq (${FIRMWARE_ARCH}, arm)
96CC ?= armv7a-cros-linux-gnueabi-gcc
97CFLAGS ?= -march=armv5 \
98	-fno-common -ffixed-r8 \
99	-mfloat-abi=hard -marm -mabi=aapcs-linux -mno-thumb-interwork \
100	${COMMON_FLAGS}
101else ifeq (${FIRMWARE_ARCH}, x86)
102CC ?= i686-pc-linux-gnu-gcc
103# Drop -march=i386 to permit use of SSE instructions
104CFLAGS ?= \
105	-ffunction-sections -fvisibility=hidden -fno-strict-aliasing \
106	-fomit-frame-pointer -fno-toplevel-reorder -fno-dwarf2-cfi-asm \
107	-mpreferred-stack-boundary=2 -mregparm=3 \
108	${COMMON_FLAGS}
109else ifeq (${FIRMWARE_ARCH}, x86_64)
110CFLAGS ?= ${COMMON_FLAGS} \
111	-fvisibility=hidden -fno-strict-aliasing -fomit-frame-pointer
112else
113# FIRMWARE_ARCH not defined; assuming local compile.
114CC ?= gcc
115CFLAGS += -DCHROMEOS_ENVIRONMENT -Wall -Werror # HEY: always want last two?
116endif
117
118ifneq (${DEBUG},)
119CFLAGS += -DVBOOT_DEBUG
120endif
121
122ifeq (${DISABLE_NDEBUG},)
123CFLAGS += -DNDEBUG
124endif
125
126# Create / use dependency files
127CFLAGS += -MMD -MF $@.d
128
129# Code coverage
130ifneq (${COV},)
131  COV_FLAGS = -O0 --coverage
132  CFLAGS += ${COV_FLAGS}
133  LDFLAGS += ${COV_FLAGS}
134  COV_INFO = ${BUILD}/coverage.info
135endif
136
137# And a few more default utilities
138LD = ${CC}
139CXX ?= g++ # HEY: really?
140PKG_CONFIG ?= pkg-config
141
142# Determine QEMU architecture needed, if any
143ifeq (${ARCH},${HOST_ARCH})
144  # Same architecture; no need for QEMU
145  QEMU_ARCH :=
146else ifeq (${HOST_ARCH}-${ARCH},x86_64-x86)
147  # 64-bit host can run 32-bit targets directly
148  QEMU_ARCH :=
149else
150  QEMU_ARCH := ${ARCH}
151endif
152
153# The top of the chroot for qemu must be passed in via the SYSROOT environment
154# variable.  In the Chromium OS chroot, this is done automatically by the
155# ebuild.
156
157ifeq (${QEMU_ARCH},)
158  # Path to build output for running tests is same as for building
159  BUILD_RUN = ${BUILD}
160  SRC_RUN = ${SRCDIR}
161else
162  $(info Using qemu for testing.)
163  # Path to build output for running tests is different in the chroot
164  BUILD_RUN = $(subst ${SYSROOT},,${BUILD})
165  SRC_RUN = $(subst ${SYSROOT},,${SRCDIR})
166
167  QEMU_BIN = qemu-${QEMU_ARCH}
168  QEMU_RUN = ${BUILD_RUN}/${QEMU_BIN}
169  export QEMU_RUN
170
171  RUNTEST = tests/test_using_qemu.sh
172endif
173
174export BUILD_RUN
175
176# Some things only compile inside the Chromium OS chroot.
177# TODO: Those things should be in their own repo, not part of vboot_reference
178# TODO: Is there a better way to detect this?
179ifneq (${CROS_WORKON_SRCROOT},)
180IN_CHROOT := yes
181endif
182
183# TODO: Move to separate repo.
184ifneq (${IN_CHROOT},)
185PC_BASE_VER ?= 125070
186PC_DEPS := libchrome-${PC_BASE_VER}
187PC_CFLAGS := $(shell ${PKG_CONFIG} --cflags ${PC_DEPS})
188PC_LDLIBS := $(shell ${PKG_CONFIG} --libs ${PC_DEPS})
189endif
190
191
192##############################################################################
193# Now we need to describe everything we might want or need to build
194
195# TODO: This should go in its own repo.
196AU_CGPTLIB = ${BUILD}/cgpt/libcgpt-cc.a
197# This is just ... Gah. There's no good place for it.
198DUMPKERNELCONFIGLIB = ${BUILD}/libdump_kernel_config.a
199
200# Everything wants these headers.
201INCLUDES += \
202	-Ifirmware/include \
203	-Ifirmware/lib/include \
204	-Ifirmware/lib/cgptlib/include \
205	-Ifirmware/lib/cryptolib/include \
206	-Ifirmware/lib/tpm_lite/include
207
208# If we're not building for a specific target, just stub out things like the
209# TPM commands and various external functions that are provided by the BIOS.
210ifeq (${FIRMWARE_ARCH},)
211INCLUDES += -Ifirmware/stub/include
212else
213INCLUDES += -Ifirmware/arch/${FIRMWARE_ARCH}/include
214endif
215
216# Firmware library. TODO: Do we still need to export this?
217FWLIB = ${BUILD}/vboot_fw.a
218
219# find lib -iname '*.c' | sort
220FWLIB_SRCS = \
221	firmware/lib/cgptlib/cgptlib.c \
222	firmware/lib/cgptlib/cgptlib_internal.c \
223	firmware/lib/cgptlib/crc32.c \
224	firmware/lib/crc8.c \
225	firmware/lib/cryptolib/padding.c \
226	firmware/lib/cryptolib/rsa.c \
227	firmware/lib/cryptolib/rsa_utility.c \
228	firmware/lib/cryptolib/sha1.c \
229	firmware/lib/cryptolib/sha256.c \
230	firmware/lib/cryptolib/sha512.c \
231	firmware/lib/cryptolib/sha_utility.c \
232	firmware/lib/stateful_util.c \
233	firmware/lib/utility.c \
234	firmware/lib/utility_string.c \
235	firmware/lib/vboot_api_init.c \
236	firmware/lib/vboot_api_firmware.c \
237	firmware/lib/vboot_api_kernel.c \
238	firmware/lib/vboot_audio.c \
239	firmware/lib/vboot_common.c \
240	firmware/lib/vboot_display.c \
241	firmware/lib/vboot_firmware.c \
242	firmware/lib/vboot_kernel.c \
243	firmware/lib/vboot_nvstorage.c
244
245# Support real TPM unless BIOS sets MOCK_TPM
246ifeq (${MOCK_TPM},)
247FWLIB_SRCS += \
248	firmware/lib/rollback_index.c \
249	firmware/lib/tpm_bootmode.c \
250	firmware/lib/tpm_lite/tlcl.c
251else
252FWLIB_SRCS += \
253	firmware/lib/mocked_rollback_index.c \
254	firmware/lib/mocked_tpm_bootmode.c \
255	firmware/lib/tpm_lite/mocked_tlcl.c
256endif
257
258ifeq (${FIRMWARE_ARCH},)
259# Include BIOS stubs in the firmware library when compiling for host
260FWLIB_SRCS += \
261	firmware/stub/tpm_lite_stub.c \
262	firmware/stub/utility_stub.c \
263	firmware/stub/vboot_api_stub.c \
264	firmware/stub/vboot_api_stub_disk.c
265endif
266
267FWLIB_OBJS = ${FWLIB_SRCS:%.c=${BUILD}/%.o}
268ALL_OBJS += ${FWLIB_OBJS}
269
270
271# Library to build the utilities. "HOST" mostly means "userspace".
272HOSTLIB = ${BUILD}/vboot_host.a
273
274HOSTLIB_SRCS = \
275	host/arch/${ARCH}/lib/crossystem_arch.c \
276	host/lib/crossystem.c \
277	host/lib/file_keys.c \
278	host/lib/fmap.c \
279	host/lib/host_common.c \
280	host/lib/host_key.c \
281	host/lib/host_keyblock.c \
282	host/lib/host_misc.c \
283	host/lib/host_signature.c \
284	host/lib/signature_digest.c
285
286HOSTLIB_OBJS = ${HOSTLIB_SRCS:%.c=${BUILD}/%.o}
287ALL_OBJS += ${HOSTLIB_OBJS}
288
289
290# Link with hostlib by default
291LIBS = $(HOSTLIB)
292
293# Might need this too.
294CRYPTO_LIBS := $(shell ${PKG_CONFIG} --libs libcrypto)
295
296
297# ----------------------------------------------------------------------------
298# Now for the userspace binaries
299
300CGPT = ${BUILD}/cgpt/cgpt
301
302CGPT_SRCS = \
303	cgpt/cgpt.c \
304	cgpt/cgpt_add.c \
305	cgpt/cgpt_boot.c \
306	cgpt/cgpt_common.c \
307	cgpt/cgpt_create.c \
308	cgpt/cgpt_find.c \
309	cgpt/cgpt_legacy.c \
310	cgpt/cgpt_prioritize.c \
311	cgpt/cgpt_repair.c \
312	cgpt/cgpt_show.c \
313	cgpt/cmd_add.c \
314	cgpt/cmd_boot.c \
315	cgpt/cmd_create.c \
316	cgpt/cmd_find.c \
317	cgpt/cmd_legacy.c \
318	cgpt/cmd_prioritize.c \
319	cgpt/cmd_repair.c \
320	cgpt/cmd_show.c
321
322CGPT_OBJS = ${CGPT_SRCS:%.c=${BUILD}/%.o}
323ALL_OBJS += ${CGPT_OBJS}
324
325C_DESTDIR = ${DESTDIR}
326
327
328# Scripts to install directly (not compiled)
329UTIL_SCRIPTS = \
330	utility/dev_debug_vboot \
331	utility/dev_make_keypair \
332	utility/enable_dev_usb_boot \
333	utility/vbutil_what_keys
334
335# These utilities should be linked statically.
336UTIL_NAMES_STATIC = \
337	crossystem \
338	dump_fmap \
339	gbb_utility
340
341UTIL_NAMES = ${UTIL_NAMES_STATIC} \
342	dev_sign_file \
343	dump_kernel_config \
344	dumpRSAPublicKey \
345	load_kernel_test \
346	pad_digest_utility \
347	signature_digest_utility \
348	tpm_init_temp_fix \
349	tpmc \
350	vbutil_ec \
351	vbutil_firmware \
352	vbutil_kernel \
353	vbutil_key \
354	vbutil_keyblock \
355	verify_data
356
357ifneq (${IN_CHROOT},)
358UTIL_NAMES += mount-encrypted
359endif
360
361ifeq (${MINIMAL},)
362UTIL_NAMES += \
363	bmpblk_font \
364	bmpblk_utility \
365	eficompress \
366	efidecompress
367endif
368
369UTIL_BINS_STATIC := $(addprefix ${BUILD}/utility/,${UTIL_NAMES_STATIC})
370UTIL_BINS = $(addprefix ${BUILD}/utility/,${UTIL_NAMES})
371ALL_DEPS += $(addsuffix .d,${UTIL_BINS})
372
373U_DESTDIR = ${DESTDIR}
374
375
376# The unified firmware utility will eventually replace all the others
377FUTIL_BIN = ${BUILD}/futility/futility
378
379FUTIL_SRCS = \
380	futility/IGNOREME.c
381
382FUTIL_LDS = futility/futility.lds
383
384FUTIL_OBJS = ${FUTIL_SRCS:%.c=${BUILD}/%.o}
385
386ALL_DEPS += $(addsuffix .d,${FUTIL_BIN})
387ALL_OBJS += ${FUTIL_OBJS}
388
389F_DESTDIR = ${DESTDIR}
390
391
392# Library of handy test functions.
393TESTLIB = ${BUILD}/tests/test.a
394
395TESTLIB_SRCS = \
396	tests/test_common.c \
397	tests/timer_utils.c \
398	tests/crc32_test.c
399
400TESTLIB_OBJS = ${TESTLIB_SRCS:%.c=${BUILD}/%.o}
401ALL_OBJS += ${TESTLIB_OBJS}
402
403
404# And some compiled tests.
405TEST_NAMES = \
406	cgptlib_test \
407	rollback_index2_tests \
408	rollback_index3_tests \
409	rsa_padding_test \
410	rsa_utility_tests \
411	rsa_verify_benchmark \
412	sha_benchmark \
413	sha_tests \
414	stateful_util_tests \
415	tpm_bootmode_tests \
416	utility_string_tests \
417	utility_tests \
418	vboot_api_init_tests \
419	vboot_api_devmode_tests \
420	vboot_api_firmware_tests \
421	vboot_api_kernel_tests \
422	vboot_audio_tests \
423	vboot_common_tests \
424	vboot_common2_tests \
425	vboot_common3_tests \
426	vboot_ec_tests \
427	vboot_firmware_tests \
428	vboot_nvstorage_test
429
430# Grrr
431ifneq (${IN_CHROOT},)
432TEST_NAMES += CgptManagerTests
433endif
434
435# TODO: port these tests to new API, if not already eqivalent
436# functionality in other tests.  These don't even compile at present.
437#
438#		big_firmware_tests
439#		big_kernel_tests
440#		firmware_image_tests
441#		firmware_rollback_tests
442#		firmware_splicing_tests
443#		firmware_verify_benchmark
444#		kernel_image_tests
445#		kernel_rollback_tests
446#		kernel_splicing_tests
447#		kernel_verify_benchmark
448#		rollback_index_test
449#		verify_firmware_fuzz_driver
450#		verify_kernel_fuzz_driver
451#               utility/load_firmware_test
452
453# And a few more...
454TLCL_TESTS = \
455	tpmtest_earlyextend \
456	tpmtest_earlynvram \
457        tpmtest_earlynvram2 \
458	tpmtest_enable \
459	tpmtest_fastenable \
460	tpmtest_globallock \
461        tpmtest_redefine_unowned \
462        tpmtest_spaceperm \
463	tpmtest_testsetup \
464	tpmtest_timing \
465        tpmtest_writelimit
466TLCL_TEST_NAMES = $(addprefix tpm_lite/,${TLCL_TESTS})
467TLCL_TEST_BINS = $(addprefix ${BUILD}/tests/,${TLCL_TEST_NAMES})
468
469TEST_NAMES += ${TLCL_TEST_NAMES}
470
471TEST_BINS = $(addprefix ${BUILD}/tests/,${TEST_NAMES})
472ALL_DEPS += $(addsuffix .d,${TEST_BINS})
473
474# Directory containing test keys
475TEST_KEYS = ${SRC_RUN}/tests/testkeys
476
477# ----------------------------------------------------------------------------
478# TODO: why not make this include *all* the cgpt files, and simply have
479# cgpt link against it?
480# TODO: CgptManager.cc should move to the installer project.  Shouldn't be
481# in libcgpt-cc.a.
482AU_CGPTLIB_SRCS = \
483	cgpt/CgptManager.cc \
484	cgpt/cgpt_create.c \
485	cgpt/cgpt_add.c \
486	cgpt/cgpt_boot.c \
487	cgpt/cgpt_show.c \
488	cgpt/cgpt_repair.c \
489	cgpt/cgpt_prioritize.c \
490	cgpt/cgpt_common.c \
491	firmware/lib/cgptlib/crc32.c \
492	firmware/lib/cgptlib/cgptlib_internal.c \
493	firmware/stub/utility_stub.c
494
495AU_CGPTLIB_OBJS = $(filter %.o, \
496	${AU_CGPTLIB_SRCS:%.c=${BUILD}/%.o} \
497	${AU_CGPTLIB_SRCS:%.cc=${BUILD}/%.o})
498ALL_OBJS += ${AU_CGPTLIB_OBJS}
499
500
501##############################################################################
502# Finally, some targets. High-level ones first.
503
504# Create output directories if necessary.  Do this via explicit shell commands
505# so it happens before trying to generate/include dependencies.
506SUBDIRS := firmware host cgpt utility futility tests tests/tpm_lite
507_dir_create := $(foreach d, \
508	$(shell find ${SUBDIRS} -name '*.c' -exec  dirname {} \; | sort -u), \
509	$(shell [ -d ${BUILD}/${d} ] || mkdir -p ${BUILD}/${d}))
510
511
512# Default target.
513.PHONY: all
514all: fwlib $(if ${FIRMWARE_ARCH},,host_stuff) $(if ${COV},coverage)
515
516# Host targets
517.PHONY: host_stuff
518host_stuff: hostlib cgpt utils futil tests
519
520# AU targets
521.PHONY: au_stuff
522au_stuff: libcgpt_cc libdump_kernel_config cgptmanager_tests
523
524.PHONY: clean
525clean:
526	${Q}/bin/rm -rf ${BUILD}
527
528.PHONY: install
529install: cgpt_install utils_install futil_install
530
531# Don't delete intermediate object files
532.SECONDARY:
533
534# TODO: I suspect this is missing some object files.  Make a temp
535# target which cleans all known obj/exe's and see what's left; those
536# are the files which need deps.
537ALL_DEPS += ${ALL_OBJS:%.o=%.o.d}
538-include ${ALL_DEPS}
539
540# ----------------------------------------------------------------------------
541# Firmware library
542
543# TPM-specific flags.  These depend on the particular TPM we're targeting for.
544# They are needed here only for compiling parts of the firmware code into
545# user-level tests.
546
547# TPM_BLOCKING_CONTINUESELFTEST is defined if TPM_ContinueSelfTest blocks until
548# the self test has completed.
549
550${FWLIB}: CFLAGS += -DTPM_BLOCKING_CONTINUESELFTEST
551
552# TPM_MANUAL_SELFTEST is defined if the self test must be started manually
553# (with a call to TPM_ContinueSelfTest) instead of starting automatically at
554# power on.
555#
556# We sincerely hope that TPM_BLOCKING_CONTINUESELFTEST and TPM_MANUAL_SELFTEST
557# are not both defined at the same time.  (See comment in code.)
558
559# CFLAGS += -DTPM_MANUAL_SELFTEST
560
561ifeq (${FIRMWARE_ARCH},i386)
562# Unrolling loops in cryptolib makes it faster
563${FWLIB}: CFLAGS += -DUNROLL_LOOPS
564
565# Workaround for coreboot on x86, which will power off asynchronously
566# without giving us a chance to react. This is not an example of the Right
567# Way to do things. See chrome-os-partner:7689, and the commit message
568# that made this change.
569${FWLIB}: CFLAGS += -DSAVE_LOCALE_IMMEDIATELY
570
571# On x86 we don't actually read the GBB data into RAM until it is needed.
572# Therefore it makes sense to cache it rather than reading it each time.
573# Enable this feature.
574${FWLIB}: CFLAGS += -DCOPY_BMP_DATA
575endif
576
577ifeq (${FIRMWARE_ARCH},)
578# Disable rollback TPM when compiling locally, since otherwise
579# load_kernel_test attempts to talk to the TPM.
580${FWLIB}: CFLAGS += -DDISABLE_ROLLBACK_TPM
581endif
582
583.PHONY: fwlib
584fwlib: ${FWLIB} $(if ${FIRMWARE_ARCH},,${BUILD}/firmware/linktest/main)
585
586${FWLIB}: ${FWLIB_OBJS}
587	@printf "    RM            $(subst ${BUILD}/,,$@)\n"
588	${Q}rm -f $@
589	@printf "    AR            $(subst ${BUILD}/,,$@)\n"
590	${Q}ar qc $@ $^
591
592# ----------------------------------------------------------------------------
593# Host library
594
595.PHONY: hostlib
596hostlib: ${HOSTLIB} ${BUILD}/host/linktest/main
597
598${BUILD}/host/% ${HOSTLIB}: INCLUDES += \
599	-Ihost/include\
600	-Ihost/arch/${ARCH}/include
601
602# TODO: better way to make .a than duplicating this recipe each time?
603${HOSTLIB}: ${HOSTLIB_OBJS} ${FWLIB_OBJS}
604	@printf "    RM            $(subst ${BUILD}/,,$@)\n"
605	${Q}rm -f $@
606	@printf "    AR            $(subst ${BUILD}/,,$@)\n"
607	${Q}ar qc $@ $^
608
609# ----------------------------------------------------------------------------
610# CGPT library and utility
611
612.PHONY: cgpt
613cgpt: ${CGPT}
614
615${CGPT}: LDFLAGS += -static
616${CGPT}: LDLIBS += -luuid
617
618${CGPT}: ${CGPT_OBJS} ${LIBS}
619	@printf "    LDcgpt        $(subst ${BUILD}/,,$@)\n"
620	${Q}${LD} -o ${CGPT} ${CFLAGS} $^ ${LDFLAGS} ${LDLIBS}
621
622.PHONY: cgpt_install
623cgpt_install: ${CGPT}
624	@printf "    INSTALL       CGPT\n"
625	${Q}mkdir -p ${C_DESTDIR}
626	${Q}${INSTALL} -t ${C_DESTDIR} $^
627
628# ----------------------------------------------------------------------------
629# Utilities
630
631# These have their own headers too.
632${BUILD}/utility/%: INCLUDES += -Ihost/include -Iutility/include
633
634# Utilities for auto-update toolkits must be statically linked.
635${UTIL_BINS_STATIC}: LDFLAGS += -static
636
637.PHONY: utils
638utils: ${UTIL_BINS} ${UTIL_SCRIPTS}
639# TODO: change ebuild to pull scripts directly out of utility dir
640	${Q}cp -f ${UTIL_SCRIPTS} ${BUILD}/utility
641	${Q}chmod a+rx $(patsubst %,${BUILD}/%,${UTIL_SCRIPTS})
642
643.PHONY: utils_install
644utils_install: ${UTIL_BINS} ${UTIL_SCRIPTS}
645	@printf "    INSTALL       UTILS\n"
646	${Q}mkdir -p ${U_DESTDIR}
647	${Q}${INSTALL} -t ${U_DESTDIR} $^
648
649# ----------------------------------------------------------------------------
650# new Firmware Utility
651
652.PHONY: futil
653futil: ${FUTIL_BIN}
654
655${FUTIL_BIN}: ${FUTIL_LDS} ${FUTIL_OBJS}
656	@printf "    LD            $(subst ${BUILD}/,,$@)\n"
657	${Q}${LD} -o $@ ${CFLAGS} $^ ${LDFLAGS} ${LDLIBS}
658
659.PHONY: futil_install
660futil_install: ${FUTIL_BIN}
661	@printf "    INSTALL       futility\n"
662	${Q}mkdir -p ${F_DESTDIR}
663	${Q}${INSTALL} -t ${F_DESTDIR} $^
664
665
666# ----------------------------------------------------------------------------
667# Mount-encrypted utility for cryptohome
668
669# TODO: mount-encrypted should move to cryptohome and just link against
670# vboot-host.a for tlcl and crossystem.
671
672# The embedded libcrypto conflicts with the shipped openssl,
673# so mount-* builds without the common CFLAGS (and those includes).
674
675${BUILD}/utility/mount-helpers.o: \
676		utility/mount-helpers.c \
677		utility/mount-helpers.h \
678		utility/mount-encrypted.h
679	@printf "    CCm-e         $(subst ${BUILD}/,,$@)\n"
680	${Q}${CC} -Wall -Werror -O2 -D_FORTIFY_SOURCE=2 -fstack-protector \
681		${COV_FLAGS} \
682		$(shell ${PKG_CONFIG} --cflags glib-2.0 openssl) \
683		-c $< -o $@
684
685${BUILD}/utility/mount-encrypted: \
686		utility/mount-encrypted.c \
687		utility/mount-encrypted.h \
688		${BUILD}/utility/mount-helpers.o ${LIBS}
689	@printf "    CCm-exe       $(subst ${BUILD}/,,$@)\n"
690	${Q}${CC} -Wall -Werror -O2 -D_FORTIFY_SOURCE=2 -fstack-protector \
691		$(shell ${PKG_CONFIG} --cflags glib-2.0 openssl) \
692		-Ifirmware/include \
693		-Ihost/include \
694		${COV_FLAGS} \
695		${LDFLAGS} \
696		$< -o $@ \
697		${BUILD}/utility/mount-helpers.o ${LIBS} \
698		$(shell ${PKG_CONFIG} --libs glib-2.0 openssl) \
699		-lm
700ifneq (${COV},)
701	${Q}mv -f mount-encrypted.gcno ${BUILD}/utility
702endif
703
704# ----------------------------------------------------------------------------
705# Utility to generate TLCL structure definition header file.
706
707${BUILD}/utility/tlcl_generator: CFLAGS += -fpack-struct
708
709STRUCTURES_TMP=${BUILD}/tlcl_structures.tmp
710STRUCTURES_SRC=firmware/lib/tpm_lite/include/tlcl_structures.h
711
712.PHONY: update_tlcl_structures
713update_tlcl_structures: ${BUILD}/utility/tlcl_generator
714	@printf "    Rebuilding TLCL structures\n"
715	${Q}${BUILD}/utility/tlcl_generator > ${STRUCTURES_TMP}
716	${Q}cmp -s ${STRUCTURES_TMP} ${STRUCTURES_SRC} || \
717		( echo "%% Updating structures.h %%" && \
718		  cp ${STRUCTURES_TMP} ${STRUCTURES_SRC} )
719
720# ----------------------------------------------------------------------------
721# Library to dump kernel config
722# Used by platform/installer, as well as standalone utility.
723
724.PHONY: libdump_kernel_config
725libdump_kernel_config: ${DUMPKERNELCONFIGLIB}
726
727${DUMPKERNELCONFIGLIB}: ${BUILD}/utility/dump_kernel_config_lib.o
728	@printf "    RM            $(subst ${BUILD}/,,$@)\n"
729	${Q}rm -f $@
730	@printf "    AR            $(subst ${BUILD}/,,$@)\n"
731	${Q}ar qc $@ $^
732
733# ----------------------------------------------------------------------------
734# And this thing.
735
736.PHONY: libcgpt_cc
737libcgpt_cc: ${AU_CGPTLIB}
738
739${AU_CGPTLIB}: INCLUDES += -Ifirmware/lib/cgptlib/include
740${AU_CGPTLIB}: ${AU_CGPTLIB_OBJS}
741	@printf "    RM            $(subst ${BUILD}/,,$@)\n"
742	${Q}rm -f $@
743	@printf "    AR            $(subst ${BUILD}/,,$@)\n"
744	${Q}ar qc $@ $^
745
746# ----------------------------------------------------------------------------
747# Tests
748
749.PHONY: tests
750tests: ${TEST_BINS}
751
752${TEST_BINS}: ${TESTLIB}
753
754${TESTLIB}: ${TESTLIB_OBJS}
755	@printf "    RM            $(subst ${BUILD}/,,$@)\n"
756	${Q}rm -f $@
757	@printf "    AR            $(subst ${BUILD}/,,$@)\n"
758	${Q}ar qc $@ $^
759
760
761# ----------------------------------------------------------------------------
762# Generic build rules. LIBS and OBJS can be overridden to tweak the generic
763# rules for specific targets.
764
765${BUILD}/%: ${BUILD}/%.o ${OBJS} ${LIBS}
766	@printf "    LD            $(subst ${BUILD}/,,$@)\n"
767	${Q}${LD} -o $@ ${CFLAGS} $< ${OBJS} ${LIBS} ${LDFLAGS} ${LDLIBS}
768
769${BUILD}/%.o: %.c
770	@printf "    CC            $(subst ${BUILD}/,,$@)\n"
771	${Q}${CC} ${CFLAGS} ${INCLUDES} -c -o $@ $<
772
773# Rules to recompile a single source file for library and test
774# TODO: is there a tidier way to do this?
775${BUILD}/%_for_lib.o: CFLAGS += -DFOR_LIBRARY
776${BUILD}/%_for_lib.o: %.c
777	@printf "    CC-for-lib    $(subst ${BUILD}/,,$@)\n"
778	${Q}${CC} ${CFLAGS} ${INCLUDES} -c -o $@ $<
779
780${BUILD}/%_for_test.o: CFLAGS += -DFOR_TEST
781${BUILD}/%_for_test.o: %.c
782	@printf "    CC-for-test   $(subst ${BUILD}/,,$@)\n"
783	${Q}${CC} ${CFLAGS} ${INCLUDES} -c -o $@ $<
784
785# TODO: C++ files don't belong in vboot reference at all.  Convert to C.
786${BUILD}/%.o: %.cc
787	@printf "    CXX           $(subst ${BUILD}/,,$@)\n"
788	${Q}${CXX} ${CFLAGS} ${INCLUDES} -c -o $@ $<
789
790# ----------------------------------------------------------------------------
791# Here are the special tweaks to the generic rules.
792
793# Linktest ensures firmware lib doesn't rely on outside libraries
794${BUILD}/firmware/linktest/main: LIBS = ${FWLIB}
795
796# Specific dependency here.
797${BUILD}/utility/dump_kernel_config: LIBS += ${DUMPKERNELCONFIGLIB}
798${BUILD}/utility/dump_kernel_config: ${DUMPKERNELCONFIGLIB}
799
800# GBB utility needs C++ linker. TODO: It shouldn't.
801${BUILD}/utility/gbb_utility: LD = ${CXX}
802
803# Some utilities need external crypto functions
804${BUILD}/utility/dumpRSAPublicKey: LDLIBS += ${CRYPTO_LIBS}
805${BUILD}/utility/pad_digest_utility: LDLIBS += ${CRYPTO_LIBS}
806${BUILD}/utility/signature_digest_utility: LDLIBS += ${CRYPTO_LIBS}
807${BUILD}/utility/dev_sign_file: LDLIBS += ${CRYPTO_LIBS}
808${BUILD}/utility/vbutil_ec: LDLIBS += ${CRYPTO_LIBS}
809${BUILD}/utility/vbutil_firmware: LDLIBS += ${CRYPTO_LIBS}
810${BUILD}/utility/vbutil_kernel: LDLIBS += ${CRYPTO_LIBS}
811${BUILD}/utility/vbutil_key: LDLIBS += ${CRYPTO_LIBS}
812${BUILD}/utility/vbutil_keyblock: LDLIBS += ${CRYPTO_LIBS}
813
814${BUILD}/host/linktest/main: LDLIBS += ${CRYPTO_LIBS}
815${BUILD}/tests/vboot_common2_tests: LDLIBS += ${CRYPTO_LIBS}
816${BUILD}/tests/vboot_common3_tests: LDLIBS += ${CRYPTO_LIBS}
817${BUILD}/tests/vboot_ec_tests: LDLIBS += ${CRYPTO_LIBS}
818
819
820${BUILD}/utility/bmpblk_utility: LD = ${CXX}
821${BUILD}/utility/bmpblk_utility: LDLIBS = -llzma -lyaml
822
823BMPBLK_UTILITY_DEPS = \
824	${BUILD}/utility/bmpblk_util.o \
825	${BUILD}/utility/image_types.o \
826	${BUILD}/utility/eficompress_for_lib.o \
827	${BUILD}/utility/efidecompress_for_lib.o
828${BUILD}/utility/bmpblk_utility: OBJS = ${BMPBLK_UTILITY_DEPS}
829${BUILD}/utility/bmpblk_utility: ${BMPBLK_UTILITY_DEPS}
830
831${BUILD}/utility/bmpblk_font: OBJS += ${BUILD}/utility/image_types.o
832${BUILD}/utility/bmpblk_font: ${BUILD}/utility/image_types.o
833
834# Allow multiple definitions, so tests can mock functions from other libraries
835${BUILD}/tests/%: CFLAGS += -Xlinker --allow-multiple-definition
836${BUILD}/tests/%: INCLUDES += -Ihost/include
837${BUILD}/tests/%: LDLIBS += -lrt -luuid
838${BUILD}/tests/%: LIBS += ${TESTLIB}
839
840${BUILD}/tests/rollback_index2_tests: OBJS += \
841	${BUILD}/firmware/lib/rollback_index_for_test.o
842${BUILD}/tests/rollback_index2_tests: \
843	${BUILD}/firmware/lib/rollback_index_for_test.o
844
845${BUILD}/tests/vboot_audio_tests: OBJS += \
846	${BUILD}/firmware/lib/vboot_audio_for_test.o
847${BUILD}/tests/vboot_audio_tests: \
848	${BUILD}/firmware/lib/vboot_audio_for_test.o
849
850.PHONY: cgptmanager_tests
851cgptmanager_tests: ${BUILD}/tests/CgptManagerTests
852
853${BUILD}/tests/CgptManagerTests: CFLAGS += ${PC_CFLAGS}
854${BUILD}/tests/CgptManagerTests: LD = ${CXX}
855${BUILD}/tests/CgptManagerTests: LDLIBS += -lgtest -lgflags ${PC_LDLIBS}
856${BUILD}/tests/CgptManagerTests: LIBS = ${AU_CGPTLIB}
857${BUILD}/tests/CgptManagerTests: ${AU_CGPTLIB}
858
859${BUILD}/tests/rollback_index_test: INCLUDES += -I/usr/include
860${BUILD}/tests/rollback_index_test: LIBS += -ltlcl
861
862${TLCL_TEST_BINS}: OBJS += ${BUILD}/tests/tpm_lite/tlcl_tests.o
863${TLCL_TEST_BINS}: ${BUILD}/tests/tpm_lite/tlcl_tests.o
864
865##############################################################################
866# Targets that exist just to run tests
867
868# Frequently-run tests
869.PHONY: test_targets
870test_targets:: runcgpttests runmisctests
871
872ifeq (${MINIMAL},)
873# Bitmap utility isn't compiled for minimal variant
874test_targets:: runbmptests
875# Scripts don't work under qemu testing
876# TODO: convert scripts to makefile so they can be called directly
877test_targets:: runtestscripts
878endif
879
880.PHONY: test_setup
881test_setup:: cgpt utils futil tests
882
883# Qemu setup for cross-compiled tests.  Need to copy qemu binary into the
884# sysroot.
885ifneq (${QEMU_ARCH},)
886test_setup:: qemu_install
887
888.PHONY: qemu_install
889qemu_install:
890ifeq (${SYSROOT},)
891	$(error SYSROOT must be set to the top of the target-specific root \
892when cross-compiling for qemu-based tests to run properly.)
893endif
894	@printf "    Copying qemu binary.\n"
895	${Q}cp -fu /usr/bin/${QEMU_BIN} ${BUILD}/${QEMU_BIN}
896	${Q}chmod a+rx ${BUILD}/${QEMU_BIN}
897endif
898
899.PHONY: runtests
900runtests: test_targets
901
902# Generate test keys
903.PHONY: genkeys
904genkeys: utils
905	tests/gen_test_keys.sh
906
907# Generate test cases for fuzzing
908.PHONY: genfuzztestcases
909genfuzztestcases: utils
910	tests/gen_fuzz_test_cases.sh
911
912.PHONY: runbmptests
913runbmptests: test_setup
914	cd tests/bitmaps && BMPBLK=${BUILD_RUN}/utility/bmpblk_utility \
915		./TestBmpBlock.py -v
916
917.PHONY: runcgpttests
918runcgpttests: test_setup
919	${RUNTEST} ${BUILD_RUN}/tests/cgptlib_test
920# HEY - elsewhere
921ifneq (${IN_CHROOT},)
922	${RUNTEST} ${BUILD_RUN}/tests/CgptManagerTests --v=1
923endif
924
925.PHONY: runtestscripts
926runtestscripts: test_setup genfuzztestcases
927	tests/run_cgpt_tests.sh ${BUILD_RUN}/cgpt/cgpt
928	tests/run_preamble_tests.sh
929	tests/run_rsa_tests.sh
930	tests/run_vbutil_kernel_arg_tests.sh
931	tests/run_vbutil_tests.sh
932
933.PHONY: runmisctests
934runmisctests: test_setup
935	${RUNTEST} ${BUILD_RUN}/tests/rollback_index2_tests
936	${RUNTEST} ${BUILD_RUN}/tests/rollback_index3_tests
937	${RUNTEST} ${BUILD_RUN}/tests/rsa_utility_tests
938	${RUNTEST} ${BUILD_RUN}/tests/sha_tests
939	${RUNTEST} ${BUILD_RUN}/tests/stateful_util_tests
940	${RUNTEST} ${BUILD_RUN}/tests/tpm_bootmode_tests
941	${RUNTEST} ${BUILD_RUN}/tests/utility_string_tests
942	${RUNTEST} ${BUILD_RUN}/tests/utility_tests
943	${RUNTEST} ${BUILD_RUN}/tests/vboot_api_devmode_tests
944	${RUNTEST} ${BUILD_RUN}/tests/vboot_api_init_tests
945	${RUNTEST} ${BUILD_RUN}/tests/vboot_api_firmware_tests
946	${RUNTEST} ${BUILD_RUN}/tests/vboot_audio_tests
947	${RUNTEST} ${BUILD_RUN}/tests/vboot_common_tests
948	${RUNTEST} ${BUILD_RUN}/tests/vboot_common2_tests ${TEST_KEYS}
949	${RUNTEST} ${BUILD_RUN}/tests/vboot_common3_tests ${TEST_KEYS}
950	${RUNTEST} ${BUILD_RUN}/tests/vboot_firmware_tests
951	${RUNTEST} ${BUILD_RUN}/tests/vboot_nvstorage_test
952
953.PHONY: runfutiltests
954runfutiltests: DESTDIR := ${TEST_INSTALL_DIR}
955runfutiltests: test_setup install
956	@echo "$@ passed"
957
958# Run long tests, including all permutations of encryption keys (instead of
959# just the ones we use) and tests of currently-unused code (e.g. vboot_ec).
960# Not run by automated build.
961.PHONY: runlongtests
962runlongtests: test_setup genkeys genfuzztestcases
963	${RUNTEST} ${BUILD_RUN}/tests/vboot_common2_tests ${TEST_KEYS} --all
964	${RUNTEST} ${BUILD_RUN}/tests/vboot_common3_tests ${TEST_KEYS} --all
965	tests/run_preamble_tests.sh --all
966	tests/run_vboot_ec_tests.sh
967	tests/run_vbutil_tests.sh --all
968
969# TODO: tests to run when ported to new API
970#	./run_image_verification_tests.sh
971#	# Splicing tests
972#	${BUILD}/tests/firmware_splicing_tests
973#	${BUILD}/tests/kernel_splicing_tests
974#	# Rollback Tests
975#	${BUILD}/tests/firmware_rollback_tests
976#	${BUILD}/tests/kernel_rollback_tests
977
978# Code coverage
979.PHONY: coverage_init
980coverage_init: test_setup
981	rm -f ${COV_INFO}*
982	lcov -c -i -d . -b . -o ${COV_INFO}.initial
983
984.PHONY: coverage_html
985coverage_html:
986	lcov -c -d . -b . -o ${COV_INFO}.tests
987	lcov -a ${COV_INFO}.initial -a ${COV_INFO}.tests -o ${COV_INFO}.total
988	lcov -r ${COV_INFO}.total '/usr/*' '*/linktest/*' -o ${COV_INFO}.local
989	genhtml ${COV_INFO}.local -o ${BUILD}/coverage
990
991# Generate addtional coverage stats just for firmware subdir, because the
992# per-directory stats for the whole project don't include their own subdirs.
993	lcov -e ${COV_INFO}.local '${SRCDIR}/firmware/*' \
994		-o ${COV_INFO}.firmware
995
996.PHONY: coverage
997ifeq (${COV},)
998coverage:
999	$(error Build coverage like this: make clean && COV=1 make)
1000else
1001coverage: coverage_init runtests coverage_html
1002endif
1003
1004