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 MOZ_OBJDIR = .
  54 else
  55 TOPSRCDIR := $(CWD)
  56 endif
  57 endif
  58
  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)
  62
  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
  67
  68 ifeq (,$(strip $(AUTOCONF)))
  69 AUTOCONF=$(error Could not find autoconf 2.13)
  70 endif
  71
  72 SH := /bin/sh
  73 PERL ?= perl
  74 PYTHON ?= python
  75
  76 CONFIG_GUESS_SCRIPT := $(wildcard $(TOPSRCDIR)/build/autoconf/config.guess)
  77 ifdef CONFIG_GUESS_SCRIPT
  78   CONFIG_GUESS := $(shell $(CONFIG_GUESS_SCRIPT))
  79 endif
  80
  81
  82 ####################################
  83 # Sanity checks
  84
  85 ifneq (,$(findstring mingw,$(CONFIG_GUESS)))
  86 # check for CRLF line endings
  87 ifneq (0,$(shell $(PERL) -e 'binmode(STDIN); while (<STDIN>) { if (/\r/) { print "1"; exit } } print "0"' < $(TOPSRCDIR)/client.mk))
  88 $(error This source tree appears to have Windows-style line endings. To \
  89 convert it to Unix-style line endings, run \
  90 "python mozilla/build/win32/mozilla-dos2unix.py")
  91 endif
  92 endif
  93
  94 ####################################
  95 # Load mozconfig Options
  96
  97 # See build pages, http://www.mozilla.org/build/ for how to set up mozconfig.
  98
  99 MOZCONFIG_LOADER := build/autoconf/mozconfig2client-mk
 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.
 109 $(eval $(subst ||,$(CR),$(shell _PYMAKE=$(.PYMAKE) $(TOPSRCDIR)/$(MOZCONFIG_LOADER) $(TOPSRCDIR) 2> $(TOPSRCDIR)/.mozconfig.out | sed 's/$$/||/')))
 110
 111
 112 # Automatically add -jN to make flags if not defined. N defaults to number of cores.
 113 ifeq (,$(findstring -j,$(MOZ_MAKE_FLAGS)))
 114   cores=$(shell $(PYTHON) -c 'import multiprocessing; print(multiprocessing.cpu_count())')
 115   MOZ_MAKE_FLAGS += -j$(cores)
 116 endif
 117
 118
 119 ifndef MOZ_OBJDIR
 120   MOZ_OBJDIR = obj-$(CONFIG_GUESS)
 121 else
 122 # On Windows Pymake builds check MOZ_OBJDIR doesn't start with "/"
 123   ifneq (,$(findstring mingw,$(CONFIG_GUESS)))
 124   ifeq (1_a,$(.PYMAKE)_$(firstword a$(subst /, ,$(MOZ_OBJDIR))))
 125   $(error For Windows Pymake builds, MOZ_OBJDIR must be a Windows [and not MSYS] style path.)
 126   endif
 127   endif
 128 endif
 129
 130 ifdef MOZ_BUILD_PROJECTS
 131
 132 ifdef MOZ_CURRENT_PROJECT
 133   OBJDIR = $(MOZ_OBJDIR)/$(MOZ_CURRENT_PROJECT)
 134   MOZ_MAKE = $(MAKE) $(MOZ_MAKE_FLAGS) -C $(OBJDIR)
 135   BUILD_PROJECT_ARG = MOZ_BUILD_APP=$(MOZ_CURRENT_PROJECT)
 136 else
 137   OBJDIR = $(error Cannot find the OBJDIR when MOZ_CURRENT_PROJECT is not set.)
 138   MOZ_MAKE = $(error Cannot build in the OBJDIR when MOZ_CURRENT_PROJECT is not set.)
 139 endif
 140
 141 else # MOZ_BUILD_PROJECTS
 142
 143 OBJDIR = $(MOZ_OBJDIR)
 144 MOZ_MAKE = $(MAKE) $(MOZ_MAKE_FLAGS) -C $(OBJDIR)
 145
 146 endif # MOZ_BUILD_PROJECTS
 147
 148 # 'configure' scripts generated by autoconf.
 149 CONFIGURES := $(TOPSRCDIR)/configure
 150 CONFIGURES += $(TOPSRCDIR)/js/src/configure
 151
 152 # Make targets that are going to be passed to the real build system
 153 OBJDIR_TARGETS = install export libs clean realclean distclean alldep maybe_clobber_profiledbuild upload sdk installer package fast-package package-compare stage-package source-package l10n-check
 154
 155 #######################################################################
 156 # Rules
 157
 158 # The default rule is build
 159 build::
 160         $(MAKE) -f $(TOPSRCDIR)/client.mk $(if $(MOZ_PGO),profiledbuild,realbuild)
 161
 162 # Define mkdir
 163 include $(TOPSRCDIR)/config/makefiles/makeutils.mk
 164 include $(TOPSRCDIR)/config/makefiles/autotargets.mk
 165
 166 # Print out any options loaded from mozconfig.
 167 all realbuild clean depend distclean export libs install realclean::
 168         @if test -f .mozconfig.out; then \
 169           cat .mozconfig.out; \
 170           rm -f .mozconfig.out; \
 171         else true; \
 172         fi
 173
 174 # Windows equivalents
 175 build_all: build
 176 build_all_dep: alldep
 177 build_all_depend: alldep
 178 clobber clobber_all: clean
 179
 180 # helper target for mobile
 181 build_and_deploy: build fast-package install
 182
 183 # Do everything from scratch
 184 everything: clean build
 185
 186 ####################################
 187 # Profile-Guided Optimization
 188 #  To use this, you should set the following variables in your mozconfig
 189 #    mk_add_options PROFILE_GEN_SCRIPT=/path/to/profile-script
 190 #
 191 #  The profile script should exercise the functionality to be included
 192 #  in the profile feedback.
 193 #
 194 #  This is up here, outside of the MOZ_CURRENT_PROJECT logic so that this
 195 #  is usable in multi-pass builds, where you might not have a runnable
 196 #  application until all the build passes and postflight scripts have run.
 197 ifdef MOZ_OBJDIR
 198   PGO_OBJDIR = $(MOZ_OBJDIR)
 199 else
 200   PGO_OBJDIR := $(TOPSRCDIR)
 201 endif
 202
 203 profiledbuild::
 204         $(MAKE) -f $(TOPSRCDIR)/client.mk realbuild MOZ_PROFILE_GENERATE=1 MOZ_PGO_INSTRUMENTED=1
 205         $(MAKE) -C $(PGO_OBJDIR) package MOZ_PGO_INSTRUMENTED=1 MOZ_INTERNAL_SIGNING_FORMAT= MOZ_EXTERNAL_SIGNING_FORMAT=
 206         rm -f ${PGO_OBJDIR}/jarlog/en-US.log
 207         MOZ_PGO_INSTRUMENTED=1 OBJDIR=${PGO_OBJDIR} JARLOG_FILE=${PGO_OBJDIR}/jarlog/en-US.log $(PROFILE_GEN_SCRIPT)
 208         $(MAKE) -f $(TOPSRCDIR)/client.mk maybe_clobber_profiledbuild
 209         $(MAKE) -f $(TOPSRCDIR)/client.mk realbuild MOZ_PROFILE_USE=1
 210
 211 #####################################################
 212 # Build date unification
 213
 214 ifdef MOZ_UNIFY_BDATE
 215 ifndef MOZ_BUILD_DATE
 216 ifdef MOZ_BUILD_PROJECTS
 217 MOZ_BUILD_DATE = $(shell $(PYTHON) $(TOPSRCDIR)/toolkit/xre/make-platformini.py --print-buildid)
 218 export MOZ_BUILD_DATE
 219 endif
 220 endif
 221 endif
 222
 223 #####################################################
 224 # Preflight, before building any project
 225
 226 realbuild alldep preflight_all::
 227 ifeq (,$(MOZ_CURRENT_PROJECT)$(if $(MOZ_PREFLIGHT_ALL),,1))
 228 # Don't run preflight_all for individual projects in multi-project builds
 229 # (when MOZ_CURRENT_PROJECT is set.)
 230 ifndef MOZ_BUILD_PROJECTS
 231 # Building a single project, OBJDIR is usable.
 232         set -e; \
 233         for mkfile in $(MOZ_PREFLIGHT_ALL); do \
 234           $(MAKE) -f $(TOPSRCDIR)/$$mkfile preflight_all TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
 235         done
 236 else
 237 # OBJDIR refers to the project-specific OBJDIR, which is not available at
 238 # this point when building multiple projects.  Only MOZ_OBJDIR is available.
 239         set -e; \
 240         for mkfile in $(MOZ_PREFLIGHT_ALL); do \
 241           $(MAKE) -f $(TOPSRCDIR)/$$mkfile preflight_all TOPSRCDIR=$(TOPSRCDIR) MOZ_OBJDIR=$(MOZ_OBJDIR) MOZ_BUILD_PROJECTS="$(MOZ_BUILD_PROJECTS)"; \
 242         done
 243 endif
 244 endif
 245
 246 # If we're building multiple projects, but haven't specified which project,
 247 # loop through them.
 248
 249 ifeq (,$(MOZ_CURRENT_PROJECT)$(if $(MOZ_BUILD_PROJECTS),,1))
 250 configure depend realbuild preflight postflight $(OBJDIR_TARGETS)::
 251         set -e; \
 252         for app in $(MOZ_BUILD_PROJECTS); do \
 253           $(MAKE) -f $(TOPSRCDIR)/client.mk $@ MOZ_CURRENT_PROJECT=$$app; \
 254         done
 255
 256 else
 257
 258 # MOZ_CURRENT_PROJECT: either doing a single-project build, or building an
 259 # individual project in a multi-project build.
 260
 261 ####################################
 262 # Configure
 263
 264 MAKEFILE      = $(wildcard $(OBJDIR)/Makefile)
 265 CONFIG_STATUS = $(wildcard $(OBJDIR)/config.status)
 266 CONFIG_CACHE  = $(wildcard $(OBJDIR)/config.cache)
 267
 268 EXTRA_CONFIG_DEPS := \
 269   $(TOPSRCDIR)/aclocal.m4 \
 270   $(wildcard $(TOPSRCDIR)/build/autoconf/*.m4) \
 271   $(TOPSRCDIR)/js/src/aclocal.m4 \
 272   $(NULL)
 273
 274 $(CONFIGURES): %: %.in $(EXTRA_CONFIG_DEPS)
 275         @$(PYTHON) $(TOPSRCDIR)/js/src/config/check-sync-dirs.py $(TOPSRCDIR)/js/src/build $(TOPSRCDIR)/build
 276         @echo Generating $@ using autoconf
 277         cd $(@D); $(AUTOCONF)
 278
 279 CONFIG_STATUS_DEPS := \
 280   $(wildcard $(TOPSRCDIR)/*/confvars.sh) \
 281   $(CONFIGURES) \
 282   $(TOPSRCDIR)/CLOBBER \
 283   $(TOPSRCDIR)/nsprpub/configure \
 284   $(TOPSRCDIR)/config/milestone.txt \
 285   $(TOPSRCDIR)/js/src/config/milestone.txt \
 286   $(TOPSRCDIR)/browser/config/version.txt \
 287   $(TOPSRCDIR)/build/virtualenv/packages.txt \
 288   $(TOPSRCDIR)/build/virtualenv/populate_virtualenv.py \
 289   $(TOPSRCDIR)/testing/mozbase/packages.txt \
 290   $(NULL)
 291
 292 CONFIGURE_ENV_ARGS += \
 293   MAKE="$(MAKE)" \
 294   $(NULL)
 295
 296 # configure uses the program name to determine @srcdir@. Calling it without
 297 #   $(TOPSRCDIR) will set @srcdir@ to "."; otherwise, it is set to the full
 298 #   path of $(TOPSRCDIR).
 299 ifeq ($(TOPSRCDIR),$(OBJDIR))
 300   CONFIGURE = ./configure
 301 else
 302   CONFIGURE = $(TOPSRCDIR)/configure
 303 endif
 304
 305 configure-files: $(CONFIGURES)
 306
 307 configure-preqs = \
 308   configure-files \
 309   $(call mkdir_deps,$(OBJDIR)) \
 310   $(if $(MOZ_BUILD_PROJECTS),$(call mkdir_deps,$(MOZ_OBJDIR))) \
 311   save-mozconfig \
 312   $(NULL)
 313
 314 save-mozconfig: $(FOUND_MOZCONFIG)
 315         -cp $(FOUND_MOZCONFIG) $(OBJDIR)/.mozconfig
 316
 317 configure:: $(configure-preqs)
 318         @echo cd $(OBJDIR);
 319         @echo $(CONFIGURE) $(CONFIGURE_ARGS)
 320         @cd $(OBJDIR) && $(BUILD_PROJECT_ARG) $(CONFIGURE_ENV_ARGS) $(CONFIGURE) $(CONFIGURE_ARGS) \
 321           || ( echo "*** Fix above errors and then restart with\
 322                \"$(MAKE) -f client.mk build\"" && exit 1 )
 323         @touch $(OBJDIR)/Makefile
 324
 325 ifneq (,$(MAKEFILE))
 326 $(OBJDIR)/Makefile: $(OBJDIR)/config.status
 327
 328 $(OBJDIR)/config.status: $(CONFIG_STATUS_DEPS)
 329 else
 330 $(OBJDIR)/Makefile: $(CONFIG_STATUS_DEPS)
 331 endif
 332         @$(MAKE) -f $(TOPSRCDIR)/client.mk configure
 333
 334 ifneq (,$(CONFIG_STATUS))
 335 $(OBJDIR)/config/autoconf.mk: $(TOPSRCDIR)/config/autoconf.mk.in
 336         $(PYTHON) $(OBJDIR)/config.status -n --file=$(OBJDIR)/config/autoconf.mk
 337 endif
 338
 339
 340 ####################################
 341 # Depend
 342
 343 depend:: $(OBJDIR)/Makefile $(OBJDIR)/config.status
 344         $(MOZ_MAKE) export && $(MOZ_MAKE) depend
 345
 346 ####################################
 347 # Preflight
 348
 349 realbuild alldep preflight::
 350 ifdef MOZ_PREFLIGHT
 351         set -e; \
 352         for mkfile in $(MOZ_PREFLIGHT); do \
 353           $(MAKE) -f $(TOPSRCDIR)/$$mkfile preflight TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
 354         done
 355 endif
 356
 357 ####################################
 358 # Build it
 359
 360 realbuild::  $(OBJDIR)/Makefile $(OBJDIR)/config.status check-sync-dirs-config
 361         $(MOZ_MAKE)
 362
 363 ####################################
 364 # Other targets
 365
 366 # Pass these target onto the real build system
 367 $(OBJDIR_TARGETS):: $(OBJDIR)/Makefile $(OBJDIR)/config.status
 368         $(MOZ_MAKE) $@
 369
 370 ####################################
 371 # Postflight
 372
 373 realbuild alldep postflight::
 374 ifdef MOZ_POSTFLIGHT
 375         set -e; \
 376         for mkfile in $(MOZ_POSTFLIGHT); do \
 377           $(MAKE) -f $(TOPSRCDIR)/$$mkfile postflight TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
 378         done
 379 endif
 380
 381 endif # MOZ_CURRENT_PROJECT
 382
 383 ####################################
 384 # Postflight, after building all projects
 385
 386 realbuild alldep postflight_all::
 387 ifeq (,$(MOZ_CURRENT_PROJECT)$(if $(MOZ_POSTFLIGHT_ALL),,1))
 388 # Don't run postflight_all for individual projects in multi-project builds
 389 # (when MOZ_CURRENT_PROJECT is set.)
 390 ifndef MOZ_BUILD_PROJECTS
 391 # Building a single project, OBJDIR is usable.
 392         set -e; \
 393         for mkfile in $(MOZ_POSTFLIGHT_ALL); do \
 394           $(MAKE) -f $(TOPSRCDIR)/$$mkfile postflight_all TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
 395         done
 396 else
 397 # OBJDIR refers to the project-specific OBJDIR, which is not available at
 398 # this point when building multiple projects.  Only MOZ_OBJDIR is available.
 399         set -e; \
 400         for mkfile in $(MOZ_POSTFLIGHT_ALL); do \
 401           $(MAKE) -f $(TOPSRCDIR)/$$mkfile postflight_all TOPSRCDIR=$(TOPSRCDIR) MOZ_OBJDIR=$(MOZ_OBJDIR) MOZ_BUILD_PROJECTS="$(MOZ_BUILD_PROJECTS)"; \
 402         done
 403 endif
 404 endif
 405
 406 cleansrcdir:
 407         @cd $(TOPSRCDIR); \
 408         if [ -f Makefile ]; then \
 409           $(MAKE) distclean ; \
 410         else \
 411           echo "Removing object files from srcdir..."; \
 412           rm -fr `find . -type d \( -name .deps -print -o -name CVS \
 413                   -o -exec test ! -d {}/CVS \; \) -prune \
 414                   -o \( -name '*.[ao]' -o -name '*.so' \) -type f -print`; \
 415            build/autoconf/clean-config.sh; \
 416         fi;
 417
 418 # Because SpiderMonkey can be distributed and built independently
 419 # of the Mozilla source tree, it contains its own copies of many of
 420 # the files used by the top-level Mozilla build process, from the
 421 # 'config' and 'build' subtrees.
 422 #
 423 # To make it simpler to keep the copies in sync, we follow the policy
 424 # that the SpiderMonkey copies must always be exact copies of those in
 425 # the containing Mozilla tree.  If you've made a change in one, it
 426 # belongs in the other as well.  If the change isn't right for both
 427 # places, then that's something to bring up with the other developers.
 428 #
 429 # Some files are reasonable to diverge; for  example,
 430 # js/src/config/autoconf.mk.in doesn't need most of the stuff in
 431 # config/autoconf.mk.in.
 432 .PHONY: check-sync-dirs
 433 check-sync-dirs: check-sync-dirs-build check-sync-dirs-config
 434 check-sync-dirs-%:
 435         @$(PYTHON) $(TOPSRCDIR)/js/src/config/check-sync-dirs.py $(TOPSRCDIR)/js/src/$* $(TOPSRCDIR)/$*
 436
 437 echo-variable-%:
 438         @echo $($*)
 439
 440 # This makefile doesn't support parallel execution. It does pass
 441 # MOZ_MAKE_FLAGS to sub-make processes, so they will correctly execute
 442 # in parallel.
 443 .NOTPARALLEL:
 444
 445 .PHONY: checkout real_checkout depend realbuild build profiledbuild cleansrcdir pull_all build_all clobber clobber_all pull_and_build_all everything configure preflight_all preflight postflight postflight_all $(OBJDIR_TARGETS)