moz.configure

   1 # -*- Mode: python; indent-tabs-mode: nil; tab-width: 40 -*-
   2 # vim: set filetype=python:
   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 include("build/moz.configure/init.configure")
   8
   9 # Note:
  10 # - Gecko-specific options and rules should go in toolkit/moz.configure.
  11 # - Firefox-specific options and rules should go in browser/moz.configure.
  12 # - Fennec-specific options and rules should go in
  13 #   mobile/android/moz.configure.
  14 # - Spidermonkey-specific options and rules should go in js/moz.configure.
  15 # - etc.
  16
  17 option(
  18     "--enable-artifact-builds",
  19     env="MOZ_ARTIFACT_BUILDS",
  20     help="Download and use prebuilt binary artifacts.",
  21 )
  22
  23
  24 @depends("--enable-artifact-builds")
  25 def artifact_builds(value):
  26     if value:
  27         return True
  28
  29
  30 set_config("MOZ_ARTIFACT_BUILDS", artifact_builds)
  31
  32 imply_option(
  33     "--enable-artifact-build-symbols",
  34     depends(artifact_builds)(lambda v: False if v is None else None),
  35     reason="--disable-artifact-builds",
  36 )
  37
  38 option(
  39     "--enable-artifact-build-symbols",
  40     nargs="?",
  41     choices=("full",),
  42     help="Download symbols when artifact builds are enabled.",
  43 )
  44
  45
  46 @depends("--enable-artifact-build-symbols", "MOZ_AUTOMATION", target)
  47 def enable_artifact_build_symbols(value, automation, target):
  48     if len(value):
  49         return value[0]
  50     if bool(value):
  51         if target.os == "Android" and not automation:
  52             return "full"
  53         return True
  54     return None
  55
  56
  57 set_config("MOZ_ARTIFACT_BUILD_SYMBOLS", enable_artifact_build_symbols)
  58
  59
  60 @depends("--enable-artifact-builds")
  61 def imply_disable_compile_environment(value):
  62     if value:
  63         return False
  64
  65
  66 option(
  67     env="MOZ_COPY_PDBS",
  68     help="For builds that do not support symbols in the normal fashion,"
  69     " generate and copy them into the resulting build archive.",
  70 )
  71
  72 set_config("MOZ_COPY_PDBS", depends_if("MOZ_COPY_PDBS")(lambda _: True))
  73
  74 imply_option("--enable-compile-environment", imply_disable_compile_environment)
  75
  76 option("--disable-compile-environment", help="Disable compiler/library checks")
  77
  78
  79 @depends("--disable-compile-environment")
  80 def compile_environment(compile_env):
  81     if compile_env:
  82         return True
  83
  84
  85 set_config("COMPILE_ENVIRONMENT", compile_environment)
  86 add_old_configure_assignment("COMPILE_ENVIRONMENT", compile_environment)
  87
  88 option("--disable-tests", help="Do not build test libraries & programs")
  89
  90
  91 @depends("--disable-tests")
  92 def enable_tests(value):
  93     if value:
  94         return True
  95
  96
  97 set_config("ENABLE_TESTS", enable_tests)
  98 set_define("ENABLE_TESTS", enable_tests)
  99
 100
 101 @depends(enable_tests)
 102 def gtest_has_rtti(value):
 103     if value:
 104         return "0"
 105
 106
 107 set_define("GTEST_HAS_RTTI", gtest_has_rtti)
 108
 109
 110 @depends(target, enable_tests)
 111 def linux_gtest_defines(target, enable_tests):
 112     if enable_tests and target.os == "Android":
 113         return namespace(os_linux_android=True, use_own_tr1_tuple=True, has_clone="0")
 114
 115
 116 set_define("GTEST_OS_LINUX_ANDROID", linux_gtest_defines.os_linux_android)
 117 set_define("GTEST_USE_OWN_TR1_TUPLE", linux_gtest_defines.use_own_tr1_tuple)
 118 set_define("GTEST_HAS_CLONE", linux_gtest_defines.has_clone)
 119
 120 option(
 121     "--enable-debug",
 122     nargs="?",
 123     help="Enable building with developer debug info "
 124     "(using the given compiler flags).",
 125 )
 126
 127
 128 @depends("--enable-debug")
 129 def moz_debug(debug):
 130     if debug:
 131         return bool(debug)
 132
 133
 134 set_config("MOZ_DEBUG", moz_debug)
 135 set_define("MOZ_DEBUG", moz_debug)
 136 # Override any value MOZ_DEBUG may have from the environment when passing it
 137 # down to old-configure.
 138 add_old_configure_assignment("MOZ_DEBUG", depends("--enable-debug")(lambda x: bool(x)))
 139
 140 option(
 141     "--with-debug-label",
 142     nargs="+",
 143     help="Debug DEBUG_<value> for each comma-separated value given",
 144 )
 145
 146
 147 @depends(moz_debug, "--with-debug-label")
 148 def debug_defines(debug, labels):
 149     if debug:
 150         return ["DEBUG"] + ["DEBUG_%s" % label for label in labels]
 151     return ["NDEBUG", "TRIMMED"]
 152
 153
 154 set_config("MOZ_DEBUG_DEFINES", debug_defines)
 155
 156 option(env="MOZ_PGO", help="Build with profile guided optimizations")
 157
 158 set_config("MOZ_PGO", depends("MOZ_PGO")(lambda x: bool(x)))
 159
 160
 161 imply_option("--enable-release", mozilla_official)
 162 imply_option("--enable-release", depends_if("MOZ_AUTOMATION")(lambda x: True))
 163
 164 option(
 165     "--enable-release",
 166     default=milestone.is_release_or_beta,
 167     help="{Build|Do not build} with more conservative, release "
 168     "engineering-oriented options.{ This may slow down builds.|}",
 169 )
 170
 171
 172 @depends("--enable-release")
 173 def developer_options(value):
 174     if not value:
 175         return True
 176
 177
 178 add_old_configure_assignment("DEVELOPER_OPTIONS", developer_options)
 179 set_config("DEVELOPER_OPTIONS", developer_options)
 180
 181
 182 option(
 183     env="MOZ_FETCHES_DIR",
 184     nargs=1,
 185     when="MOZ_AUTOMATION",
 186     help="Directory containing fetched artifacts",
 187 )
 188
 189
 190 @depends("MOZ_FETCHES_DIR", when="MOZ_AUTOMATION")
 191 def moz_fetches_dir(value):
 192     if value:
 193         return value[0]
 194
 195
 196 @depends(host, milestone.is_nightly, "MOZ_AUTOMATION")
 197 def bootstrap_default(host, is_nightly, automation):
 198     if automation:
 199         return False
 200     if host.cpu == "aarch64" and host.os == "OSX" and is_nightly:
 201         return True
 202
 203
 204 option(
 205     "--enable-bootstrap",
 206     default=bootstrap_default,
 207     help="{Automatically bootstrap or update some toolchains|Disable bootstrap or update of toolchains}",
 208 )
 209
 210
 211 @depends(developer_options, "--enable-bootstrap", moz_fetches_dir)
 212 def bootstrap_search_path_order(developer_options, bootstrap, moz_fetches_dir):
 213     if moz_fetches_dir:
 214         log.debug("Prioritizing MOZ_FETCHES_DIR in toolchain path.")
 215         return "prepend"
 216
 217     if bootstrap:
 218         log.debug(
 219             "Prioritizing mozbuild state dir in toolchain paths because "
 220             "bootstrap mode is enabled."
 221         )
 222         return "prepend"
 223
 224     if developer_options:
 225         log.debug(
 226             "Prioritizing mozbuild state dir in toolchain paths because "
 227             "you are not building in release mode."
 228         )
 229         return "prepend"
 230
 231     log.debug(
 232         "Prioritizing system over mozbuild state dir in "
 233         "toolchain paths because you are building in "
 234         "release mode."
 235     )
 236     return "append"
 237
 238
 239 toolchains_base_dir = moz_fetches_dir | mozbuild_state_path
 240
 241
 242 @dependable
 243 @imports("os")
 244 @imports(_from="os", _import="environ")
 245 def original_path():
 246     return environ["PATH"].split(os.pathsep)
 247
 248
 249 @template
 250 def bootstrap_toolchain_tasks(host_or_target):
 251     @depends(host_or_target, when="--enable-bootstrap")
 252     @imports("os")
 253     @imports(_from="mozbuild.toolchains", _import="toolchain_task_definitions")
 254     @imports(_from="__builtin__", _import="Exception")
 255     def bootstrap_toolchain_tasks(host_or_target):
 256         prefix = {
 257             ("x86", "GNU", "Linux"): "linux32",
 258             ("x86_64", "GNU", "Linux"): "linux64",
 259             ("aarch64", "GNU", "Linux"): "linux64-aarch64",
 260             ("x86_64", "OSX", "Darwin"): "macosx64",
 261             ("aarch64", "OSX", "Darwin"): "macosx64-aarch64",
 262             ("x86_64", "WINNT", "WINNT"): "win64",
 263         }.get((host_or_target.cpu, host_or_target.os, host_or_target.kernel))
 264         if prefix:
 265             try:
 266                 return namespace(prefix=prefix, tasks=toolchain_task_definitions())
 267             except Exception:
 268                 return None
 269
 270     return bootstrap_toolchain_tasks
 271
 272
 273 host_bootstrap_toolchain_tasks = bootstrap_toolchain_tasks(host)
 274 target_bootstrap_toolchain_tasks = bootstrap_toolchain_tasks(target)
 275
 276
 277 @template
 278 def bootstrap_path(path, **kwargs):
 279     when = kwargs.pop("when", None)
 280     context = kwargs.pop("context", host)
 281     if kwargs:
 282         configure_error(
 283             "bootstrap_path only takes `when` or `context` as keyword arguments"
 284         )
 285
 286     path_parts = path.split("/")
 287     bootstrap_toolchain_tasks = {
 288         host: host_bootstrap_toolchain_tasks,
 289         target: target_bootstrap_toolchain_tasks,
 290     }[context]
 291
 292     @depends(
 293         "--enable-bootstrap",
 294         toolchains_base_dir,
 295         bootstrap_toolchain_tasks,
 296         shell,
 297         check_build_environment,
 298         when=when,
 299     )
 300     @imports("os")
 301     @imports("subprocess")
 302     @imports(_from="mozbuild.util", _import="ensureParentDir")
 303     @imports(_from="__builtin__", _import="open")
 304     @imports(_from="__builtin__", _import="Exception")
 305     def bootstrap_path(bootstrap, toolchains_base_dir, tasks, shell, build_env):
 306         def try_bootstrap(exists):
 307             if not tasks:
 308                 return False
 309             label = "toolchain-{}-{}".format(
 310                 tasks.prefix, path_parts[0].replace("_", "-")
 311             )
 312             task = tasks.tasks.get(label)
 313             if not task:
 314                 return False
 315             task_index = task.optimization.get("index-search")
 316             if not task_index:
 317                 return False
 318             task_index = task_index[0].split(".")[-1]
 319             artifact = task.attributes["toolchain-artifact"]
 320             # `mach artifact toolchain` doesn't support authentication for
 321             # private artifacts.
 322             if not artifact.startswith("public/"):
 323                 return False
 324             index_file = os.path.join(toolchains_base_dir, "indices", path_parts[0])
 325             try:
 326                 with open(index_file) as fh:
 327                     index = fh.read().strip()
 328             except Exception:
 329                 index = None
 330             if index == task_index and exists:
 331                 return True
 332             log.info(
 333                 "%s bootstrapped toolchain in %s",
 334                 "Updating" if exists else "Installing",
 335                 os.path.join(toolchains_base_dir, path_parts[0]),
 336             )
 337             subprocess.run(
 338                 [
 339                     shell,
 340                     os.path.join(build_env.topsrcdir, "mach"),
 341                     "--log-no-times",
 342                     "artifact",
 343                     "toolchain",
 344                     "--from-build",
 345                     label,
 346                 ],
 347                 cwd=toolchains_base_dir,
 348                 check=True,
 349             )
 350             ensureParentDir(index_file)
 351             with open(index_file, "w") as fh:
 352                 fh.write(task_index)
 353             return True
 354
 355         path = os.path.join(toolchains_base_dir, *path_parts)
 356         if bootstrap:
 357             try:
 358                 if not try_bootstrap(os.path.exists(path)):
 359                     # If there aren't toolchain artifacts to use for this build,
 360                     # don't return a path.
 361                     return None
 362             except Exception as e:
 363                 log.error("%s", e)
 364                 die("If you can't fix the above, retry with --disable-bootstrap.")
 365         # We re-test whether the path exists because it may have been created by
 366         # try_bootstrap. Automation will not have gone through the bootstrap
 367         # process, but we want to return the path if it exists.
 368         if os.path.exists(path):
 369             return path
 370
 371     return bootstrap_path
 372
 373
 374 @template
 375 def bootstrap_search_path(path, paths=original_path, **kwargs):
 376     @depends(
 377         bootstrap_path(path, **kwargs),
 378         bootstrap_search_path_order,
 379         paths,
 380         original_path,
 381     )
 382     def bootstrap_search_path(path, order, paths, original_path):
 383         if paths is None:
 384             paths = original_path
 385         if not path:
 386             return paths
 387         if order == "prepend":
 388             return [path] + paths
 389         return paths + [path]
 390
 391     return bootstrap_search_path
 392
 393
 394 # The execution model of the configure sandbox doesn't allow for
 395 # check_prog to use bootstrap_search_path directly because check_prog
 396 # comes first, so we use a trick to allow it. No use of check_prog
 397 # happening before here won't allow bootstrap.
 398 @template
 399 def check_prog(*args, **kwargs):
 400     kwargs["bootstrap_search_path"] = bootstrap_search_path
 401     return check_prog(*args, **kwargs)
 402
 403
 404 @depends(target, host)
 405 def want_wine(target, host):
 406     return target.kernel == "WINNT" and host.kernel != "WINNT"
 407
 408
 409 wine = check_prog(
 410     "WINE",
 411     ["wine64", "wine"],
 412     allow_missing=True,
 413     when=want_wine,
 414     bootstrap="wine/bin",
 415 )
 416 check_prog("WGET", ("wget",), allow_missing=True)
 417
 418
 419 include("build/moz.configure/toolchain.configure", when="--enable-compile-environment")
 420
 421 include("build/moz.configure/pkg.configure")
 422 # Make this assignment here rather than in pkg.configure to avoid
 423 # requiring this file in unit tests.
 424 add_old_configure_assignment("PKG_CONFIG", pkg_config)
 425
 426 include("build/moz.configure/memory.configure", when="--enable-compile-environment")
 427 include("build/moz.configure/headers.configure", when="--enable-compile-environment")
 428 include("build/moz.configure/warnings.configure", when="--enable-compile-environment")
 429 include("build/moz.configure/flags.configure", when="--enable-compile-environment")
 430 include("build/moz.configure/lto-pgo.configure", when="--enable-compile-environment")
 431 # rust.configure is included by js/moz.configure.
 432
 433 option("--enable-valgrind", help="Enable Valgrind integration hooks")
 434
 435 valgrind_h = check_header("valgrind/valgrind.h", when="--enable-valgrind")
 436
 437
 438 @depends("--enable-valgrind", valgrind_h)
 439 def check_valgrind(valgrind, valgrind_h):
 440     if valgrind:
 441         if not valgrind_h:
 442             die("--enable-valgrind specified but Valgrind is not installed")
 443         return True
 444
 445
 446 set_define("MOZ_VALGRIND", check_valgrind)
 447 set_config("MOZ_VALGRIND", check_valgrind)
 448
 449
 450 @depends(target, host)
 451 def is_openbsd(target, host):
 452     return target.kernel == "OpenBSD" or host.kernel == "OpenBSD"
 453
 454
 455 option(
 456     env="SO_VERSION",
 457     nargs=1,
 458     default="1.0",
 459     when=is_openbsd,
 460     help="Shared library version for OpenBSD systems",
 461 )
 462
 463
 464 @depends("SO_VERSION", when=is_openbsd)
 465 def so_version(value):
 466     return value
 467
 468
 469 @template
 470 def library_name_info_template(host_or_target):
 471     assert host_or_target in {host, target}
 472     compiler = {
 473         host: host_c_compiler,
 474         target: c_compiler,
 475     }[host_or_target]
 476
 477     @depends(host_or_target, compiler, so_version)
 478     def library_name_info_impl(host_or_target, compiler, so_version):
 479         if host_or_target.kernel == "WINNT":
 480             # There aren't artifacts for mingw builds, so it's OK that the
 481             # results are inaccurate in that case.
 482             if compiler and compiler.type != "clang-cl":
 483                 return namespace(
 484                     dll=namespace(prefix="", suffix=".dll"),
 485                     lib=namespace(prefix="lib", suffix="a"),
 486                     import_lib=namespace(prefix="lib", suffix="a"),
 487                     obj=namespace(prefix="", suffix="o"),
 488                 )
 489
 490             return namespace(
 491                 dll=namespace(prefix="", suffix=".dll"),
 492                 lib=namespace(prefix="", suffix="lib"),
 493                 import_lib=namespace(prefix="", suffix="lib"),
 494                 obj=namespace(prefix="", suffix="obj"),
 495             )
 496
 497         elif host_or_target.kernel == "Darwin":
 498             return namespace(
 499                 dll=namespace(prefix="lib", suffix=".dylib"),
 500                 lib=namespace(prefix="lib", suffix="a"),
 501                 import_lib=namespace(prefix=None, suffix=""),
 502                 obj=namespace(prefix="", suffix="o"),
 503             )
 504         elif so_version:
 505             so = ".so.%s" % so_version
 506         else:
 507             so = ".so"
 508
 509         return namespace(
 510             dll=namespace(prefix="lib", suffix=so),
 511             lib=namespace(prefix="lib", suffix="a"),
 512             import_lib=namespace(prefix=None, suffix=""),
 513             obj=namespace(prefix="", suffix="o"),
 514         )
 515
 516     return library_name_info_impl
 517
 518
 519 host_library_name_info = library_name_info_template(host)
 520 library_name_info = library_name_info_template(target)
 521
 522 set_config("DLL_PREFIX", library_name_info.dll.prefix)
 523 set_config("DLL_SUFFIX", library_name_info.dll.suffix)
 524 set_config("HOST_DLL_PREFIX", host_library_name_info.dll.prefix)
 525 set_config("HOST_DLL_SUFFIX", host_library_name_info.dll.suffix)
 526 set_config("LIB_PREFIX", library_name_info.lib.prefix)
 527 set_config("LIB_SUFFIX", library_name_info.lib.suffix)
 528 set_config("OBJ_SUFFIX", library_name_info.obj.suffix)
 529 # Lots of compilation tests depend on this variable being present.
 530 add_old_configure_assignment("OBJ_SUFFIX", library_name_info.obj.suffix)
 531 set_config("IMPORT_LIB_SUFFIX", library_name_info.import_lib.suffix)
 532 set_define(
 533     "MOZ_DLL_PREFIX", depends(library_name_info.dll.prefix)(lambda s: '"%s"' % s)
 534 )
 535 set_define(
 536     "MOZ_DLL_SUFFIX", depends(library_name_info.dll.suffix)(lambda s: '"%s"' % s)
 537 )
 538 set_config("WASM_OBJ_SUFFIX", "wasm")
 539
 540 # Make `profiling` available to this file even when js/moz.configure
 541 # doesn't end up included.
 542 profiling = dependable(False)
 543 # Same for js_standalone
 544 js_standalone = dependable(False)
 545 # Same for fold_libs
 546 fold_libs = dependable(False)
 547
 548 include(include_project_configure)
 549
 550
 551 @depends("--help")
 552 @imports(_from="mozbuild.backend", _import="backends")
 553 def build_backends_choices(_):
 554     return tuple(backends)
 555
 556
 557 @deprecated_option("--enable-build-backend", nargs="+", choices=build_backends_choices)
 558 def build_backend(backends):
 559     if backends:
 560         return tuple("+%s" % b for b in backends)
 561
 562
 563 imply_option("--build-backends", build_backend)
 564
 565
 566 @depends(
 567     "--enable-artifact-builds",
 568     "--disable-compile-environment",
 569     "--enable-build-backend",
 570     "--enable-project",
 571     "--enable-application",
 572     "--help",
 573 )
 574 @imports("sys")
 575 def build_backend_defaults(
 576     artifact_builds, compile_environment, requested_backends, project, application, _
 577 ):
 578     if application:
 579         project = application[0]
 580     elif project:
 581         project = project[0]
 582
 583     if "Tup" in requested_backends:
 584         # As a special case, if Tup was requested, do not combine it with any
 585         # Make based backend by default.
 586         all_backends = []
 587     elif artifact_builds:
 588         all_backends = ["FasterMake+RecursiveMake"]
 589     else:
 590         all_backends = ["RecursiveMake", "FasterMake"]
 591     # Normally, we'd use target.os == 'WINNT', but a dependency on target
 592     # would require target to depend on --help, as well as host and shell,
 593     # and this is not a can of worms we can open at the moment.
 594     if sys.platform == "win32" and compile_environment and project != "mobile/android":
 595         all_backends.append("VisualStudio")
 596     return tuple(all_backends) or None
 597
 598
 599 option(
 600     "--build-backends",
 601     nargs="+",
 602     default=build_backend_defaults,
 603     choices=build_backends_choices,
 604     help="Build backends to generate",
 605 )
 606
 607
 608 @depends("--build-backends")
 609 def build_backends(backends):
 610     return backends
 611
 612
 613 set_config("BUILD_BACKENDS", build_backends)
 614
 615
 616 @depends(check_build_environment, build_backends)
 617 @imports("glob")
 618 def check_objdir_backend_reuse(build_env, backends):
 619     # "Make based" might be RecursiveMake or a hybrid backend, so "Make" is
 620     # intentionally vague for use with the substring match below.
 621     incompatible_backends = (("Tup", "Make"), ("Make", "Tup"))
 622     for backend_file in glob.iglob(
 623         os.path.join(build_env.topobjdir, "backend.*Backend")
 624     ):
 625         for prev, curr in incompatible_backends:
 626             if prev in backend_file and any(curr in b for b in backends):
 627                 die(
 628                     "The active objdir, %s, was previously "
 629                     "used to build with a %s based backend. "
 630                     "Change objdirs (by setting MOZ_OBJDIR in "
 631                     "your mozconfig) or clobber to continue.\n",
 632                     build_env.topobjdir,
 633                     prev,
 634                 )
 635
 636
 637 option(
 638     "--disable-gtest-in-build",
 639     help="Force disable building the gtest libxul during the build.",
 640     when="--enable-compile-environment",
 641 )
 642
 643 # Determine whether to build the gtest xul. This happens in automation
 644 # on Android and Desktop platforms with the exception of:
 645 #  - Windows PGO, where linking xul-gtest.dll takes too long;
 646 #  - Android other than x86_64, where gtest is not required.
 647 @depends(
 648     "MOZ_PGO",
 649     build_project,
 650     target,
 651     "MOZ_AUTOMATION",
 652     "--disable-gtest-in-build",
 653     enable_tests,
 654     when="--enable-compile-environment",
 655 )
 656 def build_gtest(pgo, build_project, target, automation, enabled, enable_tests):
 657     if not enable_tests or not enabled:
 658         return None
 659     if (
 660         automation
 661         and build_project in ("browser", "comm/mail", "mobile/android")
 662         and not (
 663             (pgo and target.os == "WINNT")
 664             or (target.os == "Android" and target.cpu != "x86_64")
 665         )
 666     ):
 667         return True
 668
 669
 670 set_config("LINK_GTEST_DURING_COMPILE", build_gtest)
 671
 672 # Localization
 673 # ==============================================================
 674 option(
 675     "--enable-ui-locale",
 676     default="en-US",
 677     help="Select the user interface locale (default: en-US)",
 678 )
 679
 680 set_config("MOZ_UI_LOCALE", depends("--enable-ui-locale")(lambda x: x))
 681
 682 # clang-plugin location
 683 # ==============================================================
 684 @depends(host_library_name_info, check_build_environment, when="--enable-clang-plugin")
 685 def clang_plugin_path(library_name_info, build_env):
 686     topobjdir = build_env.topobjdir
 687     if topobjdir.endswith("/js/src"):
 688         topobjdir = topobjdir[:-7]
 689     return os.path.abspath(
 690         os.path.join(
 691             topobjdir,
 692             "build",
 693             "clang-plugin",
 694             "%sclang-plugin%s"
 695             % (library_name_info.dll.prefix, library_name_info.dll.suffix),
 696         )
 697     )
 698
 699
 700 add_old_configure_assignment("CLANG_PLUGIN", clang_plugin_path)
 701
 702
 703 # Awk detection
 704 # ==============================================================
 705 awk = check_prog("AWK", ("gawk", "mawk", "nawk", "awk"))
 706
 707 # Until the AWK variable is not necessary in old-configure
 708 @depends(awk)
 709 def awk_for_old_configure(value):
 710     return value
 711
 712
 713 add_old_configure_assignment("AWK", awk_for_old_configure)
 714
 715
 716 # Perl detection
 717 # ==============================================================
 718 perl = check_prog("PERL", ("perl5", "perl"))
 719
 720 # Until the PERL variable is not necessary in old-configure
 721 @depends(perl)
 722 def perl_for_old_configure(value):
 723     return value
 724
 725
 726 add_old_configure_assignment("PERL", perl_for_old_configure)
 727
 728
 729 @template
 730 def perl_version_check(min_version):
 731     @depends(perl)
 732     @checking("for minimum required perl version >= %s" % min_version)
 733     def get_perl_version(perl):
 734         return Version(
 735             check_cmd_output(
 736                 perl,
 737                 "-e",
 738                 "print $]",
 739                 onerror=lambda: die("Failed to get perl version."),
 740             )
 741         )
 742
 743     @depends(get_perl_version)
 744     def check_perl_version(version):
 745         if version < min_version:
 746             die("Perl %s or higher is required.", min_version)
 747
 748     @depends(perl)
 749     @checking("for full perl installation")
 750     @imports("subprocess")
 751     def has_full_perl_installation(perl):
 752         ret = subprocess.call([perl, "-e", "use Config; exit(!-d $Config{archlib})"])
 753         return ret == 0
 754
 755     @depends(has_full_perl_installation)
 756     def require_full_perl_installation(has_full_perl_installation):
 757         if not has_full_perl_installation:
 758             die(
 759                 "Cannot find Config.pm or $Config{archlib}. "
 760                 "A full perl installation is required."
 761             )
 762
 763
 764 perl_version_check("5.006")
 765
 766
 767 # GNU make detection
 768 # ==============================================================
 769 option(env="MAKE", nargs=1, help="Path to GNU make")
 770
 771
 772 @depends("MAKE", host)
 773 def possible_makes(make, host):
 774     candidates = []
 775     if host.kernel == "WINNT":
 776         candidates.append("mingw32-make")
 777     if make:
 778         candidates.append(make[0])
 779     if host.kernel == "WINNT":
 780         candidates.extend(("make", "gmake"))
 781     else:
 782         candidates.extend(("gmake", "make"))
 783     return candidates
 784
 785
 786 check_prog("GMAKE", possible_makes)
 787
 788 # watchman detection
 789 # ==============================================================
 790
 791 option(env="WATCHMAN", nargs=1, help="Path to the watchman program")
 792
 793
 794 @depends(host, "WATCHMAN")
 795 @checking("for watchman", callback=lambda w: w.path if w else "not found")
 796 def watchman(host, prog):
 797     # On Windows, `watchman` is only supported on 64-bit hosts.
 798     if host.os == "WINNT" and host.cpu != "x86_64":
 799         return
 800
 801     if not prog:
 802         prog = find_program("watchman")
 803
 804     if not prog:
 805         return
 806
 807     # `watchman version` will talk to the Watchman daemon service.
 808     # This can hang due to permissions problems. e.g.
 809     # https://github.com/facebook/watchman/issues/376. So use
 810     # `watchman --version` to prevent a class of failures.
 811     out = check_cmd_output(prog, "--version", onerror=lambda: None)
 812     if out is None:
 813         return
 814
 815     return namespace(path=prog, version=Version(out.strip()))
 816
 817
 818 @depends_if(watchman)
 819 @checking("for watchman version")
 820 def watchman_version(w):
 821     return w.version
 822
 823
 824 set_config("WATCHMAN", watchman.path)
 825
 826
 827 @depends_all(hg_version, hg_config, watchman)
 828 @checking("for watchman Mercurial integration")
 829 @imports("os")
 830 def watchman_hg(hg_version, hg_config, watchman):
 831     if hg_version < Version("3.8"):
 832         return "no (Mercurial 3.8+ required)"
 833
 834     ext_enabled = False
 835     mode_disabled = False
 836
 837     for k in ("extensions.fsmonitor", "extensions.hgext.fsmonitor"):
 838         if k in hg_config and hg_config[k] != "!":
 839             ext_enabled = True
 840
 841     mode_disabled = hg_config.get("fsmonitor.mode") == "off"
 842
 843     if not ext_enabled:
 844         return "no (fsmonitor extension not enabled)"
 845     if mode_disabled:
 846         return "no (fsmonitor.mode=off disables fsmonitor)"
 847
 848     return True
 849
 850
 851 # Miscellaneous programs
 852 # ==============================================================
 853 check_prog("XARGS", ("xargs",))
 854
 855
 856 @depends(target)
 857 def extra_programs(target):
 858     if target.kernel == "Darwin":
 859         return namespace(
 860             DSYMUTIL=("dsymutil", "llvm-dsymutil"),
 861             MKFSHFS=("newfs_hfs", "mkfs.hfsplus"),
 862             HFS_TOOL=("hfsplus",),
 863         )
 864     if target.os == "GNU" and target.kernel == "Linux":
 865         return namespace(RPMBUILD=("rpmbuild",))
 866
 867
 868 check_prog("DSYMUTIL", extra_programs.DSYMUTIL, allow_missing=True)
 869 check_prog("MKFSHFS", extra_programs.MKFSHFS, allow_missing=True)
 870 check_prog("HFS_TOOL", extra_programs.HFS_TOOL, allow_missing=True)
 871 check_prog("RPMBUILD", extra_programs.RPMBUILD, allow_missing=True)
 872
 873
 874 @depends(target)
 875 @imports("os")
 876 def makensis_progs(target):
 877     if target.kernel != "WINNT":
 878         return
 879
 880     candidates = [
 881         "makensis-3.01",
 882         "makensis-3.0b3",
 883         "makensis-3.0b1",
 884         "makensis",
 885     ]
 886
 887     # Look for nsis installed by msys environment. But only the 32-bit version.
 888     # We use an absolute path and insert as the first entry so it is preferred
 889     # over a 64-bit exe that may be in PATH.
 890     if "MSYSTEM_PREFIX" in os.environ:
 891         prefix = os.path.dirname(os.environ["MSYSTEM_PREFIX"])
 892         candidates.insert(0, os.path.join(prefix, "mingw32", "bin", "makensis.exe"))
 893
 894     return tuple(candidates)
 895
 896
 897 nsis = check_prog("MAKENSISU", makensis_progs, allow_missing=True)
 898
 899 # Make sure the version of makensis is up to date.
 900 @depends(nsis, wine)
 901 @checking("for NSIS version")
 902 @imports("re")
 903 def nsis_version(nsis, wine):
 904     if not nsis:
 905         return None
 906     nsis_min_version = "3.0b1"
 907     onerror = lambda: die("Failed to get nsis version.")
 908     if wine and nsis.lower().endswith(".exe"):
 909         out = check_cmd_output(wine, nsis, "-version", onerror=onerror)
 910     else:
 911         out = check_cmd_output(nsis, "-version", onerror=onerror)
 912
 913     m = re.search(r"(?<=v)[0-9]+\.[0-9]+((a|b|rc)[0-9]+)?", out)
 914
 915     if not m:
 916         raise FatalCheckError("Unknown version of makensis")
 917     ver = Version(m.group(0))
 918
 919     # Versions comparisons don't quite work well with beta versions, so ensure
 920     # it works for the non-beta version.
 921     if ver < nsis_min_version and (ver >= "3.0a" or ver < "3"):
 922         raise FatalCheckError(
 923             "To build the installer you must have NSIS"
 924             " version %s or greater in your path" % nsis_min_version
 925         )
 926
 927     return ver
 928
 929
 930 # And that makensis is 32-bit (but only on Windows).
 931 @depends_if(nsis, when=depends(host)(lambda h: h.kernel == "WINNT"))
 932 @checking("for 32-bit NSIS")
 933 def nsis_binary_type(nsis):
 934     bin_type = windows_binary_type(nsis)
 935     if bin_type != "win32":
 936         raise FatalCheckError("%s is not a 32-bit Windows application" % nsis)
 937
 938     return "yes"
 939
 940
 941 # And any flags we have to give to makensis
 942 @depends(host)
 943 def nsis_flags(host):
 944     if host.kernel != "WINNT":
 945         return "-nocd"
 946     return ""
 947
 948
 949 set_config("MAKENSISU_FLAGS", nsis_flags)
 950
 951 check_prog("7Z", ("7z", "7za"), allow_missing=True, when=target_is_windows)
 952 check_prog("UPX", ("upx",), allow_missing=True, when=target_is_windows)
 953
 954
 955 @depends(host_c_compiler, c_compiler, bindgen_config_paths)
 956 def llvm_objdump(host_c_compiler, c_compiler, bindgen_config_paths):
 957     clang = None
 958     for compiler in (host_c_compiler, c_compiler):
 959         if compiler and compiler.type == "clang":
 960             clang = compiler.compiler
 961             break
 962         elif compiler and compiler.type == "clang-cl":
 963             clang = os.path.join(os.path.dirname(compiler.compiler), "clang")
 964             break
 965
 966     if not clang and bindgen_config_paths:
 967         clang = bindgen_config_paths.clang_path
 968     llvm_objdump = "llvm-objdump"
 969     if clang:
 970         out = check_cmd_output(
 971             clang, "--print-prog-name=llvm-objdump", onerror=lambda: None
 972         )
 973         if out:
 974             llvm_objdump = out.rstrip()
 975     return (llvm_objdump,)
 976
 977
 978 llvm_objdump = check_prog(
 979     "LLVM_OBJDUMP",
 980     llvm_objdump,
 981     what="llvm-objdump",
 982     when="--enable-compile-environment",
 983     paths=clang_search_path,
 984 )
 985
 986 add_old_configure_assignment("LLVM_OBJDUMP", llvm_objdump)
 987
 988
 989 option("--enable-dtrace", help="Build with dtrace support")
 990
 991 dtrace = check_header(
 992     "sys/sdt.h",
 993     when="--enable-dtrace",
 994     onerror=lambda: die("dtrace enabled but sys/sdt.h not found"),
 995 )
 996
 997 set_config("HAVE_DTRACE", True, when=dtrace)
 998 set_define("INCLUDE_MOZILLA_DTRACE", True, when=dtrace)
 999 add_old_configure_assignment("enable_dtrace", "yes", when=dtrace)
