js/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
   8 @depends(build_project)
   9 def js_standalone(build_project):
  10     if build_project == "js":
  11         return True
  12
  13
  14 # Debug (see Bug 939505)
  15 # ==============================================================
  16 set_define("JS_DEBUG", True, when=moz_debug)
  17
  18
  19 # Branding
  20 # ==============================================================
  21 option(
  22     "--with-app-name",
  23     env="MOZ_APP_NAME",
  24     nargs=1,
  25     help="Used for e.g. the binary program file name. If not set, "
  26     "defaults to a lowercase form of MOZ_APP_BASENAME.",
  27 )
  28
  29
  30 @depends("--with-app-name", js_standalone, moz_app_basename)
  31 def moz_app_name(value, js_standalone, moz_app_basename):
  32     if value:
  33         return value[0]
  34     if js_standalone:
  35         return "js"
  36     return moz_app_basename.lower()
  37
  38
  39 set_config("MOZ_APP_NAME", moz_app_name)
  40
  41 # SmooshMonkey (new frontend)
  42 # ==================================================
  43
  44 # Define here in order to use the option from bindgen.configure.
  45 option(
  46     "--enable-smoosh",
  47     default=False,
  48     help="Enable SmooshMonkey (new JS engine frontend)",
  49 )
  50
  51
  52 @depends("--enable-smoosh")
  53 def enable_smoosh(value):
  54     if value:
  55         return True
  56
  57
  58 set_config("JS_ENABLE_SMOOSH", enable_smoosh)
  59 set_define("JS_ENABLE_SMOOSH", enable_smoosh)
  60
  61 include("../build/moz.configure/nspr.configure", when="--enable-compile-environment")
  62 include("../build/moz.configure/rust.configure", when="--enable-compile-environment")
  63 include("../build/moz.configure/bindgen.configure", when="--enable-compile-environment")
  64
  65 set_config("JS_STANDALONE", js_standalone)
  66 set_define("JS_STANDALONE", js_standalone)
  67 add_old_configure_assignment("JS_STANDALONE", js_standalone)
  68 option(
  69     "--enable-js-shell", default=js_standalone, help="{Build|Do not build} the JS shell"
  70 )
  71
  72
  73 @depends("--enable-js-shell")
  74 def js_disable_shell(value):
  75     if not value:
  76         return True
  77
  78
  79 set_config("JS_DISABLE_SHELL", js_disable_shell)
  80
  81 set_define("JS_64BIT", depends(target)(lambda t: t.bitness == 64 or None))
  82
  83 set_define("JS_PUNBOX64", depends(target)(lambda t: t.bitness == 64 or None))
  84 set_define("JS_NUNBOX32", depends(target)(lambda t: t.bitness == 32 or None))
  85
  86
  87 # SpiderMonkey as a shared library, and how its symbols are exported
  88 # ==================================================================
  89 option(
  90     "--disable-shared-js",
  91     when=js_standalone,
  92     help="{Create|Do not create} a shared library",
  93 )
  94
  95 option(
  96     "--disable-export-js",
  97     when=js_standalone,
  98     help="{Mark|Do not mark} JS symbols as DLL exported/visible",
  99 )
 100
 101
 102 @depends("--disable-shared-js", "--disable-export-js", when=js_standalone)
 103 def shared_js(shared_js, export_js):
 104     if shared_js:
 105         if not export_js:
 106             die("Must export JS symbols when building a shared library.")
 107         return True
 108
 109
 110 set_config("JS_SHARED_LIBRARY", shared_js)
 111
 112
 113 @depends(shared_js, "--disable-export-js", when=js_standalone)
 114 def exportable_js_api(shared_js, export_js):
 115     if not shared_js and export_js:
 116         return True
 117
 118
 119 set_define("STATIC_EXPORTABLE_JS_API", exportable_js_api)
 120
 121
 122 @depends(shared_js, exportable_js_api)
 123 def static_js_api(shared_js, export_js):
 124     if not shared_js and not export_js:
 125         return True
 126
 127
 128 set_define("STATIC_JS_API", static_js_api)
 129
 130
 131 @depends(shared_js)
 132 def static_js(value):
 133     if not value:
 134         return True
 135
 136
 137 set_define("MOZ_STATIC_JS", static_js)
 138
 139
 140 # Enable records and tuples
 141 # ===================================================
 142 option(
 143     "--enable-record-tuple",
 144     default=False,
 145     help="Enable records and tuples (and disables JIT)",
 146 )
 147
 148
 149 @depends("--enable-record-tuple")
 150 def enable_record_tuple(value):
 151     if value:
 152         return True
 153
 154
 155 set_config("ENABLE_RECORD_TUPLE", enable_record_tuple)
 156 set_define("ENABLE_RECORD_TUPLE", enable_record_tuple)
 157
 158 # Enable decorators
 159 # ===================================================
 160 option(
 161     "--enable-decorators",
 162     default=False,
 163     help="Enable experimental JS Decorators support",
 164 )
 165
 166
 167 @depends("--enable-decorators")
 168 def enable_decorators(value):
 169     if value:
 170         return True
 171
 172
 173 set_config("ENABLE_DECORATORS", enable_decorators)
 174 set_define("ENABLE_DECORATORS", enable_decorators)
 175
 176 # JIT support
 177 # =======================================================
 178 @depends(target, "--enable-record-tuple")
 179 def jit_default(target, enable_record_tuple):
 180     if enable_record_tuple:
 181         return False
 182     if target.cpu in (
 183         "x86",
 184         "x86_64",
 185         "arm",
 186         "aarch64",
 187         "mips32",
 188         "mips64",
 189         "loongarch64",
 190     ):
 191         return True
 192     return False
 193
 194
 195 option("--enable-jit", default=jit_default, help="{Enable|Disable} use of the JITs")
 196
 197
 198 @deprecated_option("--enable-ion")
 199 def report_deprecated(value):
 200     if value:
 201         die("--enable-ion is deprecated, use --enable-jit instead")
 202     else:
 203         die("--disable-ion is deprecated, use --disable-jit instead")
 204
 205
 206 # JIT code simulator for cross compiles
 207 # =======================================================
 208 option(
 209     "--enable-simulator",
 210     choices=("arm", "arm64", "mips32", "mips64", "loong64", "riscv64"),
 211     nargs=1,
 212     help="Enable a JIT code simulator for the specified architecture",
 213 )
 214
 215
 216 @depends("--enable-jit", "--enable-simulator", target)
 217 def simulator(jit_enabled, simulator_enabled, target):
 218     if not jit_enabled or not simulator_enabled:
 219         return
 220
 221     sim_cpu = simulator_enabled[0]
 222
 223     if sim_cpu in ("arm", "mips32"):
 224         if target.cpu != "x86":
 225             die("The %s simulator only works on x86." % sim_cpu)
 226
 227     if sim_cpu in ("arm64", "mips64", "loong64", "riscv64"):
 228         if target.cpu != "x86_64" and target.cpu != "aarch64":
 229             die("The %s simulator only works on x86-64 or arm64." % sim_cpu)
 230
 231     return namespace(**{sim_cpu: True})
 232
 233
 234 set_config("JS_SIMULATOR", depends_if(simulator)(lambda x: True))
 235 set_config("JS_SIMULATOR_ARM", simulator.arm)
 236 set_config("JS_SIMULATOR_ARM64", simulator.arm64)
 237 set_config("JS_SIMULATOR_MIPS32", simulator.mips32)
 238 set_config("JS_SIMULATOR_MIPS64", simulator.mips64)
 239 set_config("JS_SIMULATOR_LOONG64", simulator.loong64)
 240 set_config("JS_SIMULATOR_RISCV64", simulator.riscv64)
 241 set_define("JS_SIMULATOR", depends_if(simulator)(lambda x: True))
 242 set_define("JS_SIMULATOR_ARM", simulator.arm)
 243 set_define("JS_SIMULATOR_ARM64", simulator.arm64)
 244 set_define("JS_SIMULATOR_MIPS32", simulator.mips32)
 245 set_define("JS_SIMULATOR_MIPS64", simulator.mips64)
 246 set_define("JS_SIMULATOR_LOONG64", simulator.loong64)
 247 set_define("JS_SIMULATOR_RISCV64", simulator.riscv64)
 248
 249
 250 @depends("--enable-jit", simulator, target)
 251 def jit_codegen(jit_enabled, simulator, target):
 252     if not jit_enabled:
 253         return namespace(none=True)
 254
 255     if simulator:
 256         return simulator
 257
 258     if target.cpu == "aarch64":
 259         return namespace(arm64=True)
 260     elif target.cpu == "x86_64":
 261         return namespace(x64=True)
 262     elif target.cpu == "loongarch64":
 263         return namespace(loong64=True)
 264     elif target.cpu == "riscv64":
 265         return namespace(riscv64=True)
 266
 267     return namespace(**{str(target.cpu): True})
 268
 269
 270 set_config("JS_CODEGEN_NONE", jit_codegen.none)
 271 set_config("JS_CODEGEN_ARM", jit_codegen.arm)
 272 set_config("JS_CODEGEN_ARM64", jit_codegen.arm64)
 273 set_config("JS_CODEGEN_MIPS32", jit_codegen.mips32)
 274 set_config("JS_CODEGEN_MIPS64", jit_codegen.mips64)
 275 set_config("JS_CODEGEN_LOONG64", jit_codegen.loong64)
 276 set_config("JS_CODEGEN_RISCV64", jit_codegen.riscv64)
 277 set_config("JS_CODEGEN_X86", jit_codegen.x86)
 278 set_config("JS_CODEGEN_X64", jit_codegen.x64)
 279 set_config("JS_CODEGEN_WASM32", jit_codegen.wasm32)
 280
 281 set_define("JS_CODEGEN_NONE", jit_codegen.none)
 282 set_define("JS_CODEGEN_ARM", jit_codegen.arm)
 283 set_define("JS_CODEGEN_ARM64", jit_codegen.arm64)
 284 set_define("JS_CODEGEN_MIPS32", jit_codegen.mips32)
 285 set_define("JS_CODEGEN_MIPS64", jit_codegen.mips64)
 286 set_define("JS_CODEGEN_LOONG64", jit_codegen.loong64)
 287 set_define("JS_CODEGEN_RISCV64", jit_codegen.riscv64)
 288 set_define("JS_CODEGEN_X86", jit_codegen.x86)
 289 set_define("JS_CODEGEN_X64", jit_codegen.x64)
 290 set_define("JS_CODEGEN_WASM32", jit_codegen.wasm32)
 291
 292
 293 # Profiling
 294 # =======================================================
 295 option(
 296     "--enable-instruments",
 297     env="MOZ_INSTRUMENTS",
 298     help="Enable instruments remote profiling",
 299 )
 300
 301
 302 @depends("--enable-instruments", target)
 303 def instruments(value, target):
 304     if value and target.os != "OSX":
 305         die("--enable-instruments cannot be used when targeting %s", target.os)
 306     if value:
 307         return True
 308
 309
 310 set_config("MOZ_INSTRUMENTS", instruments)
 311 set_define("MOZ_INSTRUMENTS", instruments)
 312 add_old_configure_assignment("MOZ_INSTRUMENTS", instruments)
 313 imply_option("--enable-profiling", instruments, reason="--enable-instruments")
 314
 315 option("--enable-callgrind", env="MOZ_CALLGRIND", help="Enable callgrind profiling")
 316
 317
 318 @depends("--enable-callgrind")
 319 def callgrind(value):
 320     if value:
 321         return True
 322
 323
 324 set_define("MOZ_CALLGRIND", callgrind)
 325 imply_option("--enable-profiling", callgrind)
 326
 327
 328 @depends(milestone)
 329 def enable_profiling(milestone):
 330     return milestone.is_nightly
 331
 332
 333 option(
 334     "--enable-profiling",
 335     env="MOZ_PROFILING",
 336     default=enable_profiling,
 337     help="{Set|Do not set} compile flags necessary for using sampling "
 338     "profilers (e.g. shark, perf)",
 339 )
 340
 341
 342 @depends("--enable-profiling")
 343 def profiling(value):
 344     if value:
 345         return True
 346
 347
 348 with only_when("--enable-compile-environment"):
 349     imply_option("--enable-frame-pointers", True, when=profiling)
 350
 351
 352 @depends(profiling, target)
 353 def imply_vtune(value, target):
 354     ok_cpu = target.cpu in ["x86", "x86_64"]
 355     ok_kernel = target.kernel == "WINNT" or (
 356         target.kernel == "Linux" and target.os == "GNU"
 357     )
 358
 359     if value and ok_cpu and ok_kernel:
 360         return True
 361
 362
 363 set_config("MOZ_PROFILING", profiling)
 364 set_define("MOZ_PROFILING", profiling)
 365 imply_option("--enable-vtune", imply_vtune, reason="--enable-profiling")
 366
 367
 368 option("--enable-vtune", env="MOZ_VTUNE", help="Enable VTune profiling")
 369
 370
 371 @depends("--enable-vtune")
 372 def vtune(value):
 373     if value:
 374         return True
 375
 376
 377 set_config("MOZ_VTUNE", vtune)
 378 set_define("MOZ_VTUNE", vtune)
 379
 380
 381 option(
 382     "--enable-gc-probes",
 383     env="JS_GC_PROBES",
 384     help="Turn on probes for allocation and finalization",
 385 )
 386
 387
 388 @depends("--enable-gc-probes")
 389 def gc_probes(value):
 390     if value:
 391         return True
 392
 393
 394 set_define("JS_GC_PROBES", gc_probes)
 395
 396
 397 option(
 398     "--enable-gczeal",
 399     default=depends(when=moz_debug)(lambda: True),
 400     help="{Enable|Disable} zealous GCing",
 401 )
 402
 403 set_define("JS_GC_ZEAL", depends_if("--enable-gczeal")(lambda _: True))
 404
 405
 406 # Use a smaller chunk size for GC chunks
 407 # ========================================================
 408 # Use large (1MB) chunks by default.  This option can be used to give
 409 # smaller (currently 256K) chunks.
 410 option(
 411     "--enable-small-chunk-size",
 412     help="Allocate memory for JS GC things in smaller chunks",
 413 )
 414
 415 set_define(
 416     "JS_GC_SMALL_CHUNK_SIZE", depends(when="--enable-small-chunk-size")(lambda: True)
 417 )
 418
 419
 420 # Enable breakpoint for artificial OOMs
 421 # =======================================================
 422 option(
 423     "--enable-oom-breakpoint", help="Enable a breakpoint function for artificial OOMs"
 424 )
 425
 426 set_define("JS_OOM_BREAKPOINT", depends_if("--enable-oom-breakpoint")(lambda _: True))
 427
 428
 429 option("--enable-perf", env="JS_ION_PERF", help="Enable Linux perf integration")
 430
 431
 432 @depends("--enable-perf", target)
 433 def ion_perf(value, target):
 434     is_linux = target.kernel == "Linux"
 435     is_mac = target.kernel == "Darwin" and target.os == "OSX"
 436
 437     if value and (is_linux or is_mac):
 438         return True
 439
 440
 441 set_define("JS_ION_PERF", ion_perf)
 442
 443
 444 option(
 445     "--enable-jitspew",
 446     default=depends(when=moz_debug)(lambda: True),
 447     help="{Enable|Disable} the Jit spew and IONFLAGS environment " "variable",
 448 )
 449
 450 set_define("JS_JITSPEW", depends_if("--enable-jitspew")(lambda _: True))
 451 set_config("JS_JITSPEW", depends_if("--enable-jitspew")(lambda _: True))
 452
 453 # Also enable the structured spewer
 454 set_define("JS_STRUCTURED_SPEW", depends_if("--enable-jitspew")(lambda _: True))
 455 set_config("JS_STRUCTURED_SPEW", depends_if("--enable-jitspew")(lambda _: True))
 456
 457
 458 @depends("--enable-jit", "--enable-jitspew", simulator, target, moz_debug)
 459 def jit_disasm_arm(jit_enabled, spew, simulator, target, debug):
 460     if not jit_enabled:
 461         return
 462
 463     if simulator and (debug or spew):
 464         if getattr(simulator, "arm", None):
 465             return True
 466
 467     if target.cpu == "arm" and (debug or spew):
 468         return True
 469
 470
 471 set_config("JS_DISASM_ARM", jit_disasm_arm)
 472 set_define("JS_DISASM_ARM", jit_disasm_arm)
 473
 474
 475 @depends("--enable-jit", "--enable-jitspew", simulator, target, moz_debug)
 476 def jit_disasm_riscv(jit_enabled, spew, simulator, target, debug):
 477     if not jit_enabled:
 478         return
 479
 480     if simulator and (debug or spew):
 481         if getattr(simulator, "riscv64", None):
 482             return True
 483
 484     if target.cpu == "riscv64" and (debug or spew):
 485         return True
 486
 487
 488 set_config("JS_DISASM_RISCV64", jit_disasm_riscv)
 489 set_define("JS_DISASM_RISCV64", jit_disasm_riscv)
 490
 491
 492 @depends("--enable-jit", "--enable-jitspew", simulator, target, moz_debug)
 493 def jit_disasm_arm64(jit_enabled, spew, simulator, target, debug):
 494     if not jit_enabled:
 495         return
 496
 497     if simulator and (debug or spew):
 498         if getattr(simulator, "arm64", None):
 499             return True
 500
 501     if target.cpu == "aarch64" and (debug or spew):
 502         return True
 503
 504
 505 set_config("JS_DISASM_ARM64", jit_disasm_arm64)
 506 set_define("JS_DISASM_ARM64", jit_disasm_arm64)
 507
 508 # When enabled, masm will generate assumeUnreachable calls that act as
 509 # assertions in the generated code. This option is worth disabling when you
 510 # have to track mutated values through the generated code, to avoid constantly
 511 # dumping registers on and off the stack.
 512 option(
 513     "--enable-masm-verbose",
 514     default=depends(when=moz_debug)(lambda: True),
 515     help="{Enable|Disable} MacroAssembler verbosity of generated code.",
 516 )
 517 set_define("JS_MASM_VERBOSE", depends_if("--enable-masm-verbose")(lambda _: True))
 518 set_config("JS_MASM_VERBOSE", depends_if("--enable-masm-verbose")(lambda _: True))
 519
 520 # Architecture feature flags
 521 # =======================================================
 522
 523 # Apple silicon does not seem to have any way to query the OS for the JSCVT
 524 # flag stored in the ID_AA64ISAR1_EL1 system register. In the mean time, we
 525 # hard code the value of the JSCVT flag which guards the implementation of
 526 # FJCVTZS instruction as part of ARMv8.3-JSConv.
 527 @depends(target)
 528 def is_apple_silicon(target):
 529     return target.os == "OSX" and target.kernel == "Darwin" and target.cpu == "aarch64"
 530
 531
 532 option(
 533     "--enable-arm64-fjcvtzs",
 534     default=is_apple_silicon,
 535     help="{Enable|Disable} static use of FJCVTZS instruction on Aarch64 targets.",
 536 )
 537
 538 # The "ARM Architecture Reference Manual" for ARMv8 defines the JSCVT flag as
 539 # being a 4 bit integer (D12.2.52) and it can be manipulated using >= operator
 540 # (D12.1.4).
 541 #
 542 # The FJCVTZS instruction is implemented if ID_AA64ISAR1_EL1.JSCVT >= 1.
 543 @depends("--enable-arm64-fjcvtzs", target, simulator)
 544 def aarch64_jscvt(fjcvtzs, target, simulator):
 545     if target.cpu == "aarch64" and fjcvtzs:
 546         return 1
 547
 548     if simulator and getattr(simulator, "arm64", False) and fjcvtzs:
 549         return 1
 550
 551     return 0
 552
 553
 554 set_define("MOZ_AARCH64_JSCVT", aarch64_jscvt)
 555
 556
 557 @depends(target)
 558 def has_pthread_jit_write_protect_np(target):
 559     return target.os == "OSX" and target.cpu == "aarch64"
 560
 561
 562 # On Apple Silicon we use MAP_JIT with pthread_jit_write_protect_np to implement
 563 # JIT code write protection.
 564 set_define("JS_USE_APPLE_FAST_WX", True, when=has_pthread_jit_write_protect_np)
 565
 566 # CTypes
 567 # =======================================================
 568 @depends(js_standalone)
 569 def ctypes_default(js_standalone):
 570     return not js_standalone
 571
 572
 573 option("--enable-ctypes", default=ctypes_default, help="{Enable|Disable} js-ctypes")
 574
 575 build_ctypes = depends_if("--enable-ctypes")(lambda _: True)
 576
 577 set_config("BUILD_CTYPES", build_ctypes)
 578 set_define("BUILD_CTYPES", build_ctypes)
 579
 580 set_config("JS_HAS_CTYPES", build_ctypes)
 581 set_define("JS_HAS_CTYPES", build_ctypes)
 582
 583
 584 @depends("--enable-ctypes", "--enable-compile-environment")
 585 def ctypes_and_compile_environment(ctypes, compile_environment):
 586     return ctypes and compile_environment
 587
 588
 589 include("ffi.configure", when=ctypes_and_compile_environment)
 590
 591
 592 # Enable pipeline operator
 593 # ===================================================
 594 option("--enable-pipeline-operator", default=False, help="Enable pipeline operator")
 595
 596
 597 @depends("--enable-pipeline-operator")
 598 def enable_pipeline_operator(value):
 599     if value:
 600         return True
 601
 602
 603 set_config("ENABLE_PIPELINE_OPERATOR", enable_pipeline_operator)
 604 set_define("ENABLE_PIPELINE_OPERATOR", enable_pipeline_operator)
 605
 606
 607 # SIMD acceleration for encoding_rs
 608 # ==============================================================
 609
 610 option(
 611     "--enable-rust-simd", env="MOZ_RUST_SIMD", help="Enable explicit SIMD in Rust code."
 612 )
 613
 614
 615 @depends("--enable-rust-simd", target)
 616 def rust_simd(value, target):
 617     # As of 2019-09-17, the simd-accel feature of encoding_rs has not
 618     # been properly set up outside aarch64, armv7, x86 and x86_64.
 619     if target.cpu in ("aarch64", "arm", "x86", "x86_64") and value:
 620         return True
 621
 622
 623 set_config("MOZ_RUST_SIMD", rust_simd)
 624 set_define("MOZ_RUST_SIMD", rust_simd)
 625
 626 # Telemetry to measure compile time and generated-code runtime
 627 # ============================================================
 628
 629 option(
 630     "--enable-spidermonkey-telemetry",
 631     default=milestone.is_nightly,
 632     help="{Enable|Disable} performance telemetry for SpiderMonkey (e.g. compile and run times)",
 633 )
 634
 635 set_define(
 636     "ENABLE_SPIDERMONKEY_TELEMETRY",
 637     depends_if("--enable-spidermonkey-telemetry")(lambda x: True),
 638 )
 639
 640 # Support for debugging code generated by wasm backends
 641 # =====================================================
 642
 643 option(
 644     "--enable-wasm-codegen-debug",
 645     default=depends(when=moz_debug)(lambda: True),
 646     help="{Enable|Disable} debugging for wasm codegen",
 647 )
 648
 649 set_config(
 650     "WASM_CODEGEN_DEBUG", depends_if("--enable-wasm-codegen-debug")(lambda x: True)
 651 )
 652 set_define(
 653     "WASM_CODEGEN_DEBUG", depends_if("--enable-wasm-codegen-debug")(lambda x: True)
 654 )
 655
 656 # WebAssembly feature flags
 657 # ==================================================
 658
 659 option(
 660     "--wasm-no-experimental",
 661     default=False,
 662     help="Force disable all wasm experimental features for testing.",
 663 )
 664
 665 # Support for WebAssembly function-references.
 666 # ===========================
 667
 668
 669 option(
 670     "--disable-wasm-function-references",
 671     default=True,
 672     help="{Enable|Disable} WebAssembly function-references",
 673 )
 674
 675
 676 @depends("--disable-wasm-function-references", "--wasm-no-experimental")
 677 def wasm_function_references(value, no_experimental):
 678     if no_experimental:
 679         return
 680
 681     if value:
 682         return True
 683
 684
 685 set_config("ENABLE_WASM_FUNCTION_REFERENCES", wasm_function_references)
 686 set_define("ENABLE_WASM_FUNCTION_REFERENCES", wasm_function_references)
 687
 688 # Support for WebAssembly GC.
 689 # ===========================
 690
 691
 692 @depends("--disable-wasm-function-references")
 693 def default_wasm_gc(function_references):
 694     if function_references:
 695         return True
 696
 697
 698 option(
 699     "--disable-wasm-gc", default=default_wasm_gc, help="{Enable|Disable} WebAssembly GC"
 700 )
 701
 702
 703 @depends(
 704     "--disable-wasm-gc", "--disable-wasm-function-references", "--wasm-no-experimental"
 705 )
 706 def wasm_gc(value, function_references, no_experimental):
 707     if no_experimental or not value:
 708         return
 709
 710     if function_references:
 711         return True
 712
 713     die("--disable-wasm-gc only possible with --disable-wasm-function-references")
 714
 715
 716 set_config("ENABLE_WASM_GC", wasm_gc)
 717 set_define("ENABLE_WASM_GC", wasm_gc)
 718
 719
 720 # Support for WebAssembly shared memory and atomics.
 721 #
 722 # This affects the JS shell only.
 723 # =====================================================
 724
 725 option(
 726     "--disable-shared-memory", help="Disable JS/WebAssembly shared memory and atomics"
 727 )
 728
 729
 730 @depends("--disable-shared-memory")
 731 def enable_shared_memory(value):
 732     if value:
 733         return True
 734
 735
 736 set_config("ENABLE_SHARED_MEMORY", enable_shared_memory)
 737 set_define("ENABLE_SHARED_MEMORY", enable_shared_memory)
 738
 739 # Support for WebAssembly extended constant expressions
 740 # =====================================================
 741
 742
 743 option(
 744     "--disable-wasm-extended-const",
 745     help="{Enable|Disable} WebAssembly extended constant expressions",
 746 )
 747
 748
 749 @depends("--disable-wasm-extended-const")
 750 def wasm_extended_const(value):
 751     if value:
 752         return True
 753
 754
 755 set_config("ENABLE_WASM_EXTENDED_CONST", wasm_extended_const)
 756 set_define("ENABLE_WASM_EXTENDED_CONST", wasm_extended_const)
 757
 758 # Support for WebAssembly SIMD
 759 # =====================================================
 760
 761
 762 @depends("--enable-jit", "--enable-simulator", target)
 763 def default_wasm_simd(jit_enabled, simulator, target):
 764     if not jit_enabled:
 765         return
 766
 767     if simulator and (simulator[0] != "arm64"):
 768         return
 769
 770     if target.cpu in ("x86_64", "x86", "aarch64"):
 771         return True
 772
 773
 774 option(
 775     "--enable-wasm-simd",
 776     default=default_wasm_simd,
 777     help="{Enable|Disable} WebAssembly SIMD",
 778 )
 779
 780
 781 @depends(
 782     "--enable-wasm-simd",
 783     "--enable-jit",
 784     "--enable-simulator",
 785     target,
 786     "--wasm-no-experimental",
 787 )
 788 def wasm_simd(value, jit_enabled, simulator, target, no_experimental):
 789     if no_experimental or not value:
 790         return
 791
 792     if not jit_enabled:
 793         die("--enable-wasm-simd requires --enable-jit")
 794
 795     if simulator and (simulator[0] != "arm64"):
 796         die("--enable-wasm-simd is not supported for simulators, except arm64")
 797
 798     if target.cpu in ("x86_64", "x86", "aarch64"):
 799         return True
 800
 801     die("--enable-wasm-simd only possible when targeting the x86_64/x86/arm64 jits")
 802
 803
 804 set_config("ENABLE_WASM_SIMD", wasm_simd)
 805 set_define("ENABLE_WASM_SIMD", wasm_simd)
 806
 807 # Whether to check for field changes in WebAssembly serialization
 808 #
 809 # See the comment for 'WASM_VERIFY_SERIALIZATION_FOR_SIZE' in WasmSerialize.cpp
 810 # for more background.
 811 # =====================================================================
 812
 813
 814 @depends(
 815     target,
 816     c_compiler,
 817     moz_debug,
 818     milestone,
 819     "--wasm-no-experimental",
 820 )
 821 def wasm_verify_serialization_for_size(
 822     target, c_compiler, debug, milestone, no_experimental
 823 ):
 824     if (
 825         debug == True
 826         and target.kernel == "Linux"
 827         and target.cpu == "x86_64"
 828         and c_compiler
 829         and c_compiler.type == "clang"
 830         and milestone.is_nightly
 831         and not no_experimental
 832     ):
 833         return True
 834     return
 835
 836
 837 set_define(
 838     "ENABLE_WASM_VERIFY_SERIALIZATION_FOR_SIZE", wasm_verify_serialization_for_size
 839 )
 840
 841 # Support for Intel AVX instruction.
 842 #
 843 # AVX is exclusively used in WebAssembly SIMD instructions at the moment:
 844 # set direct dependency on "--enable-wasm-simd".
 845 # =====================================================
 846
 847
 848 @depends("--enable-wasm-simd", "--enable-simulator", target)
 849 def default_wasm_avx(wasm_simd_enabled, simulator, target):
 850     if not wasm_simd_enabled:
 851         return
 852
 853     if simulator:
 854         return
 855
 856     if target.cpu in ("x86_64", "x86"):
 857         return True
 858
 859
 860 option(
 861     "--enable-wasm-avx",
 862     default=default_wasm_avx,
 863     help="{Enable|Disable} AVX support for WebAssembly SIMD",
 864 )
 865
 866
 867 @depends(
 868     "--enable-wasm-avx",
 869     "--enable-wasm-simd",
 870     "--enable-simulator",
 871     target,
 872     "--wasm-no-experimental",
 873 )
 874 def wasm_avx(value, wasm_simd_enabled, simulator, target, no_experimental):
 875     if no_experimental or not value:
 876         return
 877
 878     if not wasm_simd_enabled:
 879         die("--enable-wasm-avx requires --enable-wasm-simd")
 880
 881     if simulator:
 882         die("--enable-wasm-avx is not supported for simulators")
 883
 884     if target.cpu in ("x86_64", "x86"):
 885         return True
 886
 887     die("--enable-wasm-avx only possible when targeting the x86_64/x86 jits")
 888
 889
 890 set_config("ENABLE_WASM_AVX", wasm_avx)
 891 set_define("ENABLE_WASM_AVX", wasm_avx)
 892
 893 # Support for WebAssembly relaxed SIMD
 894 # =====================================================
 895
 896
 897 @depends(milestone.is_nightly, "--enable-wasm-simd")
 898 def default_wasm_relaxed_simd(is_nightly, wasm_simd):
 899     if is_nightly and wasm_simd:
 900         return True
 901
 902
 903 option(
 904     "--enable-wasm-relaxed-simd",
 905     default=default_wasm_relaxed_simd,
 906     help="{Enable|Disable} WebAssembly relaxed SIMD",
 907 )
 908
 909
 910 @depends("--enable-wasm-relaxed-simd", "--enable-wasm-simd", "--wasm-no-experimental")
 911 def wasm_relaxed_simd(value, wasm_simd, no_experimental):
 912     if no_experimental or not value:
 913         return
 914
 915     if not wasm_simd:
 916         die("relaxed SIMD requires SIMD")
 917
 918     return True
 919
 920
 921 set_config("ENABLE_WASM_RELAXED_SIMD", wasm_relaxed_simd)
 922 set_define("ENABLE_WASM_RELAXED_SIMD", wasm_relaxed_simd)
 923
 924 # Support for WebAssembly intgemm private intrinsics
 925 # =====================================================
 926
 927
 928 @depends(milestone.is_nightly)
 929 def default_wasm_moz_intgemm(is_nightly):
 930     if is_nightly:
 931         return True
 932
 933
 934 option(
 935     "--enable-wasm-moz-intgemm",
 936     default=default_wasm_moz_intgemm,
 937     help="{Enable|Disable} WebAssembly intgemm private intrinsics",
 938 )
 939
 940
 941 @depends("--enable-wasm-moz-intgemm", target, "--wasm-no-experimental")
 942 def wasm_moz_intgemm(value, target, no_experimental):
 943     if no_experimental:
 944         return
 945
 946     if value and target.cpu in ("x86", "x86_64", "aarch64"):
 947         return True
 948
 949
 950 set_config("ENABLE_WASM_MOZ_INTGEMM", wasm_moz_intgemm)
 951 set_define("ENABLE_WASM_MOZ_INTGEMM", wasm_moz_intgemm)
 952
 953 # Support for WebAssembly Memory64.
 954 # ===========================
 955
 956
 957 @depends(milestone.is_nightly, "--enable-simulator", target)
 958 def default_wasm_memory64(is_nightly, simulator, target):
 959     if target.cpu == "mips32":
 960         return
 961
 962     if simulator and simulator[0] == "mips32":
 963         return
 964
 965     if is_nightly:
 966         return True
 967
 968
 969 option(
 970     "--enable-wasm-memory64",
 971     default=default_wasm_memory64,
 972     help="{Enable|Disable} WebAssembly Memory64",
 973 )
 974
 975
 976 @depends(
 977     "--enable-wasm-memory64", "--enable-simulator", target, "--wasm-no-experimental"
 978 )
 979 def wasm_memory64(value, simulator, target, no_experimental):
 980     if no_experimental or not value:
 981         return
 982
 983     if target.cpu == "mips32":
 984         die("Memory64 is incompatible with MIPS32 target")
 985
 986     if simulator and simulator[0] == "mips32":
 987         die("Memory64 is incompatible with MIPS32 simulator")
 988
 989     return True
 990
 991
 992 set_config("ENABLE_WASM_MEMORY64", wasm_memory64)
 993 set_define("ENABLE_WASM_MEMORY64", wasm_memory64)
 994
 995
 996 # Support for WebAssembly memory control.
 997 # ===========================
 998
 999
1000 @depends(milestone.is_nightly)
1001 def default_wasm_memory_control(is_nightly):
1002     if is_nightly:
1003         return True
1004
1005
1006 option(
1007     "--enable-wasm-memory-control",
1008     default=default_wasm_memory_control,
1009     help="{Enable|Disable} WebAssembly fine-grained memory control instructions",
1010 )
1011
1012
1013 @depends("--enable-wasm-memory-control", "--wasm-no-experimental")
1014 def wasm_memory_control(value, no_experimental):
1015     if no_experimental or not value:
1016         return
1017
1018     return True
1019
1020
1021 set_config("ENABLE_WASM_MEMORY_CONTROL", wasm_memory_control)
1022 set_define("ENABLE_WASM_MEMORY_CONTROL", wasm_memory_control)
1023
1024
1025 # Support for WebAssembly Multi Memory.
1026 # =====================================
1027
1028
1029 @depends(milestone.is_nightly)
1030 def default_wasm_multi_memory(is_nightly):
1031     if is_nightly:
1032         return True
1033
1034
1035 option(
1036     "--enable-wasm-multi-memory",
1037     default=default_wasm_multi_memory,
1038     help="{Enable|Disable} WebAssembly multi-memory",
1039 )
1040
1041
1042 @depends("--enable-wasm-multi-memory", "--wasm-no-experimental")
1043 def wasm_multi_memory(value, no_experimental):
1044     if no_experimental or not value:
1045         return
1046
1047     return True
1048
1049
1050 set_config("ENABLE_WASM_MULTI_MEMORY", wasm_multi_memory)
1051 set_define("ENABLE_WASM_MULTI_MEMORY", wasm_multi_memory)
1052
1053 # Options for generating the shell as a script
1054 # ============================================
1055 option("--with-qemu-exe", nargs=1, help="Use path as an arm emulator on host platforms")
1056 set_config("QEMU_EXE", depends_if("--with-qemu-exe")(lambda x: x))
1057
1058 option(
1059     "--with-cross-lib",
1060     nargs=1,
1061     default=depends(target.alias)(lambda x: "/usr/%s" % x),
1062     help="Use dir as the location for arm libraries",
1063 )
1064 set_config("CROSS_LIB", depends_if("--with-cross-lib")(lambda x: x))
1065
1066 # Enable static checking using sixgill
1067 # ====================================
1068
1069 option("--with-sixgill", nargs=1, help="Enable static checking of code using sixgill")
1070
1071
1072 @depends_if("--with-sixgill")
1073 @imports("os")
1074 def sixgill(value):
1075     for f in ("bin/xdbfind", "gcc/xgill.so", "scripts/wrap_gcc/g++"):
1076         if not os.path.exists(os.path.join(value[0], f)):
1077             die("The sixgill plugin and binaries are not at the specified path")
1078     return value[0]
1079
1080
1081 set_config("SIXGILL_PATH", sixgill)
1082
1083
1084 # Support for readline
1085 # =====================================================
1086
1087
1088 @depends("--enable-js-shell", target_is_windows, compile_environment, target)
1089 def editline(js_shell, is_windows, compile_environment, target):
1090     return js_shell and not is_windows and compile_environment and (target.os != "WASI")
1091
1092
1093 option(
1094     "--enable-readline", help="Link js shell to system readline library", when=editline
1095 )
1096
1097 has_readline = check_symbol(
1098     "readline",
1099     flags=["-lreadline"],
1100     when="--enable-readline",
1101     onerror=lambda: die("No system readline library found"),
1102 )
1103
1104 set_config("EDITLINE_LIBS", ["-lreadline"], when=has_readline)
1105
1106
1107 @depends("--enable-readline", editline, when=editline)
1108 def bundled_editline(readline, editline):
1109     return editline and not readline
1110
1111
1112 set_config("JS_BUNDLED_EDITLINE", bundled_editline)
1113
1114 set_define("EDITLINE", True, when=editline)
1115
1116
1117 # JIT observers
1118 # =============
1119
1120 option(
1121     "--with-jitreport-granularity",
1122     default="3",
1123     choices=("0", "1", "2", "3"),
1124     help="Default granularity at which to report JIT code to external tools "
1125     "(0 - no info, 1 - code ranges for while functions only, "
1126     "2 - per-line information, 3 - per-op information)",
1127 )
1128
1129 set_define(
1130     "JS_DEFAULT_JITREPORT_GRANULARITY",
1131     depends_if("--with-jitreport-granularity")(lambda value: value[0]),
1132 )
1133
1134
1135 # ECMAScript Internationalization API Support (uses ICU)
1136 # ======================================================
1137 system_lib_option("--with-system-icu", help="Use system ICU")
1138
1139 system_icu = pkg_check_modules("MOZ_ICU", "icu-i18n >= 73.1", when="--with-system-icu")
1140
1141
1142 @depends("--with-system-icu")
1143 def in_tree_icu(system_icu):
1144     return not system_icu
1145
1146
1147 # Set MOZ_ICU_CFLAGS to an explicit empty value when --with-system-icu is *not* used,
1148 # for layout/style/extra-bindgen-flags
1149 set_config("MOZ_ICU_CFLAGS", [], when=in_tree_icu)
1150
1151 set_config("MOZ_SYSTEM_ICU", True, when=system_icu)
1152 set_define("MOZ_SYSTEM_ICU", True, when=system_icu)
1153
1154 option("--without-intl-api", help="Disable ECMAScript Internationalization API")
1155
1156
1157 @depends("--with-intl-api", js_standalone)
1158 def check_intl_api(enabled, js_standalone):
1159     if not enabled and not js_standalone:
1160         die("--without-intl-api is not supported")
1161
1162
1163 set_config("JS_HAS_INTL_API", True, when="--with-intl-api")
1164 set_define("JS_HAS_INTL_API", True, when="--with-intl-api")
1165
1166
1167 @depends(build_environment, when="--with-intl-api")
1168 @imports(_from="__builtin__", _import="open")
1169 @imports(_from="__builtin__", _import="ValueError")
1170 def icu_version(build_env):
1171     path = os.path.join(
1172         build_env.topsrcdir, "intl", "icu", "source", "common", "unicode", "uvernum.h"
1173     )
1174     with open(path, encoding="utf-8") as fh:
1175         for line in fh:
1176             if line.startswith("#define"):
1177                 define = line.split(None, 3)
1178                 if len(define) == 3 and define[1] == "U_ICU_VERSION_MAJOR_NUM":
1179                     try:
1180                         return str(int(define[2]))
1181                     except ValueError:
1182                         pass
1183     die("Cannot determine ICU version number from uvernum.h header file")
1184
1185
1186 set_config("MOZ_ICU_VERSION", icu_version)
1187
1188 # Source files that use ICU should have control over which parts of the ICU
1189 # namespace they want to use.
1190 set_define("U_USING_ICU_NAMESPACE", "0", when="--with-intl-api")
1191
1192 # We build ICU as a static library.
1193 set_define("U_STATIC_IMPLEMENTATION", True, when=depends(system_icu)(lambda x: not x))
1194
1195
1196 # ECMAScript Temporal API Support (uses ICU)
1197 # ======================================================
1198
1199 option("--with-temporal-api", default=False, help="Enable ECMAScript Temporal API")
1200
1201 set_config("JS_HAS_TEMPORAL_API", True, when="--with-temporal-api")
1202 set_define("JS_HAS_TEMPORAL_API", True, when="--with-temporal-api")
1203
1204
1205 @depends("--with-temporal-api", "--with-intl-api")
1206 def check_temporal_api(temporal_enabled, intl_enabled):
1207     if temporal_enabled and not intl_enabled:
1208         die("Can't use both --with-temporal-api and --without-intl-api")
1209
1210
1211 # Initial support for WebAssembly JS-API Type Reflections
1212 # =======================================================
1213
1214
1215 @depends(milestone.is_nightly)
1216 def default_wasm_type_reflections(is_nightly):
1217     return is_nightly
1218
1219
1220 option(
1221     "--enable-wasm-type-reflections",
1222     default=default_wasm_type_reflections,
1223     help="{Enable|Disable} type reflection in WASM JS-API",
1224 )
1225
1226 set_config(
1227     "ENABLE_WASM_TYPE_REFLECTIONS",
1228     depends_if("--enable-wasm-type-reflections")(lambda x: True),
1229 )
1230 set_define(
1231     "ENABLE_WASM_TYPE_REFLECTIONS",
1232     depends_if("--enable-wasm-type-reflections")(lambda x: True),
1233 )
1234
1235 # Wasi configuration
1236 # ===================================================
1237
1238
1239 @depends(target.os)
1240 def is_wasi_target(os):
1241     return os == "WASI"
1242
1243
1244 set_define("_WASI_EMULATED_PROCESS_CLOCKS", True, when=is_wasi_target)
1245 set_define("_WASI_EMULATED_GETPID", True, when=is_wasi_target)
1246
1247 # Enable New Set methods
1248 # ===================================================
1249 def use_new_set_methods():
1250     return False
1251
1252
1253 option(
1254     "--enable-new-set-methods",
1255     default=use_new_set_methods(),
1256     help="{Enable|Disable} New Set methods pref/command-line option (disabled by default)",
1257 )
1258
1259
1260 @depends("--enable-new-set-methods")
1261 def enable_new_set_methods(value):
1262     if value:
1263         return True
1264
1265
1266 set_config("ENABLE_NEW_SET_METHODS", enable_new_set_methods)
1267 set_define("ENABLE_NEW_SET_METHODS", enable_new_set_methods)
1268
1269
1270 @depends(milestone.version)
1271 def js_version(version):
1272     return Version(version)
1273
1274
1275 set_config("MOZJS_MAJOR_VERSION", depends(js_version.major)(lambda m: str(m)))
1276 set_define("MOZJS_MAJOR_VERSION", js_version.major)
1277 set_config("MOZJS_MINOR_VERSION", depends(js_version.minor)(lambda m: str(m)))
1278 set_define("MOZJS_MINOR_VERSION", js_version.minor)
1279 set_config("MOZJS_PATCH_VERSION", depends(js_version.patch)(lambda p: str(p)))
1280 set_config(
1281     "MOZJS_ALPHA",
1282     depends(js_version)(
1283         lambda x: x.version[-2] if str(x.version[-2]) in "ab" else None
1284     ),
1285 )
1286
1287
1288 # Some platforms have HeapReg, some don't
1289 # =====================================================
1290
1291 # The ARM simulator runs on x86 and might be excluded by the first test,
1292 # so we special-case it.
1293
1294
1295 @depends("--enable-simulator", target)
1296 def wasm_has_heapreg(simulator, target):
1297     if target.cpu != "x86":
1298         return True
1299
1300     if simulator and simulator[0] == "arm":
1301         return True
1302
1303
1304 set_define("WASM_HAS_HEAPREG", wasm_has_heapreg)
1305
1306 # Check for tm_zone, tm_gmtoff in struct tm
1307 # ===================================================
1308 with only_when(compile_environment):
1309     set_define(
1310         "HAVE_TM_ZONE_TM_GMTOFF",
1311         c_compiler.try_compile(
1312             includes=["time.h"],
1313             body="struct tm tm; tm.tm_zone = 0; tm.tm_gmtoff = 1;",
1314             check_msg="for tm_zone and tm_gmtoff in struct tm",
1315         ),
1316     )
1317
1318 #
1319 # Checks for library functions
1320 # ==============================================================
1321 with only_when(compile_environment & depends(target.os)(lambda os: os != "WINNT")):
1322     set_define("HAVE_GETPAGESIZE", check_symbol("getpagesize"))
1323     set_define("HAVE_GMTIME_R", check_symbol("gmtime_r"))
1324     set_define("HAVE_LOCALTIME_R", check_symbol("localtime_r"))
1325     set_define("HAVE_GETTID", check_symbol("gettid"))
1326     set_define("HAVE_SETPRIORITY", check_symbol("setpriority"))
1327     set_define("HAVE_SYSCALL", check_symbol("syscall"))
1328     set_define("HAVE_GETC_UNLOCKED", check_symbol("getc_unlocked"))
1329     set_define("HAVE_PTHREAD_GETNAME_NP", check_symbol("pthread_getname_np"))
1330     set_define("HAVE_PTHREAD_GET_NAME_NP", check_symbol("pthread_get_name_np"))
1331     set_define("HAVE_STRERROR", check_symbol("strerror"))
1332
1333     @depends(check_symbol("__cxa_demangle", language="C++"), moz_debug, dmd)
1334     def demangle_symbols(cxa_demangle, moz_debug, dmd):
1335         # Demangle only for debug or DMD builds
1336         if cxa_demangle and (moz_debug or dmd):
1337             return True
1338
1339     set_define("MOZ_DEMANGLE_SYMBOLS", demangle_symbols)
1340
1341     set_define(
1342         "HAVE__UNWIND_BACKTRACE",
1343         check_symbol("_Unwind_Backtrace", when=check_header("unwind.h")),
1344     )
1345
1346 with only_when(compile_environment):
1347     set_define("HAVE__GETC_NOLOCK", check_symbol("_getc_nolock"))
1348     set_define("HAVE_LOCALECONV", check_symbol("localeconv"))