client.mk

   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/.
   6
   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
  38
  39 comma := ,
  40
  41 CWD := $(CURDIR)
  42 ifneq (1,$(words $(CWD)))
  43 $(error The mozilla directory cannot be located in a path with spaces.)
  44 endif
  45
  46 ifeq "$(CWD)" "/"
  47 CWD   := /.
  48 endif
  49
  50 ifndef TOPSRCDIR
  51 ifeq (,$(wildcard client.mk))
  52 TOPSRCDIR := $(patsubst %/,%,$(dir $(MAKEFILE_LIST)))
  53 else
  54 TOPSRCDIR := $(CWD)
  55 endif
  56 endif
  57
  58 # try to find autoconf 2.13 - discard errors from 'which'
  59 # MacOS X 10.4 sends "no autoconf*" errors to stdout, discard those via grep
  60 AUTOCONF ?= $(shell which autoconf-2.13 autoconf2.13 autoconf213 2>/dev/null | grep -v '^no autoconf' | head -1)
  61
  62 # See if the autoconf package was installed through fink
  63 ifeq (,$(strip $(AUTOCONF)))
  64 AUTOCONF = $(shell which fink >/dev/null 2>&1 && echo `which fink`/../../lib/autoconf2.13/bin/autoconf)
  65 endif
  66
  67 ifeq (,$(strip $(AUTOCONF)))
  68 AUTOCONF=$(error Could not find autoconf 2.13)
  69 endif
  70
  71 SH := /bin/sh
  72 PERL ?= perl
  73 PYTHON ?= python
  74
  75 CONFIG_GUESS_SCRIPT := $(wildcard $(TOPSRCDIR)/build/autoconf/config.guess)
  76 ifdef CONFIG_GUESS_SCRIPT
  77   CONFIG_GUESS := $(shell $(CONFIG_GUESS_SCRIPT))
  78 endif
  79
  80
  81 ####################################
  82 # Sanity checks
  83
  84 # Windows checks.
  85 ifneq (,$(findstring mingw,$(CONFIG_GUESS)))
  86
  87 # check for CRLF line endings
  88 ifneq (0,$(shell $(PERL) -e 'binmode(STDIN); while (<STDIN>) { if (/\r/) { print "1"; exit } } print "0"' < $(TOPSRCDIR)/client.mk))
  89 $(error This source tree appears to have Windows-style line endings. To \
  90 convert it to Unix-style line endings, check \
  91 "https://developer.mozilla.org/en-US/docs/Developer_Guide/Mozilla_build_FAQ\#Win32-specific_questions" \
  92 for a workaround of this issue.)
  93 endif
  94 endif
  95
  96 ####################################
  97 # Load mozconfig Options
  98
  99 # See build pages, http://www.mozilla.org/build/ for how to set up mozconfig.
 100
 101 define CR
 102
 103
 104 endef
 105
 106 # As $(shell) doesn't preserve newlines, use sed to replace them with an
 107 # unlikely sequence (||), which is then replaced back to newlines by make
 108 # before evaluation. $(shell) replacing newlines with spaces, || is always
 109 # followed by a space (since sed doesn't remove newlines), except on the
 110 # last line, so replace both '|| ' and '||'.
 111 # Also, make MOZ_PGO available to mozconfig when passed on make command line.
 112 # Likewise for MOZ_CURRENT_PROJECT.
 113 MOZCONFIG_CONTENT := $(subst ||,$(CR),$(subst || ,$(CR),$(shell $(addprefix MOZ_CURRENT_PROJECT=,$(MOZ_CURRENT_PROJECT)) MOZ_PGO=$(MOZ_PGO) $(TOPSRCDIR)/mach environment --format=client.mk | sed 's/$$/||/')))
 114 $(eval $(MOZCONFIG_CONTENT))
 115
 116 export FOUND_MOZCONFIG
 117
 118 # As '||' was used as a newline separator, it means it's not occurring in
 119 # lines themselves. It can thus safely be used to replaces normal spaces,
 120 # to then replace newlines with normal spaces. This allows to get a list
 121 # of mozconfig output lines.
 122 MOZCONFIG_OUT_LINES := $(subst $(CR), ,$(subst $(NULL) $(NULL),||,$(MOZCONFIG_CONTENT)))
 123 # Filter-out comments from those lines.
 124 START_COMMENT = \#
 125 MOZCONFIG_OUT_FILTERED := $(filter-out $(START_COMMENT)%,$(MOZCONFIG_OUT_LINES))
 126
 127 ifdef AUTOCLOBBER
 128 export AUTOCLOBBER=1
 129 endif
 130 export MOZ_PGO
 131
 132 ifdef MOZ_PARALLEL_BUILD
 133   MOZ_MAKE_FLAGS := $(filter-out -j%,$(MOZ_MAKE_FLAGS))
 134   MOZ_MAKE_FLAGS += -j$(MOZ_PARALLEL_BUILD)
 135 endif
 136
 137 # Automatically add -jN to make flags if not defined. N defaults to number of cores.
 138 ifeq (,$(findstring -j,$(MOZ_MAKE_FLAGS)))
 139   cores=$(shell $(PYTHON) -c 'import multiprocessing; print(multiprocessing.cpu_count())')
 140   MOZ_MAKE_FLAGS += -j$(cores)
 141 endif
 142
 143
 144 ifdef MOZ_BUILD_PROJECTS
 145
 146 ifdef MOZ_CURRENT_PROJECT
 147   BUILD_PROJECT_ARG = MOZ_BUILD_APP=$(MOZ_CURRENT_PROJECT)
 148   export MOZ_CURRENT_PROJECT
 149 else
 150   MOZ_MAKE = $(error Cannot build in the OBJDIR when MOZ_CURRENT_PROJECT is not set.)
 151 endif
 152 endif # MOZ_BUILD_PROJECTS
 153
 154 MOZ_MAKE = $(MAKE) $(MOZ_MAKE_FLAGS) -C $(OBJDIR)
 155
 156 # 'configure' scripts generated by autoconf.
 157 CONFIGURES := $(TOPSRCDIR)/configure
 158 CONFIGURES += $(TOPSRCDIR)/js/src/configure
 159
 160 # Make targets that are going to be passed to the real build system
 161 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
 162
 163 #######################################################################
 164 # Rules
 165
 166 # The default rule is build
 167 build::
 168         $(MAKE) -f $(TOPSRCDIR)/client.mk $(if $(MOZ_PGO),profiledbuild,realbuild) CREATE_MOZCONFIG_JSON=
 169
 170 # Define mkdir
 171 include $(TOPSRCDIR)/config/makefiles/makeutils.mk
 172 include $(TOPSRCDIR)/config/makefiles/autotargets.mk
 173
 174 # Create a makefile containing the mk_add_options values from mozconfig,
 175 # but only do so when OBJDIR is defined (see further above).
 176 ifdef MOZ_BUILD_PROJECTS
 177 ifdef MOZ_CURRENT_PROJECT
 178 WANT_MOZCONFIG_MK = 1
 179 else
 180 WANT_MOZCONFIG_MK =
 181 endif
 182 else
 183 WANT_MOZCONFIG_MK = 1
 184 endif
 185
 186 ifdef WANT_MOZCONFIG_MK
 187 # For now, only output "export" lines from mach environment --format=client.mk output.
 188 MOZCONFIG_MK_LINES := $(filter export||%,$(MOZCONFIG_OUT_LINES))
 189 $(OBJDIR)/.mozconfig.mk: $(FOUND_MOZCONFIG) $(call mkdir_deps,$(OBJDIR)) $(OBJDIR)/CLOBBER
 190         $(if $(MOZCONFIG_MK_LINES),( $(foreach line,$(MOZCONFIG_MK_LINES), echo '$(subst ||, ,$(line))';) )) > $@
 191
 192 # Include that makefile so that it is created. This should not actually change
 193 # the environment since MOZCONFIG_CONTENT, which MOZCONFIG_OUT_LINES derives
 194 # from, has already been eval'ed.
 195 include $(OBJDIR)/.mozconfig.mk
 196 endif
 197
 198 # Print out any options loaded from mozconfig.
 199 all realbuild clean distclean export libs install realclean::
 200 ifneq (,$(strip $(MOZCONFIG_OUT_FILTERED)))
 201         $(info Adding client.mk options from $(FOUND_MOZCONFIG):)
 202         $(foreach line,$(MOZCONFIG_OUT_FILTERED),$(info $(NULL) $(NULL) $(NULL) $(NULL) $(subst ||, ,$(line))))
 203 endif
 204
 205 # Windows equivalents
 206 build_all: build
 207 clobber clobber_all: clean
 208
 209 # helper target for mobile
 210 build_and_deploy: build package install
 211
 212 # Do everything from scratch
 213 everything: clean build
 214
 215 ####################################
 216 # Profile-Guided Optimization
 217 #  This is up here, outside of the MOZ_CURRENT_PROJECT logic so that this
 218 #  is usable in multi-pass builds, where you might not have a runnable
 219 #  application until all the build passes and postflight scripts have run.
 220 profiledbuild::
 221         $(MAKE) -f $(TOPSRCDIR)/client.mk realbuild MOZ_PROFILE_GENERATE=1 MOZ_PGO_INSTRUMENTED=1 CREATE_MOZCONFIG_JSON=
 222         $(MAKE) -C $(OBJDIR) package MOZ_PGO_INSTRUMENTED=1 MOZ_INTERNAL_SIGNING_FORMAT= MOZ_EXTERNAL_SIGNING_FORMAT=
 223         rm -f $(OBJDIR)/jarlog/en-US.log
 224         MOZ_PGO_INSTRUMENTED=1 JARLOG_FILE=jarlog/en-US.log EXTRA_TEST_ARGS=10 $(MAKE) -C $(OBJDIR) pgo-profile-run
 225         $(MAKE) -f $(TOPSRCDIR)/client.mk maybe_clobber_profiledbuild CREATE_MOZCONFIG_JSON=
 226         $(MAKE) -f $(TOPSRCDIR)/client.mk realbuild MOZ_PROFILE_USE=1 CREATE_MOZCONFIG_JSON=
 227
 228 #####################################################
 229 # Build date unification
 230
 231 ifdef MOZ_UNIFY_BDATE
 232 ifndef MOZ_BUILD_DATE
 233 ifdef MOZ_BUILD_PROJECTS
 234 MOZ_BUILD_DATE = $(shell $(PYTHON) $(TOPSRCDIR)/toolkit/xre/make-platformini.py --print-buildid)
 235 export MOZ_BUILD_DATE
 236 endif
 237 endif
 238 endif
 239
 240 #####################################################
 241 # Preflight, before building any project
 242
 243 realbuild preflight_all::
 244 ifeq (,$(MOZ_CURRENT_PROJECT)$(if $(MOZ_PREFLIGHT_ALL),,1))
 245 # Don't run preflight_all for individual projects in multi-project builds
 246 # (when MOZ_CURRENT_PROJECT is set.)
 247 ifndef MOZ_BUILD_PROJECTS
 248 # Building a single project, OBJDIR is usable.
 249         set -e; \
 250         for mkfile in $(MOZ_PREFLIGHT_ALL); do \
 251           $(MAKE) -f $(TOPSRCDIR)/$$mkfile preflight_all TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
 252         done
 253 else
 254 # OBJDIR refers to the project-specific OBJDIR, which is not available at
 255 # this point when building multiple projects.  Only MOZ_OBJDIR is available.
 256         set -e; \
 257         for mkfile in $(MOZ_PREFLIGHT_ALL); do \
 258           $(MAKE) -f $(TOPSRCDIR)/$$mkfile preflight_all TOPSRCDIR=$(TOPSRCDIR) MOZ_OBJDIR=$(MOZ_OBJDIR) MOZ_BUILD_PROJECTS='$(MOZ_BUILD_PROJECTS)'; \
 259         done
 260 endif
 261 endif
 262
 263 # If we're building multiple projects, but haven't specified which project,
 264 # loop through them.
 265
 266 ifeq (,$(MOZ_CURRENT_PROJECT)$(if $(MOZ_BUILD_PROJECTS),,1))
 267 configure realbuild preflight postflight $(OBJDIR_TARGETS)::
 268         set -e; \
 269         for app in $(MOZ_BUILD_PROJECTS); do \
 270           $(MAKE) -f $(TOPSRCDIR)/client.mk $@ MOZ_CURRENT_PROJECT=$$app; \
 271         done
 272
 273 else
 274
 275 # MOZ_CURRENT_PROJECT: either doing a single-project build, or building an
 276 # individual project in a multi-project build.
 277
 278 ####################################
 279 # Configure
 280
 281 MAKEFILE      = $(wildcard $(OBJDIR)/Makefile)
 282 CONFIG_STATUS = $(wildcard $(OBJDIR)/config.status)
 283 CONFIG_CACHE  = $(wildcard $(OBJDIR)/config.cache)
 284
 285 EXTRA_CONFIG_DEPS := \
 286   $(TOPSRCDIR)/aclocal.m4 \
 287   $(wildcard $(TOPSRCDIR)/build/autoconf/*.m4) \
 288   $(TOPSRCDIR)/js/src/aclocal.m4 \
 289   $(NULL)
 290
 291 $(CONFIGURES): %: %.in $(EXTRA_CONFIG_DEPS)
 292         @echo Generating $@ using autoconf
 293         cd $(@D); $(AUTOCONF)
 294
 295 CONFIG_STATUS_DEPS := \
 296   $(wildcard $(TOPSRCDIR)/*/confvars.sh) \
 297   $(CONFIGURES) \
 298   $(TOPSRCDIR)/CLOBBER \
 299   $(TOPSRCDIR)/nsprpub/configure \
 300   $(TOPSRCDIR)/config/milestone.txt \
 301   $(TOPSRCDIR)/browser/config/version.txt \
 302   $(TOPSRCDIR)/build/virtualenv_packages.txt \
 303   $(TOPSRCDIR)/python/mozbuild/mozbuild/virtualenv.py \
 304   $(TOPSRCDIR)/testing/mozbase/packages.txt \
 305   $(OBJDIR)/.mozconfig.json \
 306   $(NULL)
 307
 308 CONFIGURE_ENV_ARGS += \
 309   MAKE='$(MAKE)' \
 310   $(NULL)
 311
 312 # configure uses the program name to determine @srcdir@. Calling it without
 313 #   $(TOPSRCDIR) will set @srcdir@ to "."; otherwise, it is set to the full
 314 #   path of $(TOPSRCDIR).
 315 ifeq ($(TOPSRCDIR),$(OBJDIR))
 316   CONFIGURE = ./configure
 317 else
 318   CONFIGURE = $(TOPSRCDIR)/configure
 319 endif
 320
 321 $(OBJDIR)/CLOBBER: $(TOPSRCDIR)/CLOBBER
 322         $(PYTHON) $(TOPSRCDIR)/config/pythonpath.py -I $(TOPSRCDIR)/testing/mozbase/mozfile \
 323             $(TOPSRCDIR)/python/mozbuild/mozbuild/controller/clobber.py $(TOPSRCDIR) $(OBJDIR)
 324
 325 configure-files: $(CONFIGURES)
 326
 327 configure-preqs = \
 328   $(OBJDIR)/CLOBBER \
 329   configure-files \
 330   $(call mkdir_deps,$(OBJDIR)) \
 331   $(if $(MOZ_BUILD_PROJECTS),$(call mkdir_deps,$(MOZ_OBJDIR))) \
 332   save-mozconfig \
 333   $(OBJDIR)/.mozconfig.json \
 334   $(NULL)
 335
 336 CREATE_MOZCONFIG_JSON = $(shell $(TOPSRCDIR)/mach environment --format=json -o $(OBJDIR)/.mozconfig.json)
 337 # Force CREATE_MOZCONFIG_JSON above to be resolved, without side effects in
 338 # case the result is non empty, and allowing an override on the make command
 339 # line not running the command (using := $(shell) still runs the shell command).
 340 ifneq (,$(CREATE_MOZCONFIG_JSON))
 341 endif
 342
 343 $(OBJDIR)/.mozconfig.json: $(call mkdir_deps,$(OBJDIR)) ;
 344
 345 save-mozconfig: $(FOUND_MOZCONFIG)
 346         -cp $(FOUND_MOZCONFIG) $(OBJDIR)/.mozconfig
 347
 348 configure:: $(configure-preqs)
 349         @echo cd $(OBJDIR);
 350         @echo $(CONFIGURE) $(CONFIGURE_ARGS)
 351         @cd $(OBJDIR) && $(BUILD_PROJECT_ARG) $(CONFIGURE_ENV_ARGS) $(CONFIGURE) $(CONFIGURE_ARGS) \
 352           || ( echo '*** Fix above errors and then restart with\
 353                "$(MAKE) -f client.mk build"' && exit 1 )
 354         @touch $(OBJDIR)/Makefile
 355
 356 ifneq (,$(MAKEFILE))
 357 $(OBJDIR)/Makefile: $(OBJDIR)/config.status
 358
 359 $(OBJDIR)/config.status: $(CONFIG_STATUS_DEPS)
 360 else
 361 $(OBJDIR)/Makefile: $(CONFIG_STATUS_DEPS)
 362 endif
 363         @$(MAKE) -f $(TOPSRCDIR)/client.mk configure CREATE_MOZCONFIG_JSON=
 364
 365 ifneq (,$(CONFIG_STATUS))
 366 $(OBJDIR)/config/autoconf.mk: $(TOPSRCDIR)/config/autoconf.mk.in
 367         $(PYTHON) $(OBJDIR)/config.status -n --file=$(OBJDIR)/config/autoconf.mk
 368 endif
 369
 370
 371 ####################################
 372 # Preflight
 373
 374 realbuild preflight::
 375 ifdef MOZ_PREFLIGHT
 376         set -e; \
 377         for mkfile in $(MOZ_PREFLIGHT); do \
 378           $(MAKE) -f $(TOPSRCDIR)/$$mkfile preflight TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
 379         done
 380 endif
 381
 382 ####################################
 383 # Build it
 384
 385 realbuild::  $(OBJDIR)/Makefile $(OBJDIR)/config.status
 386         +$(MOZ_MAKE)
 387
 388 ####################################
 389 # Other targets
 390
 391 # Pass these target onto the real build system
 392 $(OBJDIR_TARGETS):: $(OBJDIR)/Makefile $(OBJDIR)/config.status
 393         +$(MOZ_MAKE) $@
 394
 395 ####################################
 396 # Postflight
 397
 398 realbuild postflight::
 399 ifdef MOZ_POSTFLIGHT
 400         set -e; \
 401         for mkfile in $(MOZ_POSTFLIGHT); do \
 402           $(MAKE) -f $(TOPSRCDIR)/$$mkfile postflight TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
 403         done
 404 endif
 405
 406 endif # MOZ_CURRENT_PROJECT
 407
 408 ####################################
 409 # Postflight, after building all projects
 410
 411 realbuild postflight_all::
 412 ifeq (,$(MOZ_CURRENT_PROJECT)$(if $(MOZ_POSTFLIGHT_ALL),,1))
 413 # Don't run postflight_all for individual projects in multi-project builds
 414 # (when MOZ_CURRENT_PROJECT is set.)
 415 ifndef MOZ_BUILD_PROJECTS
 416 # Building a single project, OBJDIR is usable.
 417         set -e; \
 418         for mkfile in $(MOZ_POSTFLIGHT_ALL); do \
 419           $(MAKE) -f $(TOPSRCDIR)/$$mkfile postflight_all TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
 420         done
 421 else
 422 # OBJDIR refers to the project-specific OBJDIR, which is not available at
 423 # this point when building multiple projects.  Only MOZ_OBJDIR is available.
 424         set -e; \
 425         for mkfile in $(MOZ_POSTFLIGHT_ALL); do \
 426           $(MAKE) -f $(TOPSRCDIR)/$$mkfile postflight_all TOPSRCDIR=$(TOPSRCDIR) MOZ_OBJDIR=$(MOZ_OBJDIR) MOZ_BUILD_PROJECTS='$(MOZ_BUILD_PROJECTS)'; \
 427         done
 428 endif
 429 endif
 430
 431 cleansrcdir:
 432         @cd $(TOPSRCDIR); \
 433         if [ -f Makefile ]; then \
 434           $(MAKE) distclean ; \
 435         else \
 436           echo 'Removing object files from srcdir...'; \
 437           rm -fr `find . -type d \( -name .deps -print -o -name CVS \
 438                   -o -exec test ! -d {}/CVS \; \) -prune \
 439                   -o \( -name '*.[ao]' -o -name '*.so' \) -type f -print`; \
 440            build/autoconf/clean-config.sh; \
 441         fi;
 442
 443 echo-variable-%:
 444         @echo $($*)
 445
 446 # This makefile doesn't support parallel execution. It does pass
 447 # MOZ_MAKE_FLAGS to sub-make processes, so they will correctly execute
 448 # in parallel.
 449 .NOTPARALLEL:
 450
 451 .PHONY: checkout \
 452     real_checkout \
 453     realbuild \
 454     build \
 455     profiledbuild \
 456     cleansrcdir \
 457     pull_all \
 458     build_all \
 459     clobber \
 460     clobber_all \
 461     pull_and_build_all \
 462     everything \
 463     configure \
 464     preflight_all \
 465     preflight \
 466     postflight \
 467     postflight_all \
 468     $(OBJDIR_TARGETS)