Bug 1716846 [wpt PR 29402] - Update wpt metadata, a=testonly
[gecko.git] / moz.configure
blobfc66b520d006de2df10da33ddc8d62991bb673d0
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/.
7 include("build/moz.configure/init.configure")
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.
17 option(
18     "--enable-artifact-builds",
19     env="MOZ_ARTIFACT_BUILDS",
20     help="Download and use prebuilt binary artifacts.",
24 @depends("--enable-artifact-builds")
25 def artifact_builds(value):
26     if value:
27         return True
30 set_config("MOZ_ARTIFACT_BUILDS", artifact_builds)
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",
38 option(
39     "--enable-artifact-build-symbols",
40     nargs="?",
41     choices=("full",),
42     help="Download symbols when artifact builds are enabled.",
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
57 set_config("MOZ_ARTIFACT_BUILD_SYMBOLS", enable_artifact_build_symbols)
60 @depends("--enable-artifact-builds")
61 def imply_disable_compile_environment(value):
62     if value:
63         return False
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.",
72 set_config("MOZ_COPY_PDBS", depends_if("MOZ_COPY_PDBS")(lambda _: True))
74 imply_option("--enable-compile-environment", imply_disable_compile_environment)
76 option("--disable-compile-environment", help="Disable compiler/library checks")
79 @depends("--disable-compile-environment")
80 def compile_environment(compile_env):
81     if compile_env:
82         return True
85 set_config("COMPILE_ENVIRONMENT", compile_environment)
86 add_old_configure_assignment("COMPILE_ENVIRONMENT", compile_environment)
88 option("--disable-tests", help="Do not build test libraries & programs")
91 @depends("--disable-tests")
92 def enable_tests(value):
93     if value:
94         return True
97 set_config("ENABLE_TESTS", enable_tests)
98 set_define("ENABLE_TESTS", enable_tests)
101 @depends(enable_tests)
102 def gtest_has_rtti(value):
103     if value:
104         return "0"
107 set_define("GTEST_HAS_RTTI", gtest_has_rtti)
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")
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)
120 option(
121     "--enable-debug",
122     nargs="?",
123     help="Enable building with developer debug info "
124     "(using the given compiler flags).",
128 @depends("--enable-debug")
129 def moz_debug(debug):
130     if debug:
131         return bool(debug)
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)))
140 option(
141     "--with-debug-label",
142     nargs="+",
143     help="Debug DEBUG_<value> for each comma-separated value given",
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"]
154 set_config("MOZ_DEBUG_DEFINES", debug_defines)
156 option(env="MOZ_PGO", help="Build with profile guided optimizations")
158 set_config("MOZ_PGO", depends("MOZ_PGO")(lambda x: bool(x)))
161 imply_option("--enable-release", mozilla_official)
162 imply_option("--enable-release", depends_if("MOZ_AUTOMATION")(lambda x: True))
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.|}",
172 @depends("--enable-release")
173 def developer_options(value):
174     if not value:
175         return True
178 add_old_configure_assignment("DEVELOPER_OPTIONS", developer_options)
179 set_config("DEVELOPER_OPTIONS", developer_options)
182 option(
183     env="MOZ_FETCHES_DIR",
184     nargs=1,
185     when="MOZ_AUTOMATION",
186     help="Directory containing fetched artifacts",
190 @depends("MOZ_FETCHES_DIR", when="MOZ_AUTOMATION")
191 def moz_fetches_dir(value):
192     if value:
193         return value[0]
196 @depends(vcs_checkout_type, milestone.is_nightly, "MOZ_AUTOMATION")
197 def bootstrap_default(vcs_checkout_type, is_nightly, automation):
198     if automation:
199         return False
200     # We only enable if building off a VCS checkout of central.
201     if is_nightly and vcs_checkout_type:
202         return True
205 option(
206     "--enable-bootstrap",
207     default=bootstrap_default,
208     help="{Automatically bootstrap or update some toolchains|Disable bootstrap or update of toolchains}",
212 @depends(developer_options, "--enable-bootstrap", moz_fetches_dir)
213 def bootstrap_search_path_order(developer_options, bootstrap, moz_fetches_dir):
214     if moz_fetches_dir:
215         log.debug("Prioritizing MOZ_FETCHES_DIR in toolchain path.")
216         return "prepend"
218     if bootstrap:
219         log.debug(
220             "Prioritizing mozbuild state dir in toolchain paths because "
221             "bootstrap mode is enabled."
222         )
223         return "prepend"
225     if developer_options:
226         log.debug(
227             "Prioritizing mozbuild state dir in toolchain paths because "
228             "you are not building in release mode."
229         )
230         return "prepend"
232     log.debug(
233         "Prioritizing system over mozbuild state dir in "
234         "toolchain paths because you are building in "
235         "release mode."
236     )
237     return "append"
240 toolchains_base_dir = moz_fetches_dir | mozbuild_state_path
243 @dependable
244 @imports("os")
245 @imports(_from="os", _import="environ")
246 def original_path():
247     return environ["PATH"].split(os.pathsep)
250 @template
251 def bootstrap_toolchain_tasks(host_or_target):
252     @depends(host_or_target, when="--enable-bootstrap")
253     @imports("os")
254     @imports(_from="mozbuild.toolchains", _import="toolchain_task_definitions")
255     @imports(_from="__builtin__", _import="Exception")
256     def bootstrap_toolchain_tasks(host_or_target):
257         prefix = {
258             ("x86", "GNU", "Linux"): "linux32",
259             ("x86_64", "GNU", "Linux"): "linux64",
260             ("aarch64", "GNU", "Linux"): "linux64-aarch64",
261             ("x86_64", "OSX", "Darwin"): "macosx64",
262             ("aarch64", "OSX", "Darwin"): "macosx64-aarch64",
263             ("x86_64", "WINNT", "WINNT"): "win64",
264         }.get((host_or_target.cpu, host_or_target.os, host_or_target.kernel))
265         if prefix:
266             try:
267                 return namespace(prefix=prefix, tasks=toolchain_task_definitions())
268             except Exception:
269                 return None
271     return bootstrap_toolchain_tasks
274 host_bootstrap_toolchain_tasks = bootstrap_toolchain_tasks(host)
275 target_bootstrap_toolchain_tasks = bootstrap_toolchain_tasks(target)
278 @template
279 def bootstrap_path(path, **kwargs):
280     when = kwargs.pop("when", None)
281     context = kwargs.pop("context", host)
282     if kwargs:
283         configure_error(
284             "bootstrap_path only takes `when` or `context` as keyword arguments"
285         )
287     path_parts = path.split("/")
288     bootstrap_toolchain_tasks = {
289         host: host_bootstrap_toolchain_tasks,
290         target: target_bootstrap_toolchain_tasks,
291     }[context]
293     @depends(
294         "--enable-bootstrap",
295         toolchains_base_dir,
296         bootstrap_toolchain_tasks,
297         shell,
298         check_build_environment,
299         when=when,
300     )
301     @imports("os")
302     @imports("subprocess")
303     @imports(_from="mozbuild.util", _import="ensureParentDir")
304     @imports(_from="__builtin__", _import="open")
305     @imports(_from="__builtin__", _import="Exception")
306     def bootstrap_path(bootstrap, toolchains_base_dir, tasks, shell, build_env):
307         def try_bootstrap(exists):
308             if not tasks:
309                 return False
310             label = "toolchain-{}-{}".format(
311                 tasks.prefix, path_parts[0].replace("_", "-")
312             )
313             task = tasks.tasks.get(label)
314             if not task:
315                 return False
316             task_index = task.optimization.get("index-search")
317             if not task_index:
318                 return False
319             task_index = task_index[0].split(".")[-1]
320             artifact = task.attributes["toolchain-artifact"]
321             # `mach artifact toolchain` doesn't support authentication for
322             # private artifacts.
323             if not artifact.startswith("public/"):
324                 return False
325             index_file = os.path.join(toolchains_base_dir, "indices", path_parts[0])
326             try:
327                 with open(index_file) as fh:
328                     index = fh.read().strip()
329             except Exception:
330                 index = None
331             if index == task_index and exists:
332                 return True
333             log.info(
334                 "%s bootstrapped toolchain in %s",
335                 "Updating" if exists else "Installing",
336                 os.path.join(toolchains_base_dir, path_parts[0]),
337             )
338             subprocess.run(
339                 [
340                     shell,
341                     os.path.join(build_env.topsrcdir, "mach"),
342                     "--log-no-times",
343                     "artifact",
344                     "toolchain",
345                     "--from-build",
346                     label,
347                 ],
348                 cwd=toolchains_base_dir,
349                 check=True,
350             )
351             ensureParentDir(index_file)
352             with open(index_file, "w") as fh:
353                 fh.write(task_index)
354             return True
356         path = os.path.join(toolchains_base_dir, *path_parts)
357         if bootstrap:
358             try:
359                 if not try_bootstrap(os.path.exists(path)):
360                     # If there aren't toolchain artifacts to use for this build,
361                     # don't return a path.
362                     return None
363             except Exception as e:
364                 log.error("%s", e)
365                 die("If you can't fix the above, retry with --disable-bootstrap.")
366         # We re-test whether the path exists because it may have been created by
367         # try_bootstrap. Automation will not have gone through the bootstrap
368         # process, but we want to return the path if it exists.
369         if os.path.exists(path):
370             return path
372     return bootstrap_path
375 @template
376 def bootstrap_search_path(path, paths=original_path, **kwargs):
377     @depends(
378         bootstrap_path(path, **kwargs),
379         bootstrap_search_path_order,
380         paths,
381         original_path,
382     )
383     def bootstrap_search_path(path, order, paths, original_path):
384         if paths is None:
385             paths = original_path
386         if not path:
387             return paths
388         if order == "prepend":
389             return [path] + paths
390         return paths + [path]
392     return bootstrap_search_path
395 # The execution model of the configure sandbox doesn't allow for
396 # check_prog to use bootstrap_search_path directly because check_prog
397 # comes first, so we use a trick to allow it. No use of check_prog
398 # happening before here won't allow bootstrap.
399 @template
400 def check_prog(*args, **kwargs):
401     kwargs["bootstrap_search_path"] = bootstrap_search_path
402     return check_prog(*args, **kwargs)
405 @depends(target, host)
406 def want_wine(target, host):
407     return target.kernel == "WINNT" and host.kernel != "WINNT"
410 wine = check_prog(
411     "WINE",
412     ["wine64", "wine"],
413     allow_missing=True,
414     when=want_wine,
415     bootstrap="wine/bin",
417 check_prog("WGET", ("wget",), allow_missing=True)
420 include("build/moz.configure/toolchain.configure", when="--enable-compile-environment")
422 include("build/moz.configure/pkg.configure")
423 # Make this assignment here rather than in pkg.configure to avoid
424 # requiring this file in unit tests.
425 add_old_configure_assignment("PKG_CONFIG", pkg_config)
427 include("build/moz.configure/memory.configure", when="--enable-compile-environment")
428 include("build/moz.configure/headers.configure", when="--enable-compile-environment")
429 include("build/moz.configure/warnings.configure", when="--enable-compile-environment")
430 include("build/moz.configure/flags.configure", when="--enable-compile-environment")
431 include("build/moz.configure/lto-pgo.configure", when="--enable-compile-environment")
432 # rust.configure is included by js/moz.configure.
434 option("--enable-valgrind", help="Enable Valgrind integration hooks")
436 valgrind_h = check_header("valgrind/valgrind.h", when="--enable-valgrind")
439 @depends("--enable-valgrind", valgrind_h)
440 def check_valgrind(valgrind, valgrind_h):
441     if valgrind:
442         if not valgrind_h:
443             die("--enable-valgrind specified but Valgrind is not installed")
444         return True
447 set_define("MOZ_VALGRIND", check_valgrind)
448 set_config("MOZ_VALGRIND", check_valgrind)
451 @depends(target, host)
452 def is_openbsd(target, host):
453     return target.kernel == "OpenBSD" or host.kernel == "OpenBSD"
456 option(
457     env="SO_VERSION",
458     nargs=1,
459     default="1.0",
460     when=is_openbsd,
461     help="Shared library version for OpenBSD systems",
465 @depends("SO_VERSION", when=is_openbsd)
466 def so_version(value):
467     return value
470 @template
471 def library_name_info_template(host_or_target):
472     assert host_or_target in {host, target}
473     compiler = {
474         host: host_c_compiler,
475         target: c_compiler,
476     }[host_or_target]
478     @depends(host_or_target, compiler, so_version)
479     def library_name_info_impl(host_or_target, compiler, so_version):
480         if host_or_target.kernel == "WINNT":
481             # There aren't artifacts for mingw builds, so it's OK that the
482             # results are inaccurate in that case.
483             if compiler and compiler.type != "clang-cl":
484                 return namespace(
485                     dll=namespace(prefix="", suffix=".dll"),
486                     lib=namespace(prefix="lib", suffix="a"),
487                     import_lib=namespace(prefix="lib", suffix="a"),
488                     obj=namespace(prefix="", suffix="o"),
489                 )
491             return namespace(
492                 dll=namespace(prefix="", suffix=".dll"),
493                 lib=namespace(prefix="", suffix="lib"),
494                 import_lib=namespace(prefix="", suffix="lib"),
495                 obj=namespace(prefix="", suffix="obj"),
496             )
498         elif host_or_target.kernel == "Darwin":
499             return namespace(
500                 dll=namespace(prefix="lib", suffix=".dylib"),
501                 lib=namespace(prefix="lib", suffix="a"),
502                 import_lib=namespace(prefix=None, suffix=""),
503                 obj=namespace(prefix="", suffix="o"),
504             )
505         elif so_version:
506             so = ".so.%s" % so_version
507         else:
508             so = ".so"
510         return namespace(
511             dll=namespace(prefix="lib", suffix=so),
512             lib=namespace(prefix="lib", suffix="a"),
513             import_lib=namespace(prefix=None, suffix=""),
514             obj=namespace(prefix="", suffix="o"),
515         )
517     return library_name_info_impl
520 host_library_name_info = library_name_info_template(host)
521 library_name_info = library_name_info_template(target)
523 set_config("DLL_PREFIX", library_name_info.dll.prefix)
524 set_config("DLL_SUFFIX", library_name_info.dll.suffix)
525 set_config("HOST_DLL_PREFIX", host_library_name_info.dll.prefix)
526 set_config("HOST_DLL_SUFFIX", host_library_name_info.dll.suffix)
527 set_config("LIB_PREFIX", library_name_info.lib.prefix)
528 set_config("LIB_SUFFIX", library_name_info.lib.suffix)
529 set_config("OBJ_SUFFIX", library_name_info.obj.suffix)
530 # Lots of compilation tests depend on this variable being present.
531 add_old_configure_assignment("OBJ_SUFFIX", library_name_info.obj.suffix)
532 set_config("IMPORT_LIB_SUFFIX", library_name_info.import_lib.suffix)
533 set_define(
534     "MOZ_DLL_PREFIX", depends(library_name_info.dll.prefix)(lambda s: '"%s"' % s)
536 set_define(
537     "MOZ_DLL_SUFFIX", depends(library_name_info.dll.suffix)(lambda s: '"%s"' % s)
539 set_config("WASM_OBJ_SUFFIX", "wasm")
541 # Make `profiling` available to this file even when js/moz.configure
542 # doesn't end up included.
543 profiling = dependable(False)
544 # Same for js_standalone
545 js_standalone = dependable(False)
546 # Same for fold_libs
547 fold_libs = dependable(False)
549 include(include_project_configure)
552 @depends("--help")
553 @imports(_from="mozbuild.backend", _import="backends")
554 def build_backends_choices(_):
555     return tuple(backends)
558 @deprecated_option("--enable-build-backend", nargs="+", choices=build_backends_choices)
559 def build_backend(backends):
560     if backends:
561         return tuple("+%s" % b for b in backends)
564 imply_option("--build-backends", build_backend)
567 @depends(
568     "--enable-artifact-builds",
569     "--disable-compile-environment",
570     "--enable-build-backend",
571     "--enable-project",
572     "--enable-application",
573     "--help",
575 @imports("sys")
576 def build_backend_defaults(
577     artifact_builds, compile_environment, requested_backends, project, application, _
579     if application:
580         project = application[0]
581     elif project:
582         project = project[0]
584     if "Tup" in requested_backends:
585         # As a special case, if Tup was requested, do not combine it with any
586         # Make based backend by default.
587         all_backends = []
588     elif artifact_builds:
589         all_backends = ["FasterMake+RecursiveMake"]
590     else:
591         all_backends = ["RecursiveMake", "FasterMake"]
592     # Normally, we'd use target.os == 'WINNT', but a dependency on target
593     # would require target to depend on --help, as well as host and shell,
594     # and this is not a can of worms we can open at the moment.
595     if (
596         sys.platform == "win32"
597         and compile_environment
598         and project not in ("mobile/android", "memory", "tools/update-programs")
599     ):
600         all_backends.append("VisualStudio")
601     return tuple(all_backends) or None
604 option(
605     "--build-backends",
606     nargs="+",
607     default=build_backend_defaults,
608     choices=build_backends_choices,
609     help="Build backends to generate",
613 @depends("--build-backends")
614 def build_backends(backends):
615     return backends
618 set_config("BUILD_BACKENDS", build_backends)
621 @depends(check_build_environment, build_backends)
622 @imports("glob")
623 def check_objdir_backend_reuse(build_env, backends):
624     # "Make based" might be RecursiveMake or a hybrid backend, so "Make" is
625     # intentionally vague for use with the substring match below.
626     incompatible_backends = (("Tup", "Make"), ("Make", "Tup"))
627     for backend_file in glob.iglob(
628         os.path.join(build_env.topobjdir, "backend.*Backend")
629     ):
630         for prev, curr in incompatible_backends:
631             if prev in backend_file and any(curr in b for b in backends):
632                 die(
633                     "The active objdir, %s, was previously "
634                     "used to build with a %s based backend. "
635                     "Change objdirs (by setting MOZ_OBJDIR in "
636                     "your mozconfig) or clobber to continue.\n",
637                     build_env.topobjdir,
638                     prev,
639                 )
642 option(
643     "--disable-gtest-in-build",
644     help="Force disable building the gtest libxul during the build.",
645     when="--enable-compile-environment",
648 # Determine whether to build the gtest xul. This happens in automation
649 # on Android and Desktop platforms with the exception of:
650 #  - Windows PGO, where linking xul-gtest.dll takes too long;
651 #  - Android other than x86_64, where gtest is not required.
654 @depends(
655     "MOZ_PGO",
656     build_project,
657     target,
658     "MOZ_AUTOMATION",
659     "--disable-gtest-in-build",
660     enable_tests,
661     when="--enable-compile-environment",
663 def build_gtest(pgo, build_project, target, automation, enabled, enable_tests):
664     if not enable_tests or not enabled:
665         return None
666     if (
667         automation
668         and build_project in ("browser", "comm/mail", "mobile/android")
669         and not (
670             (pgo and target.os == "WINNT")
671             or (target.os == "Android" and target.cpu != "x86_64")
672         )
673     ):
674         return True
677 set_config("LINK_GTEST_DURING_COMPILE", build_gtest)
679 # Localization
680 # ==============================================================
681 option(
682     "--enable-ui-locale",
683     default="en-US",
684     help="Select the user interface locale (default: en-US)",
687 set_config("MOZ_UI_LOCALE", depends("--enable-ui-locale")(lambda x: x))
689 # clang-plugin location
690 # ==============================================================
693 @depends(host_library_name_info, check_build_environment, when="--enable-clang-plugin")
694 def clang_plugin_path(library_name_info, build_env):
695     topobjdir = build_env.topobjdir
696     if topobjdir.endswith("/js/src"):
697         topobjdir = topobjdir[:-7]
698     return os.path.abspath(
699         os.path.join(
700             topobjdir,
701             "build",
702             "clang-plugin",
703             "%sclang-plugin%s"
704             % (library_name_info.dll.prefix, library_name_info.dll.suffix),
705         )
706     )
709 set_config("CLANG_PLUGIN", clang_plugin_path)
710 add_old_configure_assignment("CLANG_PLUGIN", clang_plugin_path)
713 # Awk detection
714 # ==============================================================
715 awk = check_prog("AWK", ("gawk", "mawk", "nawk", "awk"))
717 # Until the AWK variable is not necessary in old-configure
720 @depends(awk)
721 def awk_for_old_configure(value):
722     return value
725 add_old_configure_assignment("AWK", awk_for_old_configure)
728 # Perl detection
729 # ==============================================================
730 perl = check_prog("PERL", ("perl5", "perl"))
732 # Until the PERL variable is not necessary in old-configure
735 @depends(perl)
736 def perl_for_old_configure(value):
737     return value
740 add_old_configure_assignment("PERL", perl_for_old_configure)
743 @template
744 def perl_version_check(min_version):
745     @depends(perl)
746     @checking("for minimum required perl version >= %s" % min_version)
747     def get_perl_version(perl):
748         return Version(
749             check_cmd_output(
750                 perl,
751                 "-e",
752                 "print $]",
753                 onerror=lambda: die("Failed to get perl version."),
754             )
755         )
757     @depends(get_perl_version)
758     def check_perl_version(version):
759         if version < min_version:
760             die("Perl %s or higher is required.", min_version)
762     @depends(perl)
763     @checking("for full perl installation")
764     @imports("subprocess")
765     def has_full_perl_installation(perl):
766         ret = subprocess.call([perl, "-e", "use Config; exit(!-d $Config{archlib})"])
767         return ret == 0
769     @depends(has_full_perl_installation)
770     def require_full_perl_installation(has_full_perl_installation):
771         if not has_full_perl_installation:
772             die(
773                 "Cannot find Config.pm or $Config{archlib}. "
774                 "A full perl installation is required."
775             )
778 perl_version_check("5.006")
781 # GNU make detection
782 # ==============================================================
783 option(env="MAKE", nargs=1, help="Path to GNU make")
786 @depends("MAKE", host)
787 def possible_makes(make, host):
788     candidates = []
789     if host.kernel == "WINNT":
790         candidates.append("mingw32-make")
791     if make:
792         candidates.append(make[0])
793     if host.kernel == "WINNT":
794         candidates.extend(("mozmake", "make", "gmake"))
795     else:
796         candidates.extend(("gmake", "make"))
797     return candidates
800 check_prog("GMAKE", possible_makes, bootstrap="mozmake")
802 # watchman detection
803 # ==============================================================
805 option(env="WATCHMAN", nargs=1, help="Path to the watchman program")
808 @depends(host, "WATCHMAN")
809 @checking("for watchman", callback=lambda w: w.path if w else "not found")
810 def watchman(host, prog):
811     # On Windows, `watchman` is only supported on 64-bit hosts.
812     if host.os == "WINNT" and host.cpu != "x86_64":
813         return
815     if not prog:
816         prog = find_program("watchman")
818     if not prog:
819         return
821     # `watchman version` will talk to the Watchman daemon service.
822     # This can hang due to permissions problems. e.g.
823     # https://github.com/facebook/watchman/issues/376. So use
824     # `watchman --version` to prevent a class of failures.
825     out = check_cmd_output(prog, "--version", onerror=lambda: None)
826     if out is None:
827         return
829     return namespace(path=prog, version=Version(out.strip()))
832 @depends_if(watchman)
833 @checking("for watchman version")
834 def watchman_version(w):
835     return w.version
838 set_config("WATCHMAN", watchman.path)
841 @depends_all(hg_version, hg_config, watchman)
842 @checking("for watchman Mercurial integration")
843 @imports("os")
844 def watchman_hg(hg_version, hg_config, watchman):
845     if hg_version < Version("3.8"):
846         return "no (Mercurial 3.8+ required)"
848     ext_enabled = False
849     mode_disabled = False
851     for k in ("extensions.fsmonitor", "extensions.hgext.fsmonitor"):
852         if k in hg_config and hg_config[k] != "!":
853             ext_enabled = True
855     mode_disabled = hg_config.get("fsmonitor.mode") == "off"
857     if not ext_enabled:
858         return "no (fsmonitor extension not enabled)"
859     if mode_disabled:
860         return "no (fsmonitor.mode=off disables fsmonitor)"
862     return True
865 # Miscellaneous programs
866 # ==============================================================
867 check_prog("XARGS", ("xargs",))
870 @depends(target)
871 def extra_programs(target):
872     if target.kernel == "Darwin":
873         return namespace(
874             DSYMUTIL=("dsymutil", "llvm-dsymutil"),
875             MKFSHFS=("newfs_hfs", "mkfs.hfsplus"),
876             HFS_TOOL=("hfsplus",),
877         )
878     if target.os == "GNU" and target.kernel == "Linux":
879         return namespace(RPMBUILD=("rpmbuild",))
882 check_prog("DSYMUTIL", extra_programs.DSYMUTIL, allow_missing=True)
883 check_prog("MKFSHFS", extra_programs.MKFSHFS, allow_missing=True)
884 check_prog("HFS_TOOL", extra_programs.HFS_TOOL, allow_missing=True)
885 check_prog("RPMBUILD", extra_programs.RPMBUILD, allow_missing=True)
888 @depends(target)
889 @imports("os")
890 def makensis_progs(target):
891     if target.kernel != "WINNT":
892         return
894     candidates = [
895         "makensis-3.01",
896         "makensis-3.0b3",
897         "makensis-3.0b1",
898         "makensis",
899     ]
901     # Look for nsis installed by msys environment. But only the 32-bit version.
902     # We use an absolute path and insert as the first entry so it is preferred
903     # over a 64-bit exe that may be in PATH.
904     if "MSYSTEM_PREFIX" in os.environ:
905         prefix = os.path.dirname(os.environ["MSYSTEM_PREFIX"])
906         candidates.insert(0, os.path.join(prefix, "mingw32", "bin", "makensis.exe"))
908     return tuple(candidates)
911 nsis = check_prog("MAKENSISU", makensis_progs, allow_missing=True)
913 # Make sure the version of makensis is up to date.
916 @depends(nsis, wine)
917 @checking("for NSIS version")
918 @imports("re")
919 def nsis_version(nsis, wine):
920     if not nsis:
921         return None
922     nsis_min_version = "3.0b1"
924     def onerror():
925         return die("Failed to get nsis version.")
927     if wine and nsis.lower().endswith(".exe"):
928         out = check_cmd_output(wine, nsis, "-version", onerror=onerror)
929     else:
930         out = check_cmd_output(nsis, "-version", onerror=onerror)
932     m = re.search(r"(?<=v)[0-9]+\.[0-9]+((a|b|rc)[0-9]+)?", out)
934     if not m:
935         raise FatalCheckError("Unknown version of makensis")
936     ver = Version(m.group(0))
938     # Versions comparisons don't quite work well with beta versions, so ensure
939     # it works for the non-beta version.
940     if ver < nsis_min_version and (ver >= "3.0a" or ver < "3"):
941         raise FatalCheckError(
942             "To build the installer you must have NSIS"
943             " version %s or greater in your path" % nsis_min_version
944         )
946     return ver
949 # And that makensis is 32-bit (but only on Windows).
950 @depends_if(nsis, when=depends(host)(lambda h: h.kernel == "WINNT"))
951 @checking("for 32-bit NSIS")
952 def nsis_binary_type(nsis):
953     bin_type = windows_binary_type(nsis)
954     if bin_type != "win32":
955         raise FatalCheckError("%s is not a 32-bit Windows application" % nsis)
957     return "yes"
960 # And any flags we have to give to makensis
961 @depends(host)
962 def nsis_flags(host):
963     if host.kernel != "WINNT":
964         return "-nocd"
965     return ""
968 set_config("MAKENSISU_FLAGS", nsis_flags)
970 check_prog("7Z", ("7z", "7za"), allow_missing=True, when=target_is_windows)
971 check_prog("UPX", ("upx",), allow_missing=True, when=target_is_windows)
974 @depends(host_c_compiler, c_compiler, bindgen_config_paths)
975 def llvm_objdump(host_c_compiler, c_compiler, bindgen_config_paths):
976     clang = None
977     for compiler in (host_c_compiler, c_compiler):
978         if compiler and compiler.type == "clang":
979             clang = compiler.compiler
980             break
981         elif compiler and compiler.type == "clang-cl":
982             clang = os.path.join(os.path.dirname(compiler.compiler), "clang")
983             break
985     if not clang and bindgen_config_paths:
986         clang = bindgen_config_paths.clang_path
987     llvm_objdump = "llvm-objdump"
988     if clang:
989         out = check_cmd_output(
990             clang, "--print-prog-name=llvm-objdump", onerror=lambda: None
991         )
992         if out:
993             llvm_objdump = out.rstrip()
994     return (llvm_objdump,)
997 llvm_objdump = check_prog(
998     "LLVM_OBJDUMP",
999     llvm_objdump,
1000     what="llvm-objdump",
1001     when="--enable-compile-environment",
1002     paths=clang_search_path,
1005 add_old_configure_assignment("LLVM_OBJDUMP", llvm_objdump)
1008 option("--enable-dtrace", help="Build with dtrace support")
1010 dtrace = check_header(
1011     "sys/sdt.h",
1012     when="--enable-dtrace",
1013     onerror=lambda: die("dtrace enabled but sys/sdt.h not found"),
1016 set_config("HAVE_DTRACE", True, when=dtrace)
1017 set_define("INCLUDE_MOZILLA_DTRACE", True, when=dtrace)
1018 add_old_configure_assignment("enable_dtrace", "yes", when=dtrace)
1021 option("--disable-icf", help="Disable Identical Code Folding")
1023 add_old_configure_assignment(
1024     "MOZ_DISABLE_ICF", "1", when=depends("--enable-icf")(lambda x: not x)
1028 option(
1029     "--enable-strip",
1030     when=compile_environment,
1031     help="Enable stripping of libs & executables",
1034 # This should be handled as a `when` once bug 1617793 is fixed.
1037 @depends("--enable-strip", c_compiler, when=compile_environment)
1038 def enable_strip(strip, c_compiler):
1039     if strip and c_compiler.type != "clang-cl":
1040         return True
1043 set_config("ENABLE_STRIP", enable_strip)
1045 option(
1046     "--disable-install-strip",
1047     when=compile_environment,
1048     help="Enable stripping of libs & executables when packaging",
1051 # This should be handled as a `when` once bug 1617793 is fixed.
1054 @depends("--enable-install-strip", c_compiler, when=compile_environment)
1055 def enable_install_strip(strip, c_compiler):
1056     if strip and c_compiler.type != "clang-cl":
1057         return True
1060 set_config("PKG_STRIP", enable_install_strip)
1063 @depends("--enable-strip", "--enable-install-strip", when=compile_environment)
1064 def strip(strip, install_strip):
1065     return strip or install_strip
1068 option(env="STRIP_FLAGS", nargs=1, when=strip, help="Flags for the strip command")
1071 @depends("STRIP_FLAGS", profiling, target, when=strip)
1072 def strip_flags(flags, profiling, target):
1073     if flags:
1074         return flags[0].split()
1075     if profiling:
1076         # Only strip debug info and symbols when profiling is enabled, keeping
1077         # local symbols.
1078         if target.kernel == "Darwin":
1079             return ["-S"]
1080         elif target.os == "Android":
1081             # The tooling we use with Android supports detached symbols, and the
1082             # size increase caused by local symbols are too much for mobile. So,
1083             # don't restrict the amount of stripping with a flag.
1084             return
1085         else:
1086             return ["--strip-debug"]
1087     # Otherwise strip everything we can, which happens without flags on non-Darwin.
1088     # On Darwin, it tries to strip things it can't, so we need to limit its scope.
1089     elif target.kernel == "Darwin":
1090         return ["-x", "-S"]
1093 set_config("STRIP_FLAGS", strip_flags)
1096 @depends(js_standalone, target)
1097 def system_zlib_default(js_standalone, target):
1098     return js_standalone and target.kernel != "WINNT"
1101 option(
1102     "--with-system-zlib",
1103     nargs="?",
1104     default=system_zlib_default,
1105     help="{Use|Do not use} system libz",
1109 @depends("--with-system-zlib")
1110 def deprecated_system_zlib_path(value):
1111     if len(value) == 1:
1112         die(
1113             "--with-system-zlib=PATH is not supported anymore. Please use "
1114             "--with-system-zlib and set any necessary pkg-config environment variable."
1115         )
1118 pkg_check_modules("MOZ_ZLIB", "zlib >= 1.2.3", when="--with-system-zlib")
1120 set_config("MOZ_SYSTEM_ZLIB", True, when="--with-system-zlib")
1121 add_old_configure_assignment("MOZ_SYSTEM_ZLIB", True, when="--with-system-zlib")
1124 # Please do not add configure checks from here on.
1126 # Fallthrough to autoconf-based configure
1127 include("build/moz.configure/old.configure")
1129 # JS Subconfigure.
1130 include("js/sub.configure", when=compile_environment & toolkit)
1133 @depends(check_build_environment, build_project)
1134 @imports("__sandbox__")
1135 @imports("glob")
1136 @imports(_from="os.path", _import="exists")
1137 def config_status_deps(build_env, build_project):
1139     topsrcdir = build_env.topsrcdir
1140     topobjdir = build_env.topobjdir
1142     if not topobjdir.endswith("js/src"):
1143         extra_deps = [os.path.join(topobjdir, ".mozconfig.json")]
1144     else:
1145         # mozconfig changes may impact js configure.
1146         extra_deps = [os.path.join(topobjdir[:-7], ".mozconfig.json")]
1148     confvars = os.path.join(topsrcdir, build_project, "confvars.sh")
1149     if exists(confvars):
1150         extra_deps.append(confvars)
1152     return (
1153         list(__sandbox__._all_paths)
1154         + extra_deps
1155         + [
1156             os.path.join(topsrcdir, "CLOBBER"),
1157             os.path.join(topsrcdir, "configure.in"),
1158             os.path.join(topsrcdir, "js", "src", "configure.in"),
1159             os.path.join(topsrcdir, "nsprpub", "configure"),
1160             os.path.join(topsrcdir, "config", "milestone.txt"),
1161             os.path.join(topsrcdir, "browser", "config", "version.txt"),
1162             os.path.join(topsrcdir, "browser", "config", "version_display.txt"),
1163             os.path.join(topsrcdir, "build", "build_virtualenv_packages.txt"),
1164             os.path.join(topsrcdir, "build", "common_virtualenv_packages.txt"),
1165             os.path.join(topsrcdir, "build", "mach_virtualenv_packages.txt"),
1166             os.path.join(topsrcdir, "python", "mozbuild", "mozbuild", "virtualenv.py"),
1167             os.path.join(topsrcdir, "aclocal.m4"),
1168             os.path.join(topsrcdir, "old-configure.in"),
1169             os.path.join(topsrcdir, "js", "src", "aclocal.m4"),
1170             os.path.join(topsrcdir, "js", "src", "old-configure.in"),
1171         ]
1172         + glob.glob(os.path.join(topsrcdir, "build", "autoconf", "*.m4"))
1173     )
1176 set_config("CONFIG_STATUS_DEPS", config_status_deps)
1177 # Please do not add anything after setting config_dep_paths.