client.mk@925c144e1f1f
client.mk
Fri, 16 Jan 2015 18:13:44 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Fri, 16 Jan 2015 18:13:44 +0100
- branch
- TOR_BUG_9701
- changeset 14
- 925c144e1f1f
- permissions
- -rw-r--r--
Integrate suggestion from review to improve consistency with existing code.
1 # -*- makefile -*-
2 # vim:set ts=8 sw=8 sts=8 noet:
3 # This Source Code Form is subject to the terms of the Mozilla Public
4 # License, v. 2.0. If a copy of the MPL was not distributed with this
5 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
7 # Build a mozilla application.
8 #
9 # To build a tree,
10 # 1. hg clone ssh://hg.mozilla.org/mozilla-central mozilla
11 # 2. cd mozilla
12 # 3. create your .mozconfig file with
13 # ac_add_options --enable-application=browser
14 # 4. gmake -f client.mk
15 #
16 # Other targets (gmake -f client.mk [targets...]),
17 # build
18 # clean (realclean is now the same as clean)
19 # distclean
20 #
21 # See http://developer.mozilla.org/en/docs/Build_Documentation for
22 # more information.
23 #
24 # Options:
25 # MOZ_BUILD_PROJECTS - Build multiple projects in subdirectories
26 # of MOZ_OBJDIR
27 # MOZ_OBJDIR - Destination object directory
28 # MOZ_MAKE_FLAGS - Flags to pass to $(MAKE)
29 # MOZ_PREFLIGHT_ALL } - Makefiles to run before any project in
30 # MOZ_PREFLIGHT } MOZ_BUILD_PROJECTS, before each project, after
31 # MOZ_POSTFLIGHT } each project, and after all projects; these
32 # MOZ_POSTFLIGHT_ALL } variables contain space-separated lists
33 # MOZ_UNIFY_BDATE - Set to use the same bdate for each project in
34 # MOZ_BUILD_PROJECTS
35 #
36 #######################################################################
37 # Defines
39 comma := ,
41 CWD := $(CURDIR)
42 ifneq (1,$(words $(CWD)))
43 $(error The mozilla directory cannot be located in a path with spaces.)
44 endif
46 ifeq "$(CWD)" "/"
47 CWD := /.
48 endif
50 ifndef TOPSRCDIR
51 ifeq (,$(wildcard client.mk))
52 TOPSRCDIR := $(patsubst %/,%,$(dir $(MAKEFILE_LIST)))
53 MOZ_OBJDIR = .
54 else
55 TOPSRCDIR := $(CWD)
56 endif
57 endif
59 # try to find autoconf 2.13 - discard errors from 'which'
60 # MacOS X 10.4 sends "no autoconf*" errors to stdout, discard those via grep
61 AUTOCONF ?= $(shell which autoconf-2.13 autoconf2.13 autoconf213 2>/dev/null | grep -v '^no autoconf' | head -1)
63 # See if the autoconf package was installed through fink
64 ifeq (,$(strip $(AUTOCONF)))
65 AUTOCONF = $(shell which fink >/dev/null 2>&1 && echo `which fink`/../../lib/autoconf2.13/bin/autoconf)
66 endif
68 ifeq (,$(strip $(AUTOCONF)))
69 AUTOCONF=$(error Could not find autoconf 2.13)
70 endif
72 SH := /bin/sh
73 PERL ?= perl
74 PYTHON ?= python
76 CONFIG_GUESS_SCRIPT := $(wildcard $(TOPSRCDIR)/build/autoconf/config.guess)
77 ifdef CONFIG_GUESS_SCRIPT
78 CONFIG_GUESS := $(shell $(CONFIG_GUESS_SCRIPT))
79 endif
82 ####################################
83 # Sanity checks
85 # Windows checks.
86 ifneq (,$(findstring mingw,$(CONFIG_GUESS)))
88 # check for CRLF line endings
89 ifneq (0,$(shell $(PERL) -e 'binmode(STDIN); while (<STDIN>) { if (/\r/) { print "1"; exit } } print "0"' < $(TOPSRCDIR)/client.mk))
90 $(error This source tree appears to have Windows-style line endings. To \
91 convert it to Unix-style line endings, check \
92 "https://developer.mozilla.org/en-US/docs/Developer_Guide/Mozilla_build_FAQ\#Win32-specific_questions" \
93 for a workaround of this issue.)
94 endif
95 endif
97 ####################################
98 # Load mozconfig Options
100 # See build pages, http://www.mozilla.org/build/ for how to set up mozconfig.
102 MOZCONFIG_LOADER := build/autoconf/mozconfig2client-mk
104 define CR
107 endef
109 # As $(shell) doesn't preserve newlines, use sed to replace them with an
110 # unlikely sequence (||), which is then replaced back to newlines by make
111 # before evaluation. $(shell) replacing newlines with spaces, || is always
112 # followed by a space (since sed doesn't remove newlines), except on the
113 # last line, so replace both '|| ' and '||'.
114 MOZCONFIG_CONTENT := $(subst ||,$(CR),$(subst || ,$(CR),$(shell $(TOPSRCDIR)/$(MOZCONFIG_LOADER) $(TOPSRCDIR) | sed 's/$$/||/')))
115 $(eval $(MOZCONFIG_CONTENT))
117 export FOUND_MOZCONFIG
119 # As '||' was used as a newline separator, it means it's not occurring in
120 # lines themselves. It can thus safely be used to replaces normal spaces,
121 # to then replace newlines with normal spaces. This allows to get a list
122 # of mozconfig output lines.
123 MOZCONFIG_OUT_LINES := $(subst $(CR), ,$(subst $(NULL) $(NULL),||,$(MOZCONFIG_CONTENT)))
124 # Filter-out comments from those lines.
125 START_COMMENT = \#
126 MOZCONFIG_OUT_FILTERED := $(filter-out $(START_COMMENT)%,$(MOZCONFIG_OUT_LINES))
128 ifdef AUTOCLOBBER
129 export AUTOCLOBBER=1
130 endif
131 export MOZ_PGO
133 ifdef MOZ_PARALLEL_BUILD
134 MOZ_MAKE_FLAGS := $(filter-out -j%,$(MOZ_MAKE_FLAGS))
135 MOZ_MAKE_FLAGS += -j$(MOZ_PARALLEL_BUILD)
136 endif
138 # Automatically add -jN to make flags if not defined. N defaults to number of cores.
139 ifeq (,$(findstring -j,$(MOZ_MAKE_FLAGS)))
140 cores=$(shell $(PYTHON) -c 'import multiprocessing; print(multiprocessing.cpu_count())')
141 MOZ_MAKE_FLAGS += -j$(cores)
142 endif
145 ifndef MOZ_OBJDIR
146 MOZ_OBJDIR = obj-$(CONFIG_GUESS)
147 else
148 # On Windows Pymake builds check MOZ_OBJDIR doesn't start with "/"
149 ifneq (,$(findstring mingw,$(CONFIG_GUESS)))
150 ifeq (1_a,$(.PYMAKE)_$(firstword a$(subst /, ,$(MOZ_OBJDIR))))
151 $(error For Windows Pymake builds, MOZ_OBJDIR must be a Windows [and not MSYS] style path.)
152 endif
153 endif
154 endif
156 ifdef MOZ_BUILD_PROJECTS
158 ifdef MOZ_CURRENT_PROJECT
159 OBJDIR = $(MOZ_OBJDIR)/$(MOZ_CURRENT_PROJECT)
160 MOZ_MAKE = $(MAKE) $(MOZ_MAKE_FLAGS) -C $(OBJDIR)
161 BUILD_PROJECT_ARG = MOZ_BUILD_APP=$(MOZ_CURRENT_PROJECT)
162 else
163 OBJDIR = $(error Cannot find the OBJDIR when MOZ_CURRENT_PROJECT is not set.)
164 MOZ_MAKE = $(error Cannot build in the OBJDIR when MOZ_CURRENT_PROJECT is not set.)
165 endif
167 else # MOZ_BUILD_PROJECTS
169 OBJDIR = $(MOZ_OBJDIR)
170 MOZ_MAKE = $(MAKE) $(MOZ_MAKE_FLAGS) -C $(OBJDIR)
172 endif # MOZ_BUILD_PROJECTS
174 # 'configure' scripts generated by autoconf.
175 CONFIGURES := $(TOPSRCDIR)/configure
176 CONFIGURES += $(TOPSRCDIR)/js/src/configure
178 # Make targets that are going to be passed to the real build system
179 OBJDIR_TARGETS = install export libs clean realclean distclean maybe_clobber_profiledbuild upload sdk installer package package-compare stage-package source-package l10n-check automation/build
181 #######################################################################
182 # Rules
184 # The default rule is build
185 build::
186 $(MAKE) -f $(TOPSRCDIR)/client.mk $(if $(MOZ_PGO),profiledbuild,realbuild)
188 # Define mkdir
189 include $(TOPSRCDIR)/config/makefiles/makeutils.mk
190 include $(TOPSRCDIR)/config/makefiles/autotargets.mk
192 # Create a makefile containing the mk_add_options values from mozconfig,
193 # but only do so when OBJDIR is defined (see further above).
194 ifdef MOZ_BUILD_PROJECTS
195 ifdef MOZ_CURRENT_PROJECT
196 WANT_MOZCONFIG_MK = 1
197 else
198 WANT_MOZCONFIG_MK =
199 endif
200 else
201 WANT_MOZCONFIG_MK = 1
202 endif
204 ifdef WANT_MOZCONFIG_MK
205 # For now, only output "export" lines from mozconfig2client-mk output.
206 MOZCONFIG_MK_LINES := $(filter export||%,$(MOZCONFIG_OUT_LINES))
207 $(OBJDIR)/.mozconfig.mk: $(FOUND_MOZCONFIG) $(call mkdir_deps,$(OBJDIR)) $(OBJDIR)/CLOBBER
208 $(if $(MOZCONFIG_MK_LINES),( $(foreach line,$(MOZCONFIG_MK_LINES), echo '$(subst ||, ,$(line))';) )) > $@
210 # Include that makefile so that it is created. This should not actually change
211 # the environment since MOZCONFIG_CONTENT, which MOZCONFIG_OUT_LINES derives
212 # from, has already been eval'ed.
213 include $(OBJDIR)/.mozconfig.mk
214 endif
216 # Print out any options loaded from mozconfig.
217 all realbuild clean distclean export libs install realclean::
218 ifneq (,$(strip $(MOZCONFIG_OUT_FILTERED)))
219 $(info Adding client.mk options from $(FOUND_MOZCONFIG):)
220 $(foreach line,$(MOZCONFIG_OUT_FILTERED),$(info $(NULL) $(NULL) $(NULL) $(NULL) $(subst ||, ,$(line))))
221 endif
223 # Windows equivalents
224 build_all: build
225 clobber clobber_all: clean
227 # helper target for mobile
228 build_and_deploy: build package install
230 # Do everything from scratch
231 everything: clean build
233 ####################################
234 # Profile-Guided Optimization
235 # This is up here, outside of the MOZ_CURRENT_PROJECT logic so that this
236 # is usable in multi-pass builds, where you might not have a runnable
237 # application until all the build passes and postflight scripts have run.
238 ifdef MOZ_OBJDIR
239 PGO_OBJDIR = $(MOZ_OBJDIR)
240 else
241 PGO_OBJDIR := $(TOPSRCDIR)
242 endif
244 profiledbuild::
245 $(MAKE) -f $(TOPSRCDIR)/client.mk realbuild MOZ_PROFILE_GENERATE=1 MOZ_PGO_INSTRUMENTED=1
246 $(MAKE) -C $(PGO_OBJDIR) package MOZ_PGO_INSTRUMENTED=1 MOZ_INTERNAL_SIGNING_FORMAT= MOZ_EXTERNAL_SIGNING_FORMAT=
247 rm -f ${PGO_OBJDIR}/jarlog/en-US.log
248 MOZ_PGO_INSTRUMENTED=1 JARLOG_FILE=jarlog/en-US.log EXTRA_TEST_ARGS=10 $(MAKE) -C $(PGO_OBJDIR) pgo-profile-run
249 $(MAKE) -f $(TOPSRCDIR)/client.mk maybe_clobber_profiledbuild
250 $(MAKE) -f $(TOPSRCDIR)/client.mk realbuild MOZ_PROFILE_USE=1
252 #####################################################
253 # Build date unification
255 ifdef MOZ_UNIFY_BDATE
256 ifndef MOZ_BUILD_DATE
257 ifdef MOZ_BUILD_PROJECTS
258 MOZ_BUILD_DATE = $(shell $(PYTHON) $(TOPSRCDIR)/toolkit/xre/make-platformini.py --print-buildid)
259 export MOZ_BUILD_DATE
260 endif
261 endif
262 endif
264 #####################################################
265 # Preflight, before building any project
267 realbuild preflight_all::
268 ifeq (,$(MOZ_CURRENT_PROJECT)$(if $(MOZ_PREFLIGHT_ALL),,1))
269 # Don't run preflight_all for individual projects in multi-project builds
270 # (when MOZ_CURRENT_PROJECT is set.)
271 ifndef MOZ_BUILD_PROJECTS
272 # Building a single project, OBJDIR is usable.
273 set -e; \
274 for mkfile in $(MOZ_PREFLIGHT_ALL); do \
275 $(MAKE) -f $(TOPSRCDIR)/$$mkfile preflight_all TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
276 done
277 else
278 # OBJDIR refers to the project-specific OBJDIR, which is not available at
279 # this point when building multiple projects. Only MOZ_OBJDIR is available.
280 set -e; \
281 for mkfile in $(MOZ_PREFLIGHT_ALL); do \
282 $(MAKE) -f $(TOPSRCDIR)/$$mkfile preflight_all TOPSRCDIR=$(TOPSRCDIR) MOZ_OBJDIR=$(MOZ_OBJDIR) MOZ_BUILD_PROJECTS='$(MOZ_BUILD_PROJECTS)'; \
283 done
284 endif
285 endif
287 # If we're building multiple projects, but haven't specified which project,
288 # loop through them.
290 ifeq (,$(MOZ_CURRENT_PROJECT)$(if $(MOZ_BUILD_PROJECTS),,1))
291 configure realbuild preflight postflight $(OBJDIR_TARGETS)::
292 set -e; \
293 for app in $(MOZ_BUILD_PROJECTS); do \
294 $(MAKE) -f $(TOPSRCDIR)/client.mk $@ MOZ_CURRENT_PROJECT=$$app; \
295 done
297 else
299 # MOZ_CURRENT_PROJECT: either doing a single-project build, or building an
300 # individual project in a multi-project build.
302 ####################################
303 # Configure
305 MAKEFILE = $(wildcard $(OBJDIR)/Makefile)
306 CONFIG_STATUS = $(wildcard $(OBJDIR)/config.status)
307 CONFIG_CACHE = $(wildcard $(OBJDIR)/config.cache)
309 EXTRA_CONFIG_DEPS := \
310 $(TOPSRCDIR)/aclocal.m4 \
311 $(wildcard $(TOPSRCDIR)/build/autoconf/*.m4) \
312 $(TOPSRCDIR)/js/src/aclocal.m4 \
313 $(NULL)
315 $(CONFIGURES): %: %.in $(EXTRA_CONFIG_DEPS)
316 @echo Generating $@ using autoconf
317 cd $(@D); $(AUTOCONF)
319 CONFIG_STATUS_DEPS := \
320 $(wildcard $(TOPSRCDIR)/*/confvars.sh) \
321 $(CONFIGURES) \
322 $(TOPSRCDIR)/CLOBBER \
323 $(TOPSRCDIR)/nsprpub/configure \
324 $(TOPSRCDIR)/config/milestone.txt \
325 $(TOPSRCDIR)/browser/config/version.txt \
326 $(TOPSRCDIR)/build/virtualenv_packages.txt \
327 $(TOPSRCDIR)/python/mozbuild/mozbuild/virtualenv.py \
328 $(TOPSRCDIR)/testing/mozbase/packages.txt \
329 $(NULL)
331 CONFIGURE_ENV_ARGS += \
332 MAKE='$(MAKE)' \
333 $(NULL)
335 # configure uses the program name to determine @srcdir@. Calling it without
336 # $(TOPSRCDIR) will set @srcdir@ to "."; otherwise, it is set to the full
337 # path of $(TOPSRCDIR).
338 ifeq ($(TOPSRCDIR),$(OBJDIR))
339 CONFIGURE = ./configure
340 else
341 CONFIGURE = $(TOPSRCDIR)/configure
342 endif
344 $(OBJDIR)/CLOBBER: $(TOPSRCDIR)/CLOBBER
345 $(PYTHON) $(TOPSRCDIR)/config/pythonpath.py -I $(TOPSRCDIR)/testing/mozbase/mozfile \
346 $(TOPSRCDIR)/python/mozbuild/mozbuild/controller/clobber.py $(TOPSRCDIR) $(OBJDIR)
348 configure-files: $(CONFIGURES)
350 configure-preqs = \
351 $(OBJDIR)/CLOBBER \
352 configure-files \
353 $(call mkdir_deps,$(OBJDIR)) \
354 $(if $(MOZ_BUILD_PROJECTS),$(call mkdir_deps,$(MOZ_OBJDIR))) \
355 save-mozconfig \
356 $(NULL)
358 save-mozconfig: $(FOUND_MOZCONFIG)
359 -cp $(FOUND_MOZCONFIG) $(OBJDIR)/.mozconfig
361 configure:: $(configure-preqs)
362 @echo cd $(OBJDIR);
363 @echo $(CONFIGURE) $(CONFIGURE_ARGS)
364 @cd $(OBJDIR) && $(BUILD_PROJECT_ARG) $(CONFIGURE_ENV_ARGS) $(CONFIGURE) $(CONFIGURE_ARGS) \
365 || ( echo '*** Fix above errors and then restart with\
366 "$(MAKE) -f client.mk build"' && exit 1 )
367 @touch $(OBJDIR)/Makefile
369 ifneq (,$(MAKEFILE))
370 $(OBJDIR)/Makefile: $(OBJDIR)/config.status
372 $(OBJDIR)/config.status: $(CONFIG_STATUS_DEPS)
373 else
374 $(OBJDIR)/Makefile: $(CONFIG_STATUS_DEPS)
375 endif
376 @$(MAKE) -f $(TOPSRCDIR)/client.mk configure
378 ifneq (,$(CONFIG_STATUS))
379 $(OBJDIR)/config/autoconf.mk: $(TOPSRCDIR)/config/autoconf.mk.in
380 $(PYTHON) $(OBJDIR)/config.status -n --file=$(OBJDIR)/config/autoconf.mk
381 endif
384 ####################################
385 # Preflight
387 realbuild preflight::
388 ifdef MOZ_PREFLIGHT
389 set -e; \
390 for mkfile in $(MOZ_PREFLIGHT); do \
391 $(MAKE) -f $(TOPSRCDIR)/$$mkfile preflight TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
392 done
393 endif
395 ####################################
396 # Build it
398 realbuild:: $(OBJDIR)/Makefile $(OBJDIR)/config.status
399 +$(MOZ_MAKE)
401 ####################################
402 # Other targets
404 # Pass these target onto the real build system
405 $(OBJDIR_TARGETS):: $(OBJDIR)/Makefile $(OBJDIR)/config.status
406 +$(MOZ_MAKE) $@
408 ####################################
409 # Postflight
411 realbuild postflight::
412 ifdef MOZ_POSTFLIGHT
413 set -e; \
414 for mkfile in $(MOZ_POSTFLIGHT); do \
415 $(MAKE) -f $(TOPSRCDIR)/$$mkfile postflight TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
416 done
417 endif
419 endif # MOZ_CURRENT_PROJECT
421 ####################################
422 # Postflight, after building all projects
424 realbuild postflight_all::
425 ifeq (,$(MOZ_CURRENT_PROJECT)$(if $(MOZ_POSTFLIGHT_ALL),,1))
426 # Don't run postflight_all for individual projects in multi-project builds
427 # (when MOZ_CURRENT_PROJECT is set.)
428 ifndef MOZ_BUILD_PROJECTS
429 # Building a single project, OBJDIR is usable.
430 set -e; \
431 for mkfile in $(MOZ_POSTFLIGHT_ALL); do \
432 $(MAKE) -f $(TOPSRCDIR)/$$mkfile postflight_all TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
433 done
434 else
435 # OBJDIR refers to the project-specific OBJDIR, which is not available at
436 # this point when building multiple projects. Only MOZ_OBJDIR is available.
437 set -e; \
438 for mkfile in $(MOZ_POSTFLIGHT_ALL); do \
439 $(MAKE) -f $(TOPSRCDIR)/$$mkfile postflight_all TOPSRCDIR=$(TOPSRCDIR) MOZ_OBJDIR=$(MOZ_OBJDIR) MOZ_BUILD_PROJECTS='$(MOZ_BUILD_PROJECTS)'; \
440 done
441 endif
442 endif
444 cleansrcdir:
445 @cd $(TOPSRCDIR); \
446 if [ -f Makefile ]; then \
447 $(MAKE) distclean ; \
448 else \
449 echo 'Removing object files from srcdir...'; \
450 rm -fr `find . -type d \( -name .deps -print -o -name CVS \
451 -o -exec test ! -d {}/CVS \; \) -prune \
452 -o \( -name '*.[ao]' -o -name '*.so' \) -type f -print`; \
453 build/autoconf/clean-config.sh; \
454 fi;
456 echo-variable-%:
457 @echo $($*)
459 # This makefile doesn't support parallel execution. It does pass
460 # MOZ_MAKE_FLAGS to sub-make processes, so they will correctly execute
461 # in parallel.
462 .NOTPARALLEL:
464 .PHONY: checkout \
465 real_checkout \
466 realbuild \
467 build \
468 profiledbuild \
469 cleansrcdir \
470 pull_all \
471 build_all \
472 clobber \
473 clobber_all \
474 pull_and_build_all \
475 everything \
476 configure \
477 preflight_all \
478 preflight \
479 postflight \
480 postflight_all \
481 $(OBJDIR_TARGETS)