1000
1001
1002 option("--disable-icf", help="Disable Identical Code Folding")
1003
1004 add_old_configure_assignment(
1005     "MOZ_DISABLE_ICF", "1", when=depends("--enable-icf")(lambda x: not x)
1006 )
1007
1008
1009 option(
1010     "--enable-strip",
1011     when=compile_environment,
1012     help="Enable stripping of libs & executables",
1013 )
1014
1015 # This should be handled as a `when` once bug 1617793 is fixed.
1016 @depends("--enable-strip", c_compiler, when=compile_environment)
1017 def enable_strip(strip, c_compiler):
1018     if strip and c_compiler.type != "clang-cl":
1019         return True
1020
1021
1022 set_config("ENABLE_STRIP", enable_strip)
1023
1024 option(
1025     "--disable-install-strip",
1026     when=compile_environment,
1027     help="Enable stripping of libs & executables when packaging",
1028 )
1029
1030 # This should be handled as a `when` once bug 1617793 is fixed.
1031 @depends("--enable-install-strip", c_compiler, when=compile_environment)
1032 def enable_install_strip(strip, c_compiler):
1033     if strip and c_compiler.type != "clang-cl":
1034         return True
1035
1036
1037 set_config("PKG_STRIP", enable_install_strip)
1038
1039
1040 @depends("--enable-strip", "--enable-install-strip", when=compile_environment)
1041 def strip(strip, install_strip):
1042     return strip or install_strip
1043
1044
1045 option(env="STRIP_FLAGS", nargs=1, when=strip, help="Flags for the strip command")
1046
1047
1048 @depends("STRIP_FLAGS", profiling, target, when=strip)
1049 def strip_flags(flags, profiling, target):
1050     if flags:
1051         return flags[0].split()
1052     if profiling:
1053         # Only strip debug info and symbols when profiling is enabled, keeping
1054         # local symbols.
1055         if target.kernel == "Darwin":
1056             return ["-S"]
1057         elif target.os == "Android":
1058             # The tooling we use with Android supports detached symbols, and the
1059             # size increase caused by local symbols are too much for mobile. So,
1060             # don't restrict the amount of stripping with a flag.
1061             return
1062         else:
1063             return ["--strip-debug"]
1064     # Otherwise strip everything we can, which happens without flags on non-Darwin.
1065     # On Darwin, it tries to strip things it can't, so we need to limit its scope.
1066     elif target.kernel == "Darwin":
1067         return ["-x", "-S"]
1068
1069
1070 set_config("STRIP_FLAGS", strip_flags)
1071
1072
1073 @depends(js_standalone, target)
1074 def system_zlib_default(js_standalone, target):
1075     return js_standalone and target.kernel != "WINNT"
1076
1077
1078 option(
1079     "--with-system-zlib",
1080     nargs="?",
1081     default=system_zlib_default,
1082     help="{Use|Do not use} system libz",
1083 )
1084
1085
1086 @depends("--with-system-zlib")
1087 def deprecated_system_zlib_path(value):
1088     if len(value) == 1:
1089         die(
1090             "--with-system-zlib=PATH is not supported anymore. Please use "
1091             "--with-system-zlib and set any necessary pkg-config environment variable."
1092         )
1093
1094
1095 pkg_check_modules("MOZ_ZLIB", "zlib >= 1.2.3", when="--with-system-zlib")
1096
1097 set_config("MOZ_SYSTEM_ZLIB", True, when="--with-system-zlib")
1098 add_old_configure_assignment("MOZ_SYSTEM_ZLIB", True, when="--with-system-zlib")
1099
1100
1101 # Please do not add configure checks from here on.
1102
1103 # Fallthrough to autoconf-based configure
1104 include("build/moz.configure/old.configure")
1105
1106 # JS Subconfigure.
1107 include("js/sub.configure", when=compile_environment & toolkit)
1108
1109
1110 @depends(check_build_environment, build_project)
1111 @imports("__sandbox__")
1112 @imports("glob")
1113 @imports(_from="os.path", _import="exists")
1114 def config_status_deps(build_env, build_project):
1115
1116     topsrcdir = build_env.topsrcdir
1117     topobjdir = build_env.topobjdir
1118
1119     if not topobjdir.endswith("js/src"):
1120         extra_deps = [os.path.join(topobjdir, ".mozconfig.json")]
1121     else:
1122         # mozconfig changes may impact js configure.
1123         extra_deps = [os.path.join(topobjdir[:-7], ".mozconfig.json")]
1124
1125     confvars = os.path.join(topsrcdir, build_project, "confvars.sh")
1126     if exists(confvars):
1127         extra_deps.append(confvars)
1128
1129     return (
1130         list(__sandbox__._all_paths)
1131         + extra_deps
1132         + [
1133             os.path.join(topsrcdir, "CLOBBER"),
1134             os.path.join(topsrcdir, "configure.in"),
1135             os.path.join(topsrcdir, "js", "src", "configure.in"),
1136             os.path.join(topsrcdir, "nsprpub", "configure"),
1137             os.path.join(topsrcdir, "config", "milestone.txt"),
1138             os.path.join(topsrcdir, "browser", "config", "version.txt"),
1139             os.path.join(topsrcdir, "browser", "config", "version_display.txt"),
1140             os.path.join(topsrcdir, "build", "build_virtualenv_packages.txt"),
1141             os.path.join(topsrcdir, "build", "common_virtualenv_packages.txt"),
1142             os.path.join(topsrcdir, "build", "mach_virtualenv_packages.txt"),
1143             os.path.join(topsrcdir, "python", "mozbuild", "mozbuild", "virtualenv.py"),
1144             os.path.join(topsrcdir, "testing", "mozbase", "packages.txt"),
1145             os.path.join(topsrcdir, "aclocal.m4"),
1146             os.path.join(topsrcdir, "old-configure.in"),
1147             os.path.join(topsrcdir, "js", "src", "aclocal.m4"),
1148             os.path.join(topsrcdir, "js", "src", "old-configure.in"),
1149         ]
1150         + glob.glob(os.path.join(topsrcdir, "build", "autoconf", "*.m4"))
1151     )
1152
1153
1154 set_config("CONFIG_STATUS_DEPS", config_status_deps)
1155 # Please do not add anything after setting config_dep_paths.