1 from __future__ import absolute_import, division, print_function
5 import distutils.version
19 with tempfile.NamedTemporaryFile(delete=False) as temp_file:
20 temp_path = temp_file.name
21 with tarfile.open(temp_path, "w:xz"):
24 except tarfile.CompressionError:
27 def get(url, path, verbose=False, do_verify=True):
29 sha_url = url + suffix
30 with tempfile.NamedTemporaryFile(delete=False) as temp_file:
31 temp_path = temp_file.name
32 with tempfile.NamedTemporaryFile(suffix=suffix, delete=False) as sha_file:
33 sha_path = sha_file.name
37 download(sha_path, sha_url, False, verbose)
38 if os.path.exists(path):
39 if verify(path, sha_path, False):
41 print("using already-download file", path)
45 print("ignoring already-download file",
46 path, "due to failed verification")
48 download(temp_path, url, True, verbose)
49 if do_verify and not verify(temp_path, sha_path, verbose):
50 raise RuntimeError("failed verification")
52 print("moving {} to {}".format(temp_path, path))
53 shutil.move(temp_path, path)
55 delete_if_present(sha_path, verbose)
56 delete_if_present(temp_path, verbose)
59 def delete_if_present(path, verbose):
60 """Remove the given file if present"""
61 if os.path.isfile(path):
63 print("removing", path)
67 def download(path, url, probably_big, verbose):
70 _download(path, url, probably_big, verbose, True)
73 print("\nspurious failure, trying again")
74 _download(path, url, probably_big, verbose, False)
77 def _download(path, url, probably_big, verbose, exception):
78 if probably_big or verbose:
79 print("downloading {}".format(url))
80 # see https://serverfault.com/questions/301128/how-to-download
81 if sys.platform == 'win32':
82 run(["PowerShell.exe", "/nologo", "-Command",
83 "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12;",
84 "(New-Object System.Net.WebClient).DownloadFile('{}', '{}')".format(url, path)],
88 if probably_big or verbose:
92 require(["curl", "--version"])
94 "-y", "30", "-Y", "10", # timeout if speed is < 10 bytes/sec for > 30 seconds
95 "--connect-timeout", "30", # timeout if cannot connect within 30 seconds
96 "--retry", "3", "-Sf", "-o", path, url],
101 def verify(path, sha_path, verbose):
102 """Check if the sha256 sum of the given path is valid"""
104 print("verifying", path)
105 with open(path, "rb") as source:
106 found = hashlib.sha256(source.read()).hexdigest()
107 with open(sha_path, "r") as sha256sum:
108 expected = sha256sum.readline().split()[0]
109 verified = found == expected
111 print("invalid checksum:\n"
113 " expected: {}".format(found, expected))
117 def unpack(tarball, tarball_suffix, dst, verbose=False, match=None):
118 """Unpack the given tarball file"""
119 print("extracting", tarball)
120 fname = os.path.basename(tarball).replace(tarball_suffix, "")
121 with contextlib.closing(tarfile.open(tarball)) as tar:
122 for member in tar.getnames():
123 if "/" not in member:
125 name = member.replace(fname + "/", "", 1)
126 if match is not None and not name.startswith(match):
128 name = name[len(match) + 1:]
130 dst_path = os.path.join(dst, name)
132 print(" extracting", member)
133 tar.extract(member, dst)
134 src_path = os.path.join(dst, member)
135 if os.path.isdir(src_path) and os.path.exists(dst_path):
137 shutil.move(src_path, dst_path)
138 shutil.rmtree(os.path.join(dst, fname))
141 def run(args, verbose=False, exception=False, is_bootstrap=False, **kwargs):
142 """Run a child program in a new process"""
144 print("running: " + ' '.join(args))
146 # Use Popen here instead of call() as it apparently allows powershell on
147 # Windows to not lock up waiting for input presumably.
148 ret = subprocess.Popen(args, **kwargs)
151 err = "failed to run: " + ' '.join(args)
152 if verbose or exception:
153 raise RuntimeError(err)
154 # For most failures, we definitely do want to print this error, or the user will have no
155 # idea what went wrong. But when we've successfully built bootstrap and it failed, it will
156 # have already printed an error above, so there's no need to print the exact command we're
164 def require(cmd, exit=True):
165 '''Run a command, returning its output.
167 If `exit` is `True`, exit the process.
168 Otherwise, return None.'''
170 return subprocess.check_output(cmd).strip()
171 except (subprocess.CalledProcessError, OSError) as exc:
174 print("error: unable to run `{}`: {}".format(' '.join(cmd), exc))
175 print("Please make sure it's installed and in the path.")
179 def stage0_data(rust_root):
180 """Build a dictionary from stage0.txt"""
181 nightlies = os.path.join(rust_root, "src/stage0.txt")
182 with open(nightlies, 'r') as nightlies:
183 lines = [line.rstrip() for line in nightlies
184 if not line.startswith("#")]
185 return dict([line.split(": ", 1) for line in lines if line])
188 def format_build_time(duration):
189 """Return a nicer format for build time
191 >>> format_build_time('300')
194 return str(datetime.timedelta(seconds=int(duration)))
197 def default_build_triple(verbose):
198 """Build triple as in LLVM"""
199 # If the user already has a host build triple with an existing `rustc`
200 # install, use their preference. This fixes most issues with Windows builds
201 # being detected as GNU instead of MSVC.
202 default_encoding = sys.getdefaultencoding()
204 version = subprocess.check_output(["rustc", "--version", "--verbose"],
205 stderr=subprocess.DEVNULL)
206 version = version.decode(default_encoding)
207 host = next(x for x in version.split('\n') if x.startswith("host: "))
208 triple = host.split("host: ")[1]
210 print("detected default triple {}".format(triple))
212 except Exception as e:
214 print("rustup not detected: {}".format(e))
215 print("falling back to auto-detect")
217 required = sys.platform != 'win32'
218 ostype = require(["uname", "-s"], exit=required)
219 cputype = require(['uname', '-m'], exit=required)
221 # If we do not have `uname`, assume Windows.
222 if ostype is None or cputype is None:
223 return 'x86_64-pc-windows-msvc'
225 ostype = ostype.decode(default_encoding)
226 cputype = cputype.decode(default_encoding)
228 # The goal here is to come up with the same triple as LLVM would,
229 # at least for the subset of platforms we're willing to target.
231 'Darwin': 'apple-darwin',
232 'DragonFly': 'unknown-dragonfly',
233 'FreeBSD': 'unknown-freebsd',
234 'Haiku': 'unknown-haiku',
235 'NetBSD': 'unknown-netbsd',
236 'OpenBSD': 'unknown-openbsd'
239 # Consider the direct transformation first and then the special cases
240 if ostype in ostype_mapper:
241 ostype = ostype_mapper[ostype]
242 elif ostype == 'Linux':
243 os_from_sp = subprocess.check_output(
244 ['uname', '-o']).strip().decode(default_encoding)
245 if os_from_sp == 'Android':
246 ostype = 'linux-android'
248 ostype = 'unknown-linux-gnu'
249 elif ostype == 'SunOS':
250 ostype = 'pc-solaris'
251 # On Solaris, uname -m will return a machine classification instead
252 # of a cpu type, so uname -p is recommended instead. However, the
253 # output from that option is too generic for our purposes (it will
254 # always emit 'i386' on x86/amd64 systems). As such, isainfo -k
255 # must be used instead.
256 cputype = require(['isainfo', '-k']).decode(default_encoding)
257 # sparc cpus have sun as a target vendor
258 if 'sparc' in cputype:
259 ostype = 'sun-solaris'
260 elif ostype.startswith('MINGW'):
261 # msys' `uname` does not print gcc configuration, but prints msys
262 # configuration. so we cannot believe `uname -m`:
263 # msys1 is always i686 and msys2 is always x86_64.
264 # instead, msys defines $MSYSTEM which is MINGW32 on i686 and
266 ostype = 'pc-windows-gnu'
268 if os.environ.get('MSYSTEM') == 'MINGW64':
270 elif ostype.startswith('MSYS'):
271 ostype = 'pc-windows-gnu'
272 elif ostype.startswith('CYGWIN_NT'):
274 if ostype.endswith('WOW64'):
276 ostype = 'pc-windows-gnu'
277 elif sys.platform == 'win32':
278 # Some Windows platforms might have a `uname` command that returns a
279 # non-standard string (e.g. gnuwin32 tools returns `windows32`). In
280 # these cases, fall back to using sys.platform.
281 return 'x86_64-pc-windows-msvc'
283 err = "unknown OS type: {}".format(ostype)
286 if cputype == 'powerpc' and ostype == 'unknown-freebsd':
287 cputype = subprocess.check_output(
288 ['uname', '-p']).strip().decode(default_encoding)
291 'aarch64': 'aarch64',
298 'powerpc': 'powerpc',
299 'powerpc64': 'powerpc64',
300 'powerpc64le': 'powerpc64le',
302 'ppc64': 'powerpc64',
303 'ppc64le': 'powerpc64le',
311 # Consider the direct transformation first and then the special cases
312 if cputype in cputype_mapper:
313 cputype = cputype_mapper[cputype]
314 elif cputype in {'xscale', 'arm'}:
316 if ostype == 'linux-android':
317 ostype = 'linux-androideabi'
318 elif ostype == 'unknown-freebsd':
319 cputype = subprocess.check_output(
320 ['uname', '-p']).strip().decode(default_encoding)
321 ostype = 'unknown-freebsd'
322 elif cputype == 'armv6l':
324 if ostype == 'linux-android':
325 ostype = 'linux-androideabi'
328 elif cputype in {'armv7l', 'armv8l'}:
330 if ostype == 'linux-android':
331 ostype = 'linux-androideabi'
334 elif cputype == 'mips':
335 if sys.byteorder == 'big':
337 elif sys.byteorder == 'little':
340 raise ValueError("unknown byteorder: {}".format(sys.byteorder))
341 elif cputype == 'mips64':
342 if sys.byteorder == 'big':
344 elif sys.byteorder == 'little':
347 raise ValueError('unknown byteorder: {}'.format(sys.byteorder))
348 # only the n64 ABI is supported, indicate it
350 elif cputype == 'sparc' or cputype == 'sparcv9' or cputype == 'sparc64':
353 err = "unknown cpu type: {}".format(cputype)
356 return "{}-{}".format(cputype, ostype)
359 @contextlib.contextmanager
360 def output(filepath):
361 tmp = filepath + '.tmp'
362 with open(tmp, 'w') as f:
365 if os.path.exists(filepath):
366 os.remove(filepath) # PermissionError/OSError on Win32 if in use
368 shutil.copy2(tmp, filepath)
371 os.rename(tmp, filepath)
374 class RustBuild(object):
375 """Provide all the methods required to build Rust"""
378 self._download_url = ''
379 self.rustc_channel = ''
380 self.rustfmt_channel = ''
384 self.config_toml = ''
386 self.use_locked_deps = ''
387 self.use_vendored_sources = ''
389 self.git_version = None
390 self.nix_deps_dir = None
391 self.rustc_commit = None
393 def download_toolchain(self, stage0=True, rustc_channel=None):
394 """Fetch the build system for Rust, written in Rust
396 This method will build a cache directory, then it will fetch the
397 tarball which has the stage0 compiler used to then bootstrap the Rust
400 Each downloaded tarball is extracted, after that, the script
401 will move all the content to the right place.
403 if rustc_channel is None:
404 rustc_channel = self.rustc_channel
405 rustfmt_channel = self.rustfmt_channel
406 bin_root = self.bin_root(stage0)
410 key += str(self.rustc_commit)
411 if self.rustc(stage0).startswith(bin_root) and \
412 (not os.path.exists(self.rustc(stage0)) or
413 self.program_out_of_date(self.rustc_stamp(stage0), key)):
414 if os.path.exists(bin_root):
415 shutil.rmtree(bin_root)
416 tarball_suffix = '.tar.xz' if support_xz() else '.tar.gz'
417 filename = "rust-std-{}-{}{}".format(
418 rustc_channel, self.build, tarball_suffix)
419 pattern = "rust-std-{}".format(self.build)
420 self._download_component_helper(filename, pattern, tarball_suffix, stage0)
421 filename = "rustc-{}-{}{}".format(rustc_channel, self.build,
423 self._download_component_helper(filename, "rustc", tarball_suffix, stage0)
424 # download-rustc doesn't need its own cargo, it can just use beta's.
426 filename = "cargo-{}-{}{}".format(rustc_channel, self.build,
428 self._download_component_helper(filename, "cargo", tarball_suffix)
429 self.fix_bin_or_dylib("{}/bin/cargo".format(bin_root))
431 filename = "rustc-dev-{}-{}{}".format(rustc_channel, self.build, tarball_suffix)
432 self._download_component_helper(
433 filename, "rustc-dev", tarball_suffix, stage0
436 self.fix_bin_or_dylib("{}/bin/rustc".format(bin_root))
437 self.fix_bin_or_dylib("{}/bin/rustdoc".format(bin_root))
438 lib_dir = "{}/lib".format(bin_root)
439 for lib in os.listdir(lib_dir):
440 if lib.endswith(".so"):
441 self.fix_bin_or_dylib(os.path.join(lib_dir, lib))
442 with output(self.rustc_stamp(stage0)) as rust_stamp:
443 rust_stamp.write(key)
445 if self.rustfmt() and self.rustfmt().startswith(bin_root) and (
446 not os.path.exists(self.rustfmt())
447 or self.program_out_of_date(self.rustfmt_stamp(), self.rustfmt_channel)
450 tarball_suffix = '.tar.xz' if support_xz() else '.tar.gz'
451 [channel, date] = rustfmt_channel.split('-', 1)
452 filename = "rustfmt-{}-{}{}".format(channel, self.build, tarball_suffix)
453 self._download_component_helper(
454 filename, "rustfmt-preview", tarball_suffix, key=date
456 self.fix_bin_or_dylib("{}/bin/rustfmt".format(bin_root))
457 self.fix_bin_or_dylib("{}/bin/cargo-fmt".format(bin_root))
458 with output(self.rustfmt_stamp()) as rustfmt_stamp:
459 rustfmt_stamp.write(self.rustfmt_channel)
461 # Avoid downloading LLVM twice (once for stage0 and once for the master rustc)
462 if self.downloading_llvm() and stage0:
463 # We want the most recent LLVM submodule update to avoid downloading
464 # LLVM more often than necessary.
466 # This git command finds that commit SHA, looking for bors-authored
467 # merges that modified src/llvm-project.
469 # This works even in a repository that has not yet initialized
471 top_level = subprocess.check_output([
472 "git", "rev-parse", "--show-toplevel",
473 ]).decode(sys.getdefaultencoding()).strip()
474 llvm_sha = subprocess.check_output([
475 "git", "log", "--author=bors", "--format=%H", "-n1",
476 "-m", "--first-parent",
478 "{}/src/llvm-project".format(top_level),
479 "{}/src/bootstrap/download-ci-llvm-stamp".format(top_level),
480 # the LLVM shared object file is named `LLVM-12-rust-{version}-nightly`
481 "{}/src/version".format(top_level)
482 ]).decode(sys.getdefaultencoding()).strip()
483 llvm_assertions = self.get_toml('assertions', 'llvm') == 'true'
484 llvm_root = self.llvm_root()
485 llvm_lib = os.path.join(llvm_root, "lib")
486 if self.program_out_of_date(self.llvm_stamp(), llvm_sha + str(llvm_assertions)):
487 self._download_ci_llvm(llvm_sha, llvm_assertions)
488 for binary in ["llvm-config", "FileCheck"]:
489 self.fix_bin_or_dylib(os.path.join(llvm_root, "bin", binary))
490 for lib in os.listdir(llvm_lib):
491 if lib.endswith(".so"):
492 self.fix_bin_or_dylib(os.path.join(llvm_lib, lib))
493 with output(self.llvm_stamp()) as llvm_stamp:
494 llvm_stamp.write(llvm_sha + str(llvm_assertions))
496 def downloading_llvm(self):
497 opt = self.get_toml('download-ci-llvm', 'llvm')
498 # This is currently all tier 1 targets (since others may not have CI
500 # https://doc.rust-lang.org/rustc/platform-support.html#tier-1
501 supported_platforms = [
502 "aarch64-unknown-linux-gnu",
503 "i686-pc-windows-gnu",
504 "i686-pc-windows-msvc",
505 "i686-unknown-linux-gnu",
506 "x86_64-unknown-linux-gnu",
507 "x86_64-apple-darwin",
508 "x86_64-pc-windows-gnu",
509 "x86_64-pc-windows-msvc",
511 return opt == "true" \
512 or (opt == "if-available" and self.build in supported_platforms)
514 def _download_component_helper(
515 self, filename, pattern, tarball_suffix, stage0=True, key=None
521 key = self.rustc_commit
522 cache_dst = os.path.join(self.build_dir, "cache")
523 rustc_cache = os.path.join(cache_dst, key)
524 if not os.path.exists(rustc_cache):
525 os.makedirs(rustc_cache)
528 url = "{}/dist/{}".format(self._download_url, key)
530 url = "https://ci-artifacts.rust-lang.org/rustc-builds/{}".format(self.rustc_commit)
531 tarball = os.path.join(rustc_cache, filename)
532 if not os.path.exists(tarball):
533 get("{}/{}".format(url, filename), tarball, verbose=self.verbose, do_verify=stage0)
534 unpack(tarball, tarball_suffix, self.bin_root(stage0), match=pattern, verbose=self.verbose)
536 def _download_ci_llvm(self, llvm_sha, llvm_assertions):
537 cache_prefix = "llvm-{}-{}".format(llvm_sha, llvm_assertions)
538 cache_dst = os.path.join(self.build_dir, "cache")
539 rustc_cache = os.path.join(cache_dst, cache_prefix)
540 if not os.path.exists(rustc_cache):
541 os.makedirs(rustc_cache)
543 url = "https://ci-artifacts.rust-lang.org/rustc-builds/{}".format(llvm_sha)
545 url = url.replace('rustc-builds', 'rustc-builds-alt')
546 # ci-artifacts are only stored as .xz, not .gz
548 print("error: XZ support is required to download LLVM")
549 print("help: consider disabling `download-ci-llvm` or using python3")
551 tarball_suffix = '.tar.xz'
552 filename = "rust-dev-nightly-" + self.build + tarball_suffix
553 tarball = os.path.join(rustc_cache, filename)
554 if not os.path.exists(tarball):
555 get("{}/{}".format(url, filename), tarball, verbose=self.verbose, do_verify=False)
556 unpack(tarball, tarball_suffix, self.llvm_root(),
558 verbose=self.verbose)
560 def fix_bin_or_dylib(self, fname):
561 """Modifies the interpreter section of 'fname' to fix the dynamic linker,
562 or the RPATH section, to fix the dynamic library search path
564 This method is only required on NixOS and uses the PatchELF utility to
565 change the interpreter/RPATH of ELF executables.
567 Please see https://nixos.org/patchelf.html for more information
569 default_encoding = sys.getdefaultencoding()
571 ostype = subprocess.check_output(
572 ['uname', '-s']).strip().decode(default_encoding)
573 except subprocess.CalledProcessError:
575 except OSError as reason:
576 if getattr(reason, 'winerror', None) is not None:
580 if ostype != "Linux":
583 # Use `/etc/os-release` instead of `/etc/NIXOS`.
584 # The latter one does not exist on NixOS when using tmpfs as root.
586 with open("/etc/os-release", "r") as f:
587 if not any(line.strip() == "ID=nixos" for line in f):
589 except FileNotFoundError:
591 if os.path.exists("/lib"):
594 # At this point we're pretty sure the user is running NixOS
595 nix_os_msg = "info: you seem to be running NixOS. Attempting to patch"
596 print(nix_os_msg, fname)
598 # Only build `.nix-deps` once.
599 nix_deps_dir = self.nix_deps_dir
601 # Run `nix-build` to "build" each dependency (which will likely reuse
602 # the existing `/nix/store` copy, or at most download a pre-built copy).
604 # Importantly, we create a gc-root called `.nix-deps` in the `build/`
605 # directory, but still reference the actual `/nix/store` path in the rpath
606 # as it makes it significantly more robust against changes to the location of
607 # the `.nix-deps` location.
609 # bintools: Needed for the path of `ld-linux.so` (via `nix-support/dynamic-linker`).
610 # zlib: Needed as a system dependency of `libLLVM-*.so`.
611 # patchelf: Needed for patching ELF binaries (see doc comment above).
612 nix_deps_dir = "{}/{}".format(self.build_dir, ".nix-deps")
614 with (import <nixpkgs> {});
616 name = "rust-stage0-dependencies";
625 subprocess.check_output([
626 "nix-build", "-E", nix_expr, "-o", nix_deps_dir,
628 except subprocess.CalledProcessError as reason:
629 print("warning: failed to call nix-build:", reason)
631 self.nix_deps_dir = nix_deps_dir
633 patchelf = "{}/bin/patchelf".format(nix_deps_dir)
635 # Relative default, all binary and dynamic libraries we ship
636 # appear to have this (even when `../lib` is redundant).
638 os.path.join(os.path.realpath(nix_deps_dir), "lib")
640 patchelf_args = ["--set-rpath", ":".join(rpath_entries)]
641 if not fname.endswith(".so"):
642 # Finally, set the corret .interp for binaries
643 with open("{}/nix-support/dynamic-linker".format(nix_deps_dir)) as dynamic_linker:
644 patchelf_args += ["--set-interpreter", dynamic_linker.read().rstrip()]
647 subprocess.check_output([patchelf] + patchelf_args + [fname])
648 except subprocess.CalledProcessError as reason:
649 print("warning: failed to call patchelf:", reason)
652 # If `download-rustc` is set, download the most recent commit with CI artifacts
653 def maybe_download_ci_toolchain(self):
654 # If `download-rustc` is not set, default to rebuilding.
655 download_rustc = self.get_toml("download-rustc", section="rust")
656 if download_rustc is None or download_rustc == "false":
658 assert download_rustc == "true" or download_rustc == "if-unchanged", download_rustc
660 # Handle running from a directory other than the top level
661 rev_parse = ["git", "rev-parse", "--show-toplevel"]
662 top_level = subprocess.check_output(rev_parse, universal_newlines=True).strip()
663 compiler = "{}/compiler/".format(top_level)
664 library = "{}/library/".format(top_level)
666 # Look for a version to compare to based on the current commit.
667 # Only commits merged by bors will have CI artifacts.
668 merge_base = ["git", "log", "--author=bors", "--pretty=%H", "-n1"]
669 commit = subprocess.check_output(merge_base, universal_newlines=True).strip()
671 # Warn if there were changes to the compiler or standard library since the ancestor commit.
672 status = subprocess.call(["git", "diff-index", "--quiet", commit, "--", compiler, library])
674 if download_rustc == "if-unchanged":
676 print("warning: `download-rustc` is enabled, but there are changes to \
677 compiler/ or library/")
680 print("using downloaded stage1 artifacts from CI (commit {})".format(commit))
681 self.rustc_commit = commit
682 # FIXME: support downloading artifacts from the beta channel
683 self.download_toolchain(False, "nightly")
685 def rustc_stamp(self, stage0):
686 """Return the path for .rustc-stamp at the given stage
689 >>> rb.build_dir = "build"
690 >>> rb.rustc_stamp(True) == os.path.join("build", "stage0", ".rustc-stamp")
692 >>> rb.rustc_stamp(False) == os.path.join("build", "ci-rustc", ".rustc-stamp")
695 return os.path.join(self.bin_root(stage0), '.rustc-stamp')
697 def rustfmt_stamp(self):
698 """Return the path for .rustfmt-stamp
701 >>> rb.build_dir = "build"
702 >>> rb.rustfmt_stamp() == os.path.join("build", "stage0", ".rustfmt-stamp")
705 return os.path.join(self.bin_root(True), '.rustfmt-stamp')
707 def llvm_stamp(self):
708 """Return the path for .rustfmt-stamp
711 >>> rb.build_dir = "build"
712 >>> rb.llvm_stamp() == os.path.join("build", "ci-llvm", ".llvm-stamp")
715 return os.path.join(self.llvm_root(), '.llvm-stamp')
718 def program_out_of_date(self, stamp_path, key):
719 """Check if the given program stamp is out of date"""
720 if not os.path.exists(stamp_path) or self.clean:
722 with open(stamp_path, 'r') as stamp:
723 return key != stamp.read()
725 def bin_root(self, stage0):
726 """Return the binary root directory for the given stage
729 >>> rb.build_dir = "build"
730 >>> rb.bin_root(True) == os.path.join("build", "stage0")
732 >>> rb.bin_root(False) == os.path.join("build", "ci-rustc")
735 When the 'build' property is given should be a nested directory:
737 >>> rb.build = "devel"
738 >>> rb.bin_root(True) == os.path.join("build", "devel", "stage0")
745 return os.path.join(self.build_dir, self.build, subdir)
748 """Return the CI LLVM root directory
751 >>> rb.build_dir = "build"
752 >>> rb.llvm_root() == os.path.join("build", "ci-llvm")
755 When the 'build' property is given should be a nested directory:
757 >>> rb.build = "devel"
758 >>> rb.llvm_root() == os.path.join("build", "devel", "ci-llvm")
761 return os.path.join(self.build_dir, self.build, "ci-llvm")
763 def get_toml(self, key, section=None):
764 """Returns the value of the given key in config.toml, otherwise returns None
767 >>> rb.config_toml = 'key1 = "value1"\\nkey2 = "value2"'
768 >>> rb.get_toml("key2")
771 If the key does not exists, the result is None:
773 >>> rb.get_toml("key3") is None
776 Optionally also matches the section the key appears in
778 >>> rb.config_toml = '[a]\\nkey = "value1"\\n[b]\\nkey = "value2"'
779 >>> rb.get_toml('key', 'a')
781 >>> rb.get_toml('key', 'b')
783 >>> rb.get_toml('key', 'c') is None
786 >>> rb.config_toml = 'key1 = true'
787 >>> rb.get_toml("key1")
792 for line in self.config_toml.splitlines():
793 section_match = re.match(r'^\s*\[(.*)\]\s*$', line)
794 if section_match is not None:
795 cur_section = section_match.group(1)
797 match = re.match(r'^{}\s*=(.*)$'.format(key), line)
798 if match is not None:
799 value = match.group(1)
800 if section is None or section == cur_section:
801 return self.get_string(value) or value.strip()
805 """Return config path for cargo"""
806 return self.program_config('cargo')
808 def rustc(self, stage0):
809 """Return config path for rustc"""
810 return self.program_config('rustc', stage0)
813 """Return config path for rustfmt"""
814 if not self.rustfmt_channel:
816 return self.program_config('rustfmt')
818 def program_config(self, program, stage0=True):
819 """Return config path for the given program at the given stage
822 >>> rb.config_toml = 'rustc = "rustc"\\n'
823 >>> rb.program_config('rustc')
825 >>> rb.config_toml = ''
826 >>> cargo_path = rb.program_config('cargo', True)
827 >>> cargo_path.rstrip(".exe") == os.path.join(rb.bin_root(True),
830 >>> cargo_path = rb.program_config('cargo', False)
831 >>> cargo_path.rstrip(".exe") == os.path.join(rb.bin_root(False),
835 config = self.get_toml(program)
837 return os.path.expanduser(config)
838 return os.path.join(self.bin_root(stage0), "bin", "{}{}".format(
839 program, self.exe_suffix()))
842 def get_string(line):
843 """Return the value between double quotes
845 >>> RustBuild.get_string(' "devel" ')
847 >>> RustBuild.get_string(" 'devel' ")
849 >>> RustBuild.get_string('devel') is None
851 >>> RustBuild.get_string(' "devel ')
854 start = line.find('"')
856 end = start + 1 + line[start + 1:].find('"')
857 return line[start + 1:end]
858 start = line.find('\'')
860 end = start + 1 + line[start + 1:].find('\'')
861 return line[start + 1:end]
866 """Return a suffix for executables"""
867 if sys.platform == 'win32':
871 def bootstrap_binary(self):
872 """Return the path of the bootstrap binary
875 >>> rb.build_dir = "build"
876 >>> rb.bootstrap_binary() == os.path.join("build", "bootstrap",
877 ... "debug", "bootstrap")
880 return os.path.join(self.build_dir, "bootstrap", "debug", "bootstrap")
882 def build_bootstrap(self):
883 """Build bootstrap"""
884 build_dir = os.path.join(self.build_dir, "bootstrap")
885 if self.clean and os.path.exists(build_dir):
886 shutil.rmtree(build_dir)
887 env = os.environ.copy()
888 # `CARGO_BUILD_TARGET` breaks bootstrap build.
889 # See also: <https://github.com/rust-lang/rust/issues/70208>.
890 if "CARGO_BUILD_TARGET" in env:
891 del env["CARGO_BUILD_TARGET"]
892 env["CARGO_TARGET_DIR"] = build_dir
893 env["RUSTC"] = self.rustc(True)
894 env["LD_LIBRARY_PATH"] = os.path.join(self.bin_root(True), "lib") + \
895 (os.pathsep + env["LD_LIBRARY_PATH"]) \
896 if "LD_LIBRARY_PATH" in env else ""
897 env["DYLD_LIBRARY_PATH"] = os.path.join(self.bin_root(True), "lib") + \
898 (os.pathsep + env["DYLD_LIBRARY_PATH"]) \
899 if "DYLD_LIBRARY_PATH" in env else ""
900 env["LIBRARY_PATH"] = os.path.join(self.bin_root(True), "lib") + \
901 (os.pathsep + env["LIBRARY_PATH"]) \
902 if "LIBRARY_PATH" in env else ""
903 # preserve existing RUSTFLAGS
904 env.setdefault("RUSTFLAGS", "")
905 env["RUSTFLAGS"] += " -Cdebuginfo=2"
907 build_section = "target.{}".format(self.build)
909 if self.get_toml("crt-static", build_section) == "true":
910 target_features += ["+crt-static"]
911 elif self.get_toml("crt-static", build_section) == "false":
912 target_features += ["-crt-static"]
914 env["RUSTFLAGS"] += " -C target-feature=" + (",".join(target_features))
915 target_linker = self.get_toml("linker", build_section)
916 if target_linker is not None:
917 env["RUSTFLAGS"] += " -C linker=" + target_linker
918 env["RUSTFLAGS"] += " -Wrust_2018_idioms -Wunused_lifetimes"
919 env["RUSTFLAGS"] += " -Wsemicolon_in_expressions_from_macros"
920 if self.get_toml("deny-warnings", "rust") != "false":
921 env["RUSTFLAGS"] += " -Dwarnings"
923 env["PATH"] = os.path.join(self.bin_root(True), "bin") + \
924 os.pathsep + env["PATH"]
925 if not os.path.isfile(self.cargo()):
926 raise Exception("no cargo executable found at `{}`".format(
928 args = [self.cargo(), "build", "--manifest-path",
929 os.path.join(self.rust_root, "src/bootstrap/Cargo.toml")]
930 for _ in range(1, self.verbose):
931 args.append("--verbose")
932 if self.use_locked_deps:
933 args.append("--locked")
934 if self.use_vendored_sources:
935 args.append("--frozen")
936 run(args, env=env, verbose=self.verbose)
938 def build_triple(self):
939 """Build triple as in LLVM
941 Note that `default_build_triple` is moderately expensive,
942 so use `self.build` where possible.
944 config = self.get_toml('build')
947 return default_build_triple(self.verbose)
949 def check_submodule(self, module, slow_submodules):
950 if not slow_submodules:
951 checked_out = subprocess.Popen(["git", "rev-parse", "HEAD"],
952 cwd=os.path.join(self.rust_root, module),
953 stdout=subprocess.PIPE)
958 def update_submodule(self, module, checked_out, recorded_submodules):
959 module_path = os.path.join(self.rust_root, module)
961 if checked_out is not None:
962 default_encoding = sys.getdefaultencoding()
963 checked_out = checked_out.communicate()[0].decode(default_encoding).strip()
964 if recorded_submodules[module] == checked_out:
967 print("Updating submodule", module)
969 run(["git", "submodule", "-q", "sync", module],
970 cwd=self.rust_root, verbose=self.verbose)
972 update_args = ["git", "submodule", "update", "--init", "--recursive"]
973 if self.git_version >= distutils.version.LooseVersion("2.11.0"):
974 update_args.append("--progress")
975 update_args.append(module)
976 run(update_args, cwd=self.rust_root, verbose=self.verbose, exception=True)
978 run(["git", "reset", "-q", "--hard"],
979 cwd=module_path, verbose=self.verbose)
980 run(["git", "clean", "-qdfx"],
981 cwd=module_path, verbose=self.verbose)
983 def update_submodules(self):
984 """Update submodules"""
985 if (not os.path.exists(os.path.join(self.rust_root, ".git"))) or \
986 self.get_toml('submodules') == "false":
989 default_encoding = sys.getdefaultencoding()
991 # check the existence and version of 'git' command
992 git_version_str = require(['git', '--version']).split()[2].decode(default_encoding)
993 self.git_version = distutils.version.LooseVersion(git_version_str)
995 slow_submodules = self.get_toml('fast-submodules') == "false"
998 print('Unconditionally updating submodules')
1000 print('Updating only changed submodules')
1001 default_encoding = sys.getdefaultencoding()
1002 # Only update submodules that are needed to build bootstrap. These are needed because Cargo
1003 # currently requires everything in a workspace to be "locally present" when starting a
1004 # build, and will give a hard error if any Cargo.toml files are missing.
1005 # FIXME: Is there a way to avoid cloning these eagerly? Bootstrap itself doesn't need to
1006 # share a workspace with any tools - maybe it could be excluded from the workspace?
1007 # That will still require cloning the submodules the second you check the standard
1008 # library, though...
1009 # FIXME: Is there a way to avoid hard-coding the submodules required?
1010 # WARNING: keep this in sync with the submodules hard-coded in bootstrap/lib.rs
1012 "src/tools/rust-installer",
1016 "library/backtrace",
1019 filtered_submodules = []
1020 submodules_names = []
1021 for module in submodules:
1022 check = self.check_submodule(module, slow_submodules)
1023 filtered_submodules.append((module, check))
1024 submodules_names.append(module)
1025 recorded = subprocess.Popen(["git", "ls-tree", "HEAD"] + submodules_names,
1026 cwd=self.rust_root, stdout=subprocess.PIPE)
1027 recorded = recorded.communicate()[0].decode(default_encoding).strip().splitlines()
1028 # { filename: hash }
1029 recorded_submodules = {}
1030 for data in recorded:
1031 # [mode, kind, hash, filename]
1033 recorded_submodules[data[3]] = data[2]
1034 for module in filtered_submodules:
1035 self.update_submodule(module[0], module[1], recorded_submodules)
1036 print("Submodules updated in %.2f seconds" % (time() - start_time))
1038 def set_normal_environment(self):
1039 """Set download URL for normal environment"""
1040 if 'RUSTUP_DIST_SERVER' in os.environ:
1041 self._download_url = os.environ['RUSTUP_DIST_SERVER']
1043 self._download_url = 'https://static.rust-lang.org'
1045 def set_dev_environment(self):
1046 """Set download URL for development environment"""
1047 if 'RUSTUP_DEV_DIST_SERVER' in os.environ:
1048 self._download_url = os.environ['RUSTUP_DEV_DIST_SERVER']
1050 self._download_url = 'https://dev-static.rust-lang.org'
1052 def check_vendored_status(self):
1053 """Check that vendoring is configured properly"""
1054 vendor_dir = os.path.join(self.rust_root, 'vendor')
1055 if 'SUDO_USER' in os.environ and not self.use_vendored_sources:
1056 if os.environ.get('USER') != os.environ['SUDO_USER']:
1057 self.use_vendored_sources = True
1058 print('info: looks like you are running this command under `sudo`')
1059 print(' and so in order to preserve your $HOME this will now')
1060 print(' use vendored sources by default.')
1061 if not os.path.exists(vendor_dir):
1062 print('error: vendoring required, but vendor directory does not exist.')
1063 print(' Run `cargo vendor` without sudo to initialize the '
1064 'vendor directory.')
1065 raise Exception("{} not found".format(vendor_dir))
1067 if self.use_vendored_sources:
1068 if not os.path.exists('.cargo'):
1069 os.makedirs('.cargo')
1070 with output('.cargo/config') as cargo_config:
1072 "[source.crates-io]\n"
1073 "replace-with = 'vendored-sources'\n"
1074 "registry = 'https://example.com'\n"
1076 "[source.vendored-sources]\n"
1077 "directory = '{}/vendor'\n"
1078 .format(self.rust_root))
1080 if os.path.exists('.cargo'):
1081 shutil.rmtree('.cargo')
1083 def ensure_vendored(self):
1084 """Ensure that the vendored sources are available if needed"""
1085 vendor_dir = os.path.join(self.rust_root, 'vendor')
1086 # Note that this does not handle updating the vendored dependencies if
1087 # the rust git repository is updated. Normal development usually does
1088 # not use vendoring, so hopefully this isn't too much of a problem.
1089 if self.use_vendored_sources and not os.path.exists(vendor_dir):
1093 "--sync=./src/tools/rust-analyzer/Cargo.toml",
1094 "--sync=./compiler/rustc_codegen_cranelift/Cargo.toml",
1095 ], verbose=self.verbose, cwd=self.rust_root)
1098 def bootstrap(help_triggered):
1099 """Configure, fetch, build and run the initial bootstrap"""
1101 # If the user is asking for help, let them know that the whole download-and-build
1102 # process has to happen before anything is printed out.
1104 print("info: Downloading and building bootstrap before processing --help")
1105 print(" command. See src/bootstrap/README.md for help with common")
1108 parser = argparse.ArgumentParser(description='Build rust')
1109 parser.add_argument('--config')
1110 parser.add_argument('--build')
1111 parser.add_argument('--clean', action='store_true')
1112 parser.add_argument('-v', '--verbose', action='count', default=0)
1114 args = [a for a in sys.argv if a != '-h' and a != '--help']
1115 args, _ = parser.parse_known_args(args)
1117 # Configure initial bootstrap
1119 build.rust_root = os.path.abspath(os.path.join(__file__, '../../..'))
1120 build.verbose = args.verbose
1121 build.clean = args.clean
1123 # Read from `RUST_BOOTSTRAP_CONFIG`, then `--config`, then fallback to `config.toml` (if it
1125 toml_path = os.getenv('RUST_BOOTSTRAP_CONFIG') or args.config
1126 if not toml_path and os.path.exists('config.toml'):
1127 toml_path = 'config.toml'
1130 if not os.path.exists(toml_path):
1131 toml_path = os.path.join(build.rust_root, toml_path)
1133 with open(toml_path) as config:
1134 build.config_toml = config.read()
1136 profile = build.get_toml('profile')
1137 if profile is not None:
1138 include_file = 'config.{}.toml'.format(profile)
1139 include_dir = os.path.join(build.rust_root, 'src', 'bootstrap', 'defaults')
1140 include_path = os.path.join(include_dir, include_file)
1141 # HACK: This works because `build.get_toml()` returns the first match it finds for a
1142 # specific key, so appending our defaults at the end allows the user to override them
1143 with open(include_path) as included_toml:
1144 build.config_toml += os.linesep + included_toml.read()
1146 config_verbose = build.get_toml('verbose', 'build')
1147 if config_verbose is not None:
1148 build.verbose = max(build.verbose, int(config_verbose))
1150 build.use_vendored_sources = build.get_toml('vendor', 'build') == 'true'
1152 build.use_locked_deps = build.get_toml('locked-deps', 'build') == 'true'
1154 build.check_vendored_status()
1156 build_dir = build.get_toml('build-dir', 'build') or 'build'
1157 build.build_dir = os.path.abspath(build_dir.replace("$ROOT", build.rust_root))
1159 data = stage0_data(build.rust_root)
1160 build.date = data['date']
1161 build.rustc_channel = data['rustc']
1163 if "rustfmt" in data:
1164 build.rustfmt_channel = data['rustfmt']
1167 build.set_dev_environment()
1169 build.set_normal_environment()
1171 build.build = args.build or build.build_triple()
1172 build.update_submodules()
1174 # Fetch/build the bootstrap
1175 build.download_toolchain()
1176 # Download the master compiler if `download-rustc` is set
1177 build.maybe_download_ci_toolchain()
1179 build.ensure_vendored()
1180 build.build_bootstrap()
1184 args = [build.bootstrap_binary()]
1185 args.extend(sys.argv[1:])
1186 env = os.environ.copy()
1187 env["BOOTSTRAP_PARENT_ID"] = str(os.getpid())
1188 env["BOOTSTRAP_PYTHON"] = sys.executable
1189 env["BUILD_DIR"] = build.build_dir
1190 env["RUSTC_BOOTSTRAP"] = '1'
1192 env["BOOTSTRAP_CONFIG"] = toml_path
1193 if build.rustc_commit is not None:
1194 env["BOOTSTRAP_DOWNLOAD_RUSTC"] = '1'
1195 run(args, env=env, verbose=build.verbose, is_bootstrap=True)
1199 """Entry point for the bootstrap process"""
1202 # x.py help <cmd> ...
1203 if len(sys.argv) > 1 and sys.argv[1] == 'help':
1204 sys.argv = [sys.argv[0], '-h'] + sys.argv[2:]
1207 '-h' in sys.argv) or ('--help' in sys.argv) or (len(sys.argv) == 1)
1209 bootstrap(help_triggered)
1210 if not help_triggered:
1211 print("Build completed successfully in {}".format(
1212 format_build_time(time() - start_time)))
1213 except (SystemExit, KeyboardInterrupt) as error:
1214 if hasattr(error, 'code') and isinstance(error.code, int):
1215 exit_code = error.code
1219 if not help_triggered:
1220 print("Build completed unsuccessfully in {}".format(
1221 format_build_time(time() - start_time)))
1225 if __name__ == '__main__':