blob: e0a7510d756f631b000f9d0871b3b10dcbd79b27 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001DESTDIR=/usr/local
Manuel Pégourié-Gonnard52859702015-01-27 14:05:16 +01002PREFIX=mbedtls_
Gilles Peskine687d1ab2021-04-22 01:01:56 +02003PERL ?= perl
Paul Bakker5121ce52009-01-03 21:22:43 +00004
Gilles Peskine48230e82024-03-04 16:42:54 +01005ifneq (,$(filter-out lib library/%,$(or $(MAKECMDGOALS),all)))
6 ifeq (,$(wildcard framework/exported.make))
7 # Use the define keyword to get a multi-line message.
8 # GNU make appends ". Stop.", so tweak the ending of our message accordingly.
9 define error_message
10$(MBEDTLS_PATH)/framework/exported.make not found.
11Run `git submodule update --init` to fetch the submodule contents.
12This is a fatal error
13 endef
14 $(error $(error_message))
15 endif
16 include framework/exported.make
17endif
Gilles Peskine469f7812024-02-29 18:19:56 +010018
Paul Bakker5121ce52009-01-03 21:22:43 +000019.SILENT:
20
Gilles Peskine0ab6c8a2022-12-08 22:18:31 +010021.PHONY: all no_test programs lib tests install uninstall clean test check lcov apidoc apidoc_clean
Paul Bakker5121ce52009-01-03 21:22:43 +000022
Andres AG7aa5fa12016-08-25 16:36:16 +010023all: programs tests
24 $(MAKE) post_build
Alon Bar-Lev06f0d262015-02-18 17:18:28 +020025
Manuel Pégourié-Gonnard5c59a4f2015-06-24 13:06:24 +020026no_test: programs
27
Ronald Cronddaf99c2020-06-19 11:27:26 +020028programs: lib mbedtls_test
Alon Bar-Lev06f0d262015-02-18 17:18:28 +020029 $(MAKE) -C programs
Paul Bakkerf9964ab2012-04-05 12:07:50 +000030
31lib:
Alon Bar-Lev06f0d262015-02-18 17:18:28 +020032 $(MAKE) -C library
33
Ronald Cronddaf99c2020-06-19 11:27:26 +020034tests: lib mbedtls_test
Alon Bar-Lev06f0d262015-02-18 17:18:28 +020035 $(MAKE) -C tests
Paul Bakkerf9964ab2012-04-05 12:07:50 +000036
Ronald Cronddaf99c2020-06-19 11:27:26 +020037mbedtls_test:
38 $(MAKE) -C tests mbedtls_test
39
Gilles Peskine687d1ab2021-04-22 01:01:56 +020040library/%:
41 $(MAKE) -C library $*
42programs/%:
43 $(MAKE) -C programs $*
44tests/%:
45 $(MAKE) -C tests $*
46
47.PHONY: generated_files
48generated_files: library/generated_files
49generated_files: programs/generated_files
50generated_files: tests/generated_files
51generated_files: visualc_files
52
Gilles Peskine0b62b7a2023-09-08 16:19:13 +020053# Set GEN_FILES to the empty string to disable dependencies on generated
54# source files. Then `make generated_files` will only build files that
55# are missing, it will not rebuilt files that are present but out of date.
56# This is useful, for example, if you have a source tree where
57# `make generated_files` has already run and file timestamps reflect the
58# time the files were copied or extracted, and you are now in an environment
59# that lacks some of the necessary tools to re-generate the files.
60# If $(GEN_FILES) is non-empty, the generated source files' dependencies
61# are treated ordinarily, based on file timestamps.
David Horstmann0d111762024-08-28 20:49:12 +010062GEN_FILES ?=
Gilles Peskine0b62b7a2023-09-08 16:19:13 +020063
64# In dependencies where the target is a configuration-independent generated
65# file, use `TARGET: $(gen_file_dep) DEPENDENCY1 DEPENDENCY2 ...`
66# rather than directly `TARGET: DEPENDENCY1 DEPENDENCY2 ...`. This
67# enables the re-generation to be turned off when GEN_FILES is disabled.
68ifdef GEN_FILES
69gen_file_dep =
70else
Gilles Peskine1bfc09b2023-09-09 21:26:05 +020071# Order-only dependency: generate the target if it's absent, but don't
72# re-generate it if it's present but older than its dependencies.
Gilles Peskine0b62b7a2023-09-08 16:19:13 +020073gen_file_dep = |
74endif
75
Gilles Peskine687d1ab2021-04-22 01:01:56 +020076.PHONY: visualc_files
Bence Szépkútifac11222024-03-12 16:38:23 +010077VISUALC_FILES = visualc/VS2017/mbedTLS.sln visualc/VS2017/mbedTLS.vcxproj
Gilles Peskine687d1ab2021-04-22 01:01:56 +020078# TODO: $(app).vcxproj for each $(app) in programs/
79visualc_files: $(VISUALC_FILES)
Gilles Peskine94230ea2021-05-18 15:48:56 +020080
81# Ensure that the .c files that generate_visualc_files.pl enumerates are
Gilles Peskinea13deaf2021-05-19 14:26:37 +020082# present before it runs. It doesn't matter if the files aren't up-to-date,
83# they just need to be present.
84$(VISUALC_FILES): | library/generated_files
Gilles Peskine0b62b7a2023-09-08 16:19:13 +020085$(VISUALC_FILES): $(gen_file_dep) scripts/generate_visualc_files.pl
Bence Szépkútifac11222024-03-12 16:38:23 +010086$(VISUALC_FILES): $(gen_file_dep) scripts/data_files/vs2017-app-template.vcxproj
87$(VISUALC_FILES): $(gen_file_dep) scripts/data_files/vs2017-main-template.vcxproj
88$(VISUALC_FILES): $(gen_file_dep) scripts/data_files/vs2017-sln-template.sln
Gilles Peskine687d1ab2021-04-22 01:01:56 +020089# TODO: also the list of .c and .h source files, but not their content
90$(VISUALC_FILES):
91 echo " Gen $@ ..."
92 $(PERL) scripts/generate_visualc_files.pl
93
Manuel Pégourié-Gonnard5c59a4f2015-06-24 13:06:24 +020094ifndef WINDOWS
Manuel Pégourié-Gonnard99839932015-08-03 10:34:09 +020095install: no_test
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000096 mkdir -p $(DESTDIR)/include/mbedtls
Ruini Xue5a9cb612018-06-28 23:21:26 +080097 cp -rp include/mbedtls $(DESTDIR)/include
Jaeden Amero3c7cc5e2018-11-15 17:38:58 +000098 mkdir -p $(DESTDIR)/include/psa
99 cp -rp include/psa $(DESTDIR)/include
Darryl Green11999bb2018-03-13 15:22:58 +0000100
Paul Bakker5121ce52009-01-03 21:22:43 +0000101 mkdir -p $(DESTDIR)/lib
Gilles Peskine722a7e62020-02-26 19:05:19 +0100102 cp -RP library/libmbedtls.* $(DESTDIR)/lib
103 cp -RP library/libmbedx509.* $(DESTDIR)/lib
Manuel Pégourié-Gonnard52a50792015-07-27 10:36:12 +0200104 cp -RP library/libmbedcrypto.* $(DESTDIR)/lib
Darryl Green11999bb2018-03-13 15:22:58 +0000105
Paul Bakker5121ce52009-01-03 21:22:43 +0000106 mkdir -p $(DESTDIR)/bin
107 for p in programs/*/* ; do \
108 if [ -x $$p ] && [ ! -d $$p ] ; \
109 then \
110 f=$(PREFIX)`basename $$p` ; \
111 cp $$p $(DESTDIR)/bin/$$f ; \
112 fi \
113 done
114
Paul Bakker9a736322012-11-14 12:39:52 +0000115uninstall:
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +0000116 rm -rf $(DESTDIR)/include/mbedtls
Wu, Jheng-Jhong89b98142020-11-26 09:27:17 +0800117 rm -rf $(DESTDIR)/include/psa
Gilles Peskine722a7e62020-02-26 19:05:19 +0100118 rm -f $(DESTDIR)/lib/libmbedtls.*
119 rm -f $(DESTDIR)/lib/libmbedx509.*
Manuel Pégourié-Gonnard52a50792015-07-27 10:36:12 +0200120 rm -f $(DESTDIR)/lib/libmbedcrypto.*
Darryl Green11999bb2018-03-13 15:22:58 +0000121
Paul Bakker9a736322012-11-14 12:39:52 +0000122 for p in programs/*/* ; do \
123 if [ -x $$p ] && [ ! -d $$p ] ; \
124 then \
125 f=$(PREFIX)`basename $$p` ; \
126 rm -f $(DESTDIR)/bin/$$f ; \
127 fi \
128 done
Manuel Pégourié-Gonnard5c59a4f2015-06-24 13:06:24 +0200129endif
Paul Bakker9a736322012-11-14 12:39:52 +0000130
Simon Butcher1ceab6e2016-06-21 10:14:00 +0100131
Nir Sonnenscheinb7ebbca2018-08-29 10:20:12 +0300132WARNING_BORDER_LONG =**********************************************************************************\n
133CTR_DRBG_128_BIT_KEY_WARN_L1=**** WARNING! MBEDTLS_CTR_DRBG_USE_128_BIT_KEY defined! ****\n
134CTR_DRBG_128_BIT_KEY_WARN_L2=**** Using 128-bit keys for CTR_DRBG limits the security of generated ****\n
135CTR_DRBG_128_BIT_KEY_WARN_L3=**** keys and operations that use random values generated to 128-bit security ****\n
136
137CTR_DRBG_128_BIT_KEY_WARNING=\n$(WARNING_BORDER_LONG)$(CTR_DRBG_128_BIT_KEY_WARN_L1)$(CTR_DRBG_128_BIT_KEY_WARN_L2)$(CTR_DRBG_128_BIT_KEY_WARN_L3)$(WARNING_BORDER_LONG)
138
Simon Butcher1ceab6e2016-06-21 10:14:00 +0100139# Post build steps
140post_build:
Simon Butchercff625f2016-06-27 15:15:11 +0100141ifndef WINDOWS
Nir Sonnenscheinb7ebbca2018-08-29 10:20:12 +0300142
143 # If 128-bit keys are configured for CTR_DRBG, display an appropriate warning
Gilles Peskine3bdd4122019-07-27 23:52:53 +0200144 -scripts/config.py get MBEDTLS_CTR_DRBG_USE_128_BIT_KEY && ([ $$? -eq 0 ]) && \
Nir Sonnenscheinb7ebbca2018-08-29 10:20:12 +0300145 echo '$(CTR_DRBG_128_BIT_KEY_WARNING)'
146
Simon Butchercff625f2016-06-27 15:15:11 +0100147endif
Simon Butcher1ceab6e2016-06-21 10:14:00 +0100148
Gilles Peskine687d1ab2021-04-22 01:01:56 +0200149clean: clean_more_on_top
Alon Bar-Lev06f0d262015-02-18 17:18:28 +0200150 $(MAKE) -C library clean
151 $(MAKE) -C programs clean
152 $(MAKE) -C tests clean
Gilles Peskine687d1ab2021-04-22 01:01:56 +0200153
154clean_more_on_top:
Manuel Pégourié-Gonnard5c59a4f2015-06-24 13:06:24 +0200155ifndef WINDOWS
Paul Bakkerbd3b3592016-07-13 16:37:32 +0100156 find . \( -name \*.gcno -o -name \*.gcda -o -name \*.info \) -exec rm {} +
Manuel Pégourié-Gonnard5c59a4f2015-06-24 13:06:24 +0200157endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000158
Gilles Peskine687d1ab2021-04-22 01:01:56 +0200159neat: clean_more_on_top
160 $(MAKE) -C library neat
161 $(MAKE) -C programs neat
162 $(MAKE) -C tests neat
163ifndef WINDOWS
Bence Szépkútifac11222024-03-12 16:38:23 +0100164 rm -f visualc/VS2017/*.vcxproj visualc/VS2017/mbedTLS.sln
Gilles Peskine687d1ab2021-04-22 01:01:56 +0200165else
Bence Szépkútifac11222024-03-12 16:38:23 +0100166 if exist visualc\VS2017\*.vcxproj del /Q /F visualc\VS2017\*.vcxproj
167 if exist visualc\VS2017\mbedTLS.sln del /Q /F visualc\VS2017\mbedTLS.sln
Gilles Peskine687d1ab2021-04-22 01:01:56 +0200168endif
169
Andres AGc49b8082016-08-31 16:10:45 +0100170check: lib tests
Alon Bar-Lev06f0d262015-02-18 17:18:28 +0200171 $(MAKE) -C tests check
Paul Bakker37ca75d2011-01-06 12:28:03 +0000172
Manuel Pégourié-Gonnard5c59a4f2015-06-24 13:06:24 +0200173test: check
Manuel Pégourié-Gonnard6529ff02014-01-31 13:41:07 +0100174
Manuel Pégourié-Gonnard85113842015-07-08 21:20:03 +0100175ifndef WINDOWS
Gilles Peskine0ab6c8a2022-12-08 22:18:31 +0100176# For coverage testing:
177# 1. Build with:
178# make CFLAGS='--coverage -g3 -O0' LDFLAGS='--coverage'
179# 2. Run the relevant tests for the part of the code you're interested in.
180# For the reference coverage measurement, see
181# tests/scripts/basic-build-test.sh
182# 3. Run scripts/lcov.sh to generate an HTML report.
Manuel Pégourié-Gonnard546d86c2014-01-31 16:19:43 +0100183lcov:
Gilles Peskine3d4ea542022-11-30 17:35:44 +0100184 scripts/lcov.sh
Manuel Pégourié-Gonnard546d86c2014-01-31 16:19:43 +0100185
Paul Bakker37ca75d2011-01-06 12:28:03 +0000186apidoc:
187 mkdir -p apidoc
Krzysztof Stachowiak744a4ac2018-01-22 13:38:31 +0100188 cd doxygen && doxygen mbedtls.doxyfile
Paul Bakker37ca75d2011-01-06 12:28:03 +0000189
190apidoc_clean:
Manuel Pégourié-Gonnard5c59a4f2015-06-24 13:06:24 +0200191 rm -rf apidoc
192endif
Gilles Peskine66c1e2c2018-01-16 14:04:05 +0100193
194## Editor navigation files
Gilles Peskine646ad222020-11-09 21:20:16 +0100195C_SOURCE_FILES = $(wildcard \
196 3rdparty/*/include/*/*.h 3rdparty/*/include/*/*/*.h 3rdparty/*/include/*/*/*/*.h \
197 3rdparty/*/*.c 3rdparty/*/*/*.c 3rdparty/*/*/*/*.c 3rdparty/*/*/*/*/*.c \
198 include/*/*.h \
199 library/*.[hc] \
200 programs/*/*.[hc] \
201 tests/include/*/*.h tests/include/*/*/*.h \
202 tests/src/*.c tests/src/*/*.c \
203 tests/suites/*.function \
204)
Manuel Pégourié-Gonnardc9f89562020-04-02 12:10:45 +0200205# Exuberant-ctags invocation. Other ctags implementations may require different options.
Gilles Peskineb305b002021-01-13 13:45:30 +0100206CTAGS = ctags --langmap=c:+.h.function --line-directives=no -o
Gilles Peskine66c1e2c2018-01-16 14:04:05 +0100207tags: $(C_SOURCE_FILES)
Manuel Pégourié-Gonnardc9f89562020-04-02 12:10:45 +0200208 $(CTAGS) $@ $(C_SOURCE_FILES)
Gilles Peskine66c1e2c2018-01-16 14:04:05 +0100209TAGS: $(C_SOURCE_FILES)
Gilles Peskineb305b002021-01-13 13:45:30 +0100210 etags --no-line-directive -o $@ $(C_SOURCE_FILES)
Gilles Peskine8346c7a2020-11-20 11:50:08 +0100211global: GPATH GRTAGS GSYMS GTAGS
Gilles Peskine66c1e2c2018-01-16 14:04:05 +0100212GPATH GRTAGS GSYMS GTAGS: $(C_SOURCE_FILES)
213 ls $(C_SOURCE_FILES) | gtags -f - --gtagsconf .globalrc
Gilles Peskine8346c7a2020-11-20 11:50:08 +0100214cscope: cscope.in.out cscope.po.out cscope.out
Gilles Peskined0c78012020-11-09 21:21:31 +0100215cscope.in.out cscope.po.out cscope.out: $(C_SOURCE_FILES)
216 cscope -bq -u -Iinclude -Ilibrary $(patsubst %,-I%,$(wildcard 3rdparty/*/include)) -Itests/include $(C_SOURCE_FILES)
Gilles Peskine8346c7a2020-11-20 11:50:08 +0100217.PHONY: cscope global