GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing github.com — pyodide-build/pyodide_build/pywasmcross.py at main · pyodide/pyodide-build Expand file tree/ Copy pathpywasmcross.pyMore file actions executable file ·705 lines (589 loc) · 21.7 KB / Copy pathpywasmcross.pyFile metadata and controlsexecutable file ·705 lines (589 loc) · 21.7 KB 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 #!/usr/bin/env python3 """Helper for cross-compiling Python binary extensions. Python has never had a proper cross-compilation story. This is a hack, which miraculously works, to get around that. The gist is we compile the package replacing calls to the compiler and linker with wrappers that adjusting include paths and flags as necessary for cross-compiling and then pass the command long to emscripten. """ import json import os import sys from collections.abc import Iterable, Iterator from dataclasses import dataclass from pathlib import Path from typing import Literal, NamedTuple from __main__ import __file__ as INVOKED_PATH_STR INVOKED_PATH = Path(INVOKED_PATH_STR) SYMLINKS = { "cc", "c++", "ld", "lld", "ar", "gcc", "ranlib", "strip", "gfortran", "cargo", "cmake", "meson", "install_name_tool", "otool", } IS_COMPILER_INVOCATION = INVOKED_PATH.name in SYMLINKS if IS_COMPILER_INVOCATION: # If possible load from environment variable, if necessary load from disk. if "PYWASMCROSS_ARGS" in os.environ: PYWASMCROSS_ARGS = json.loads(os.environ["PYWASMCROSS_ARGS"]) else: try: with open(INVOKED_PATH.parent / "pywasmcross_env.json") as f: PYWASMCROSS_ARGS = json.load(f) except FileNotFoundError: raise RuntimeError( "Invalid invocation: can't find PYWASMCROSS_ARGS." f" Invoked from {INVOKED_PATH}." ) from None sys.path = PYWASMCROSS_ARGS.pop("PYTHONPATH") os.environ["PATH"] = ( os.environ["BUILD_ENV_SCRIPTS_DIR"] + ":" + PYWASMCROSS_ARGS.pop("PATH") ) # restore __name__ so that relative imports work as we expect __name__ = PYWASMCROSS_ARGS.pop("orig__name__") class CrossCompileArgs(NamedTuple): """ Arguments for cross-compiling a package. """ cflags: str = "" cxxflags: str = "" ldflags: str = "" # The name of the package being compiled # This is used to apply package-specific fixes, such as scipy pkgname: str = "" target_install_dir: str = "" # The path to the target Python installation pythoninclude: str = "" # path to the cross-compiled Python include directory exports: Literal["whole_archive", "requested", "pyinit"] | list[str] = "pyinit" # Pyodide abi, e.g., 2025_0 # Sometimes we have to inject compile flags only for certain abis. abi: str = "" @dataclass class ExitCodeWithReason: exitcode: int reason: str def is_link_cmd(line: list[str]) -> bool: """ Check if the command is a linker invocation. """ for arg in line: if not arg or arg[0] == "-": continue if arg.endswith(".so"): return True dot_so_pos = arg.find(".so.") if dot_so_pos != -1: version = arg[dot_so_pos + 4 :] # versioned shared libraries start with a digit, and consist of only digits and dots. if version and version[0].isdigit(): if all(c.isdigit() or c == "." for c in version): return True return False def replay_genargs_handle_dashl(arg: str, used_libs: set[str], abi: str) -> str | None: """ Figure out how to replace a `-lsomelib` argument. Parameters ---------- arg The argument we are replacing. Must start with `-l`. used_libs The libraries we've used so far in this command. emcc fails out if `-lsomelib` occurs twice, so we have to track this. Returns ------- The new argument, or None to delete the argument. """ assert arg.startswith("-l") if arg in {"-lffi", "-lgfortran"}: return None # Some Emscripten libraries that use setjmp/longjmp. # The Emscripten linker should automatically know to use these variants so # this shouldn't be necessary. if abi > "2025" and arg in ("-lfreetype", "-lpng"): arg += "-legacysjlj" # WASM link doesn't like libraries being included twice # skip second one if arg in used_libs: return None used_libs.add(arg) return arg def replay_genargs_handle_dashI(arg: str, target_install_dir: str) -> str | None: """ Figure out how to replace a `-Iincludepath` argument. Parameters ---------- arg The argument we are replacing. Must start with `-I`. target_install_dir The target_install_dir argument. Returns ------- The new argument, or None to delete the argument. """ assert arg.startswith("-I") include_path_str = arg[2:] # Don't include any system directories if include_path_str.startswith("/usr"): return None # Replace local Python include paths with the cross compiled ones. # (resolve symlinks, since on macOS/homebrew Python sys.prefix will contain a symlink) include_path = str(Path(include_path_str).resolve()) for prefix in (sys.prefix, sys.base_prefix): prefix = str(Path(prefix).resolve()) if include_path.startswith(prefix + "/include/python"): return "-I" + target_install_dir + include_path.removeprefix(prefix) return arg def replay_genargs_handle_linker_opts(arg: str) -> str | None: """ ignore some link flags it should not check if `arg == "-Wl,-xxx"` and ignore directly here, because arg may be something like "-Wl,-xxx,-yyy" where we only want to ignore "-xxx" but not "-yyy". """ assert arg.startswith("-Wl") excluded_linker_opts = ( "-Bsymbolic-functions", # breaks emscripten see https://github.com/emscripten-core/emscripten/issues/14460 "--strip-all", "-strip-all", # wasm-ld does not recognize some link flags "--sort-common", "--as-needed", # macOS-specific linker flags that wasm-ld doesn't understand "-headerpad_max_install_names", "-dead_strip_dylibs", # Newer clang seems to add this by default, but wasm-ld doesn't support it "--enable-new-dtags", ) excluded_linker_prefixes = ( "--sysroot=", # ignore unsupported --sysroot compile argument used in conda "--version-script=", "-R/", # wasm-ld does not accept -R (runtime libraries) "-R.", # wasm-ld does not accept -R (runtime libraries) "--exclude-libs=", ) link_opts = arg.split(",")[1:] new_link_opts = ["-Wl"] for opt in link_opts: if opt in excluded_linker_opts: continue if opt.startswith(excluded_linker_prefixes): continue new_link_opts.append(opt) if len(new_link_opts) > 1: return ",".join(new_link_opts) else: return None def replay_genargs_handle_argument(arg: str) -> str | ExitCodeWithReason | None: """ Figure out how to replace a general argument. Parameters ---------- arg The argument we are replacing. Must not start with `-I` or `-l`. Returns ------- The new argument, or None to delete the argument. """ assert not arg.startswith("-I") # should be handled by other functions assert not arg.startswith("-l") assert not arg.startswith("-Wl,") # Don't include any system directories if arg.startswith("-L/usr"): return None # fmt: off excluded_arguments = ( # threading is disabled for now "-pthread", # this only applies to compiling fortran code, but we already f2c'd "-ffixed-form", "-fallow-argument-mismatch", # On Mac, we need to omit some darwin-specific arguments "-bundle", "-undefined", "dynamic_lookup", # This flag is needed to build numpy with SIMD optimization which we currently disable "-mpopcnt", # gcc flag that clang does not support "-Bsymbolic-functions", '-fno-second-underscore', '-fstack-protector', # doesn't work? '-fno-strict-overflow', # warning: argument unused during compilation "-mno-sse2", # warning: argument unused during compilation "-mno-avx2", # warning: argument unused during compilation "-std=legacy", # fortran flag that clang does not support ) # fmt: on if arg in excluded_arguments: return None if arg.startswith("-J"): # fortran flag that clang does not support return None # Emscripten 6.0.3 added OpenMP support but Pyodide doesn't support threads. # Exit with nonzero status code so that we treat OpenMP as unavailable. # Leave -fopenmp-simd alone since simd is okay. if arg.startswith("-fopenmp=") or arg == "-fopenmp": return ExitCodeWithReason(1, "openmp requires threads and is not supported") return arg def get_cmake_compiler_flags() -> list[str]: """ Generate cmake compiler flags. emcmake will set these values to emcc, em++, ... but we need to set them to cc, c++, in order to make them pass to pywasmcross. Returns ------- The commandline flags to pass to cmake. """ compiler_flags = { "CMAKE_C_COMPILER": "cc", "CMAKE_CXX_COMPILER": "c++", "CMAKE_AR": "ar", "CMAKE_C_COMPILER_AR": "ar", "CMAKE_CXX_COMPILER_AR": "ar", } flags = [] symlinks_dir = Path(sys.argv[0]).parent for key, value in compiler_flags.items(): assert value in SYMLINKS flags.append(f"-D{key}={symlinks_dir / value}") return flags def _calculate_object_exports_readobj_parse(output: str) -> list[str]: """ >>> _calculate_object_exports_readobj_parse( ... ''' ... Format: WASM \\n Arch: wasm32 \\n AddressSize: 32bit ... Sections [ ... Section { \\n Type: TYPE (0x1) \\n Size: 5 \\n Offset: 8 \\n } ... Section { \\n Type: IMPORT (0x2) \\n Size: 32 \\n Offset: 19 \\n } ... ] ... Symbol { ... Name: g2 \\n Type: FUNCTION (0x0) \\n ... Flags [ (0x0) \\n ] ... ElementIndex: 0x2 ... } ... Symbol { ... Name: f2 \\n Type: FUNCTION (0x0) \\n ... Flags [ (0x4) \\n VISIBILITY_HIDDEN (0x4) \\n ] ... ElementIndex: 0x1 ... } ... Symbol { ... Name: l \\n Type: FUNCTION (0x0) ... Flags [ (0x10)\\n UNDEFINED (0x10) \\n ] ... ImportModule: env ... ElementIndex: 0x0 ... } ... ''' ... ) ['g2'] """ result = [] insymbol = False for line in output.split("\n"): line = line.strip() if line == "Symbol {": insymbol = True export = True name = None symbol_lines = [line] continue if not insymbol: continue symbol_lines.append(line) if line.startswith("Name:"): name = line.removeprefix("Name:").strip() if line.startswith(("BINDING_LOCAL", "UNDEFINED", "VISIBILITY_HIDDEN")): export = False if line == "}": insymbol = False if export: if not name: raise RuntimeError( "Didn't find symbol's name:\n" + "\n".join(symbol_lines) ) result.append(name) return result def calculate_object_exports_readobj(objects: list[str]) -> list[str] | None: from shutil import which from subprocess import run as sp_run # This works for bootstrapped Emscripten via GitHub sources. # llvm-readobj might not be available this way with Homebrew # or conda-forge distributions of Emscripten. which_emcc = which("emcc") assert which_emcc emcc = Path(which_emcc) readobj = (emcc / "../../bin/llvm-readobj").resolve() readobj_path: str | None if readobj.exists(): readobj_path = str(readobj) else: readobj_path = which("llvm-readobj") if not readobj_path: print("Failed to find llvm-readobj, quitting", file=sys.stdout) sys.exit(1) args = [ readobj_path, "--section-details", "-st", ] + objects completedprocess = sp_run( args, encoding="utf8", capture_output=True, env={"PATH": os.environ["PATH"]}, check=False, ) if completedprocess.returncode: print(f"Command '{' '.join(args)}' failed. Output to stderr was:") print(completedprocess.stderr) sys.exit(completedprocess.returncode) if "bitcode files are not supported" in completedprocess.stderr: return None return _calculate_object_exports_readobj_parse(completedprocess.stdout) def calculate_object_exports_nm(objects: list[str]) -> list[str]: from subprocess import run as sp_run args = ["emnm", "-j", "--export-symbols"] + objects result = sp_run( args, encoding="utf8", capture_output=True, env={"PATH": os.environ["PATH"]}, check=False, ) if result.returncode: print(f"Command '{' '.join(args)}' failed. Output to stderr was:") print(result.stderr) sys.exit(result.returncode) return result.stdout.splitlines() def filter_objects(line: list[str]) -> list[str]: """ Collect up all the object files and archive files being linked. """ return [ arg for arg in line if arg.endswith((".a", ".o")) or arg.startswith( "@" ) # response file (https://gcc.gnu.org/wiki/Response_Files) ] def calculate_exports(line: list[str], export_all: bool) -> Iterable[str]: """ List out symbols from object files and archive files that are marked as public. If ``export_all`` is ``True``, then return all public symbols. If not, return only the public symbols that begin with `PyInit`. """ objects = filter_objects(line) exports = None # Using emnm is simpler but it cannot handle bitcode. If we're only # exporting the PyInit symbols, save effort by using nm. if export_all: exports = calculate_object_exports_readobj(objects) if exports is None: # Either export_all is false or we are linking at least one bitcode # object. Fall back to a more conservative estimate of the symbols # exported. This can export things with `__visibility__("hidden")` exports = calculate_object_exports_nm(objects) if export_all: return exports return (x for x in exports if x.startswith("PyInit")) def get_export_flags( line: list[str], exports: Literal["whole_archive", "requested", "pyinit"] | list[str], ) -> Iterator[str]: """ If "whole_archive" was requested, no action is needed. Otherwise, add `-sSIDE_MODULE=2` and the appropriate export list. """ from tempfile import NamedTemporaryFile if exports == "whole_archive": return yield "-sSIDE_MODULE=2" if isinstance(exports, str): export_list = calculate_exports(line, exports == "requested") else: export_list = exports prefixed_exports = ["_" + x for x in export_list] with NamedTemporaryFile(mode="w", delete=False) as f: # Use a response file to avoid command line length limits f.write(json.dumps(prefixed_exports)) yield f"-sEXPORTED_FUNCTIONS=@{f.name}" def handle_command_generate_args( # noqa: C901 line: list[str], build_args: CrossCompileArgs ) -> list[str] | ExitCodeWithReason: """ A helper command for `handle_command` that generates the new arguments for the compilation. Unlike `handle_command` this avoids I/O: it doesn't sys.exit, it doesn't run subprocesses, it doesn't create any files, and it doesn't write to stdout. Parameters ---------- line The original compilation command as a list e.g., ["gcc", "-c", "input.c", "-o", "output.c"] build_args The arguments that pywasmcross was invoked with Returns ------- An updated argument list suitable for use with emscripten. Examples -------- >>> from collections import namedtuple >>> Args = namedtuple('args', ['cflags', 'cxxflags', 'ldflags', 'target_install_dir']) >>> args = Args(cflags='', cxxflags='', ldflags='', target_install_dir='') >>> handle_command_generate_args(['gcc', 'test.c'], args) ['emcc', 'test.c', '-Werror=implicit-function-declaration', '-Werror=mismatched-parameter-types', '-Werror=return-type'] """ if "-print-multiarch" in line: return ["echo", "wasm32-emscripten"] if len(line) == 2 and line[1] == "-v": return ["emcc", "-v"] cmd = line[0] if cmd in {"c++", "g++"}: new_args = ["em++"] elif cmd in {"cc", "gcc", "ld", "lld"}: new_args = ["emcc"] # distutils doesn't use the c++ compiler when compiling c++ <sigh> if any(arg.endswith((".cpp", ".cc")) for arg in line): new_args = ["em++"] elif cmd == "ar": line[0] = "emar" return line elif cmd == "cmake": # If it is a build/install command, or running a script, we don't do anything. if "--build" in line or "--install" in line or "-P" in line or "-E" in line: return line flags = get_cmake_compiler_flags() line[:1] = [ "emcmake", "cmake", *flags, ] return line elif cmd == "meson": if line[:2] != ["meson", "setup"]: return line if "MESON_CROSS_FILE" in os.environ: line[:2] = [ "meson", "setup", "--cross-file", os.environ["MESON_CROSS_FILE"], ] return line elif cmd in {"install_name_tool", "otool"}: # In MacOS, meson tries to run install_name_tool to fix the rpath of the shared library # assuming that it is an ELF file. We need to skip this step. # See: https://github.com/mesonbuild/meson/issues/8027 return ["echo", *line] elif cmd == "ranlib": line[0] = "emranlib" return line elif cmd == "strip": if build_args.abi > "2026": # Emscripten > 5.0.0 strips out the dylink.0 section # so we skip strip to avoid the error # https://github.com/emscripten-core/emscripten/issues/26563 line[0] = "echo" else: line[0] = "emstrip" return line else: return line used_libs: set[str] = set() # Go through and adjust arguments for arg in line[1:]: if new_args[-1].startswith("-B") and "compiler_compat" in arg: # conda uses custom compiler search paths with the compiler_compat folder. # Ignore it. del new_args[-1] continue result: str | ExitCodeWithReason | None if arg.startswith("-l"): result = replay_genargs_handle_dashl(arg, used_libs, build_args.abi) elif arg.startswith("-I"): result = replay_genargs_handle_dashI(arg, build_args.target_install_dir) elif arg.startswith("-Wl"): result = replay_genargs_handle_linker_opts(arg) else: result = replay_genargs_handle_argument(arg) if isinstance(result, ExitCodeWithReason): return result if result: new_args.append(result) new_args.extend( [ "-Werror=implicit-function-declaration", "-Werror=mismatched-parameter-types", "-Werror=return-type", ] ) # set linker and C flags to error on anything to do with function declarations being wrong. # Better to fail at compile or link time. if is_link_cmd(line): new_args.append("-Wl,--fatal-warnings") new_args.extend(build_args.ldflags.split()) new_args.extend(get_export_flags(line, build_args.exports)) if "-c" in line: if new_args[0] == "emcc": new_args.extend(build_args.cflags.split()) elif new_args[0] == "em++": new_args.extend(build_args.cflags.split() + build_args.cxxflags.split()) if build_args.pythoninclude: new_args.extend(["-I", build_args.pythoninclude]) return new_args def handle_command( line: list[str], build_args: CrossCompileArgs, ) -> int | ExitCodeWithReason: """Handle a compilation command. Exit with an appropriate exit code when done. Parameters ---------- line : iterable an iterable with the compilation arguments build_args : BuildArgs a container with additional compilation options """ from subprocess import run as sp_run if line[0] == "gfortran": from _f2c_fixes import replay_f2c tmp = replay_f2c(line) if tmp is None: # No source file, it's a query for information about the compiler. Pretend we're # gfortran by letting gfortran handle it return sp_run(line, check=False).returncode line = tmp new_args = handle_command_generate_args(line, build_args) if isinstance(new_args, ExitCodeWithReason): return new_args if build_args.pkgname == "scipy": from _f2c_fixes import scipy_fixes scipy_fixes(new_args) result = sp_run(new_args, check=False) return result.returncode def compiler_main(): build_args = CrossCompileArgs( pkgname=PYWASMCROSS_ARGS["pkgname"], cflags=PYWASMCROSS_ARGS["cflags"], cxxflags=PYWASMCROSS_ARGS["cxxflags"], ldflags=PYWASMCROSS_ARGS["ldflags"], target_install_dir=PYWASMCROSS_ARGS["target_install_dir"], pythoninclude=PYWASMCROSS_ARGS["pythoninclude"], exports=PYWASMCROSS_ARGS["exports"], abi=PYWASMCROSS_ARGS["abi"], ) basename = Path(sys.argv[0]).name args = list(sys.argv) args[0] = basename result = handle_command(args, build_args) if isinstance(result, ExitCodeWithReason): print(result.reason, file=sys.stderr) exitcode = result.exitcode else: exitcode = result sys.exit(exitcode) if IS_COMPILER_INVOCATION: compiler_main() |
| You are visitor 01402622 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |