3 # ignore-tidy-linelength
5 from __future__ import absolute_import, division, print_function
8 rust_dir = os.path.dirname(os.path.abspath(__file__))
9 rust_dir = os.path.dirname(rust_dir)
10 rust_dir = os.path.dirname(rust_dir)
11 sys.path.append(os.path.join(rust_dir, "src", "bootstrap"))
16 def __init__(self, name, rustbuild, desc, value):
18 self.rustbuild = rustbuild
27 options.append(Option(*args, value=False))
31 options.append(Option(*args, value=True))
34 o("debug", "rust.debug", "enables debugging environment; does not affect optimization of bootstrapped code")
35 o("docs", "build.docs", "build standard library documentation")
36 o("compiler-docs", "build.compiler-docs", "build compiler documentation")
37 o("optimize-tests", "rust.optimize-tests", "build tests with optimizations")
38 o("verbose-tests", "rust.verbose-tests", "enable verbose output when running tests")
39 o("ccache", "llvm.ccache", "invoke gcc/clang via ccache to reuse object files between builds")
40 o("sccache", None, "invoke gcc/clang via sccache to reuse object files between builds")
41 o("local-rust", None, "use an installed rustc rather than downloading a snapshot")
42 v("local-rust-root", None, "set prefix for local rust binary")
43 o("local-rebuild", "build.local-rebuild", "assume local-rust matches the current version, for rebuilds; implies local-rust, and is implied if local-rust already matches the current version")
44 o("llvm-static-stdcpp", "llvm.static-libstdcpp", "statically link to libstdc++ for LLVM")
45 o("llvm-link-shared", "llvm.link-shared", "prefer shared linking to LLVM (llvm-config --link-shared)")
46 o("rpath", "rust.rpath", "build rpaths into rustc itself")
47 o("llvm-version-check", "llvm.version-check", "check if the LLVM version is supported, build anyway")
48 o("codegen-tests", "rust.codegen-tests", "run the src/test/codegen tests")
49 o("option-checking", None, "complain about unrecognized options in this configure script")
50 o("ninja", "llvm.ninja", "build LLVM using the Ninja generator (for MSVC, requires building in the correct environment)")
51 o("locked-deps", "build.locked-deps", "force Cargo.lock to be up to date")
52 o("vendor", "build.vendor", "enable usage of vendored Rust crates")
53 o("sanitizers", "build.sanitizers", "build the sanitizer runtimes (asan, lsan, msan, tsan, hwasan)")
54 o("dist-src", "rust.dist-src", "when building tarballs enables building a source tarball")
55 o("cargo-native-static", "build.cargo-native-static", "static native libraries in cargo")
56 o("profiler", "build.profiler", "build the profiler runtime")
57 o("full-tools", None, "enable all tools")
58 o("lld", "rust.lld", "build lld")
59 o("clang", "llvm.clang", "build clang")
60 o("missing-tools", "dist.missing-tools", "allow failures when building tools")
61 o("use-libcxx", "llvm.use-libcxx", "build LLVM with libc++")
62 o("control-flow-guard", "rust.control-flow-guard", "Enable Control Flow Guard")
64 v("llvm-cflags", "llvm.cflags", "build LLVM with these extra compiler flags")
65 v("llvm-cxxflags", "llvm.cxxflags", "build LLVM with these extra compiler flags")
66 v("llvm-ldflags", "llvm.ldflags", "build LLVM with these extra linker flags")
68 v("llvm-libunwind", "rust.llvm-libunwind", "use LLVM libunwind")
70 # Optimization and debugging options. These may be overridden by the release
72 o("optimize-llvm", "llvm.optimize", "build optimized LLVM")
73 o("llvm-assertions", "llvm.assertions", "build LLVM with assertions")
74 o("llvm-plugins", "llvm.plugins", "build LLVM with plugin interface")
75 o("debug-assertions", "rust.debug-assertions", "build with debugging assertions")
76 o("debug-assertions-std", "rust.debug-assertions-std", "build the standard library with debugging assertions")
77 o("overflow-checks", "rust.overflow-checks", "build with overflow checks")
78 o("overflow-checks-std", "rust.overflow-checks-std", "build the standard library with overflow checks")
79 o("llvm-release-debuginfo", "llvm.release-debuginfo", "build LLVM with debugger metadata")
80 v("debuginfo-level", "rust.debuginfo-level", "debuginfo level for Rust code")
81 v("debuginfo-level-rustc", "rust.debuginfo-level-rustc", "debuginfo level for the compiler")
82 v("debuginfo-level-std", "rust.debuginfo-level-std", "debuginfo level for the standard library")
83 v("debuginfo-level-tools", "rust.debuginfo-level-tools", "debuginfo level for the tools")
84 v("debuginfo-level-tests", "rust.debuginfo-level-tests", "debuginfo level for the test suites run with compiletest")
85 v("save-toolstates", "rust.save-toolstates", "save build and test status of external tools into this file")
87 v("prefix", "install.prefix", "set installation prefix")
88 v("localstatedir", "install.localstatedir", "local state directory")
89 v("datadir", "install.datadir", "install data")
90 v("sysconfdir", "install.sysconfdir", "install system configuration files")
91 v("infodir", "install.infodir", "install additional info")
92 v("libdir", "install.libdir", "install libraries")
93 v("mandir", "install.mandir", "install man pages in PATH")
94 v("docdir", "install.docdir", "install documentation in PATH")
95 v("bindir", "install.bindir", "install binaries")
97 v("llvm-root", None, "set LLVM root")
98 v("llvm-config", None, "set path to llvm-config")
99 v("llvm-filecheck", None, "set path to LLVM's FileCheck utility")
100 v("python", "build.python", "set path to python")
101 v("android-cross-path", "target.arm-linux-androideabi.android-ndk",
102 "Android NDK standalone path (deprecated)")
103 v("i686-linux-android-ndk", "target.i686-linux-android.android-ndk",
104 "i686-linux-android NDK standalone path")
105 v("arm-linux-androideabi-ndk", "target.arm-linux-androideabi.android-ndk",
106 "arm-linux-androideabi NDK standalone path")
107 v("armv7-linux-androideabi-ndk", "target.armv7-linux-androideabi.android-ndk",
108 "armv7-linux-androideabi NDK standalone path")
109 v("thumbv7neon-linux-androideabi-ndk", "target.thumbv7neon-linux-androideabi.android-ndk",
110 "thumbv7neon-linux-androideabi NDK standalone path")
111 v("aarch64-linux-android-ndk", "target.aarch64-linux-android.android-ndk",
112 "aarch64-linux-android NDK standalone path")
113 v("x86_64-linux-android-ndk", "target.x86_64-linux-android.android-ndk",
114 "x86_64-linux-android NDK standalone path")
115 v("musl-root", "target.x86_64-unknown-linux-musl.musl-root",
116 "MUSL root installation directory (deprecated)")
117 v("musl-root-x86_64", "target.x86_64-unknown-linux-musl.musl-root",
118 "x86_64-unknown-linux-musl install directory")
119 v("musl-root-i586", "target.i586-unknown-linux-musl.musl-root",
120 "i586-unknown-linux-musl install directory")
121 v("musl-root-i686", "target.i686-unknown-linux-musl.musl-root",
122 "i686-unknown-linux-musl install directory")
123 v("musl-root-arm", "target.arm-unknown-linux-musleabi.musl-root",
124 "arm-unknown-linux-musleabi install directory")
125 v("musl-root-armhf", "target.arm-unknown-linux-musleabihf.musl-root",
126 "arm-unknown-linux-musleabihf install directory")
127 v("musl-root-armv5te", "target.armv5te-unknown-linux-musleabi.musl-root",
128 "armv5te-unknown-linux-musleabi install directory")
129 v("musl-root-armv7", "target.armv7-unknown-linux-musleabi.musl-root",
130 "armv7-unknown-linux-musleabi install directory")
131 v("musl-root-armv7hf", "target.armv7-unknown-linux-musleabihf.musl-root",
132 "armv7-unknown-linux-musleabihf install directory")
133 v("musl-root-aarch64", "target.aarch64-unknown-linux-musl.musl-root",
134 "aarch64-unknown-linux-musl install directory")
135 v("musl-root-mips", "target.mips-unknown-linux-musl.musl-root",
136 "mips-unknown-linux-musl install directory")
137 v("musl-root-mipsel", "target.mipsel-unknown-linux-musl.musl-root",
138 "mipsel-unknown-linux-musl install directory")
139 v("musl-root-mips64", "target.mips64-unknown-linux-muslabi64.musl-root",
140 "mips64-unknown-linux-muslabi64 install directory")
141 v("musl-root-mips64el", "target.mips64el-unknown-linux-muslabi64.musl-root",
142 "mips64el-unknown-linux-muslabi64 install directory")
143 v("qemu-armhf-rootfs", "target.arm-unknown-linux-gnueabihf.qemu-rootfs",
144 "rootfs in qemu testing, you probably don't want to use this")
145 v("qemu-aarch64-rootfs", "target.aarch64-unknown-linux-gnu.qemu-rootfs",
146 "rootfs in qemu testing, you probably don't want to use this")
147 v("qemu-riscv64-rootfs", "target.riscv64gc-unknown-linux-gnu.qemu-rootfs",
148 "rootfs in qemu testing, you probably don't want to use this")
149 v("experimental-targets", "llvm.experimental-targets",
150 "experimental LLVM targets to build")
151 v("release-channel", "rust.channel", "the name of the release channel to build")
152 v("release-description", "rust.description", "optional descriptive string for version output")
153 v("dist-compression-formats", None,
154 "comma-separated list of compression formats to use")
156 # Used on systems where "cc" is unavailable
157 v("default-linker", "rust.default-linker", "the default linker")
159 # Many of these are saved below during the "writing configuration" step
160 # (others are conditionally saved).
161 o("manage-submodules", "build.submodules", "let the build manage the git submodules")
162 o("full-bootstrap", "build.full-bootstrap", "build three compilers instead of two (not recommended except for testing reproducible builds)")
163 o("extended", "build.extended", "build an extended rust tool set")
165 v("tools", None, "List of extended tools will be installed")
166 v("codegen-backends", None, "List of codegen backends to build")
167 v("build", "build.build", "GNUs ./configure syntax LLVM build triple")
168 v("host", None, "GNUs ./configure syntax LLVM host triples")
169 v("target", None, "GNUs ./configure syntax LLVM target triples")
171 v("set", None, "set arbitrary key/value pairs in TOML configuration")
175 print("configure: " + msg)
179 print("configure: error: " + msg)
183 if '--help' in sys.argv or '-h' in sys.argv:
184 print('Usage: ./configure [options]')
187 for option in options:
188 if 'android' in option.name:
189 # no one needs to know about these obscure options
192 print('\t{:30} {}'.format('--{}=VAL'.format(option.name), option.desc))
194 print('\t{:30} {}'.format('--enable-{}'.format(option.name), option.desc))
196 print('This configure script is a thin configuration shim over the true')
197 print('configuration system, `config.toml`. You can explore the comments')
198 print('in `config.toml.example` next to this configure script to see')
199 print('more information about what each option is. Additionally you can')
200 print('pass `--set` as an argument to set arbitrary key/value pairs')
201 print('in the TOML configuration if desired')
203 print('Also note that all options which take `--enable` can similarly')
204 print('be passed with `--disable-foo` to forcibly disable the option')
207 # Parse all command line arguments into one of these three lists, handling
208 # boolean and value-based options separately
213 p("processing command line")
215 while i < len(sys.argv):
218 if not arg.startswith('--'):
219 unknown_args.append(arg)
223 for option in options:
226 keyval = arg[2:].split('=', 1)
228 if option.name != key:
233 elif i < len(sys.argv):
237 need_value_args.append(arg)
240 if arg[2:] == 'enable-' + option.name:
242 elif arg[2:] == 'disable-' + option.name:
248 if option.name not in known_args:
249 known_args[option.name] = []
250 known_args[option.name].append((option, value))
254 unknown_args.append(arg)
257 # Note: here and a few other places, we use [-1] to apply the *last* value
258 # passed. But if option-checking is enabled, then the known_args loop will
259 # also assert that options are only passed once.
260 option_checking = ('option-checking' not in known_args
261 or known_args['option-checking'][-1][1])
263 if len(unknown_args) > 0:
264 err("Option '" + unknown_args[0] + "' is not recognized")
265 if len(need_value_args) > 0:
266 err("Option '{0}' needs a value ({0}=val)".format(need_value_args[0]))
268 # Parse all known arguments into a configuration structure that reflects the
269 # TOML we're going to write out
274 if 'build' in known_args:
275 return known_args['build'][-1][1]
276 return bootstrap.default_build_triple(verbose=False)
280 if isinstance(value, list):
281 # Remove empty values, which value.split(',') tends to generate.
282 value = [v for v in value if v]
284 s = "{:20} := {}".format(key, value)
291 parts = key.split('.')
292 for i, part in enumerate(parts):
293 if i == len(parts) - 1:
301 for key in known_args:
302 # The `set` option is special and can be passed a bunch of times
304 for option, value in known_args[key]:
305 keyval = value.split('=', 1)
306 if len(keyval) == 1 or keyval[1] == "true":
308 elif keyval[1] == "false":
312 set(keyval[0], value)
315 # Ensure each option is only passed once
316 arr = known_args[key]
317 if option_checking and len(arr) > 1:
318 err("Option '{}' provided more than once".format(key))
319 option, value = arr[-1]
321 # If we have a clear avenue to set our value in rustbuild, do so
322 if option.rustbuild is not None:
323 set(option.rustbuild, value)
326 # Otherwise we're a "special" option and need some extra handling, so do
328 if option.name == 'sccache':
329 set('llvm.ccache', 'sccache')
330 elif option.name == 'local-rust':
331 for path in os.environ['PATH'].split(os.pathsep):
332 if os.path.exists(path + '/rustc'):
333 set('build.rustc', path + '/rustc')
335 for path in os.environ['PATH'].split(os.pathsep):
336 if os.path.exists(path + '/cargo'):
337 set('build.cargo', path + '/cargo')
339 elif option.name == 'local-rust-root':
340 set('build.rustc', value + '/bin/rustc')
341 set('build.cargo', value + '/bin/cargo')
342 elif option.name == 'llvm-root':
343 set('target.{}.llvm-config'.format(build()), value + '/bin/llvm-config')
344 elif option.name == 'llvm-config':
345 set('target.{}.llvm-config'.format(build()), value)
346 elif option.name == 'llvm-filecheck':
347 set('target.{}.llvm-filecheck'.format(build()), value)
348 elif option.name == 'tools':
349 set('build.tools', value.split(','))
350 elif option.name == 'codegen-backends':
351 set('rust.codegen-backends', value.split(','))
352 elif option.name == 'host':
353 set('build.host', value.split(','))
354 elif option.name == 'target':
355 set('build.target', value.split(','))
356 elif option.name == 'full-tools':
357 set('rust.codegen-backends', ['llvm'])
358 set('rust.lld', True)
359 set('rust.llvm-tools', True)
360 set('build.extended', True)
361 elif option.name == 'option-checking':
362 # this was handled above
364 elif option.name == 'dist-compression-formats':
365 set('dist.compression-formats', value.split(','))
367 raise RuntimeError("unhandled option {}".format(option.name))
369 set('build.configure-args', sys.argv[1:])
371 # "Parse" the `config.toml.example` file into the various sections, and we'll
372 # use this as a template of a `config.toml` to write out which preserves
373 # all the various comments and whatnot.
375 # Note that the `target` section is handled separately as we'll duplicate it
376 # per configured target, so there's a bit of special handling for that here.
380 section_order = [None]
383 for line in open(rust_dir + '/config.toml.example').read().split("\n"):
384 if line.startswith('['):
385 cur_section = line[1:-1]
386 if cur_section.startswith('target'):
387 cur_section = 'target'
388 elif '.' in cur_section:
389 raise RuntimeError("don't know how to deal with section: {}".format(cur_section))
390 sections[cur_section] = [line]
391 section_order.append(cur_section)
393 sections[cur_section].append(line)
395 # Fill out the `targets` array by giving all configured targets a copy of the
396 # `target` section we just loaded from the example config
397 configured_targets = [build()]
398 if 'build' in config:
399 if 'host' in config['build']:
400 configured_targets += config['build']['host']
401 if 'target' in config['build']:
402 configured_targets += config['build']['target']
403 if 'target' in config:
404 for target in config['target']:
405 configured_targets.append(target)
406 for target in configured_targets:
407 targets[target] = sections['target'][:]
408 targets[target][0] = targets[target][0].replace("x86_64-unknown-linux-gnu", "'{}'".format(target))
411 def is_number(value):
419 # Here we walk through the constructed configuration we have from the parsed
420 # command line arguments. We then apply each piece of configuration by
421 # basically just doing a `sed` to change the various configuration line to what
422 # we've got configure.
424 if isinstance(value, bool):
429 elif isinstance(value, list):
430 return '[' + ', '.join(map(to_toml, value)) + ']'
431 elif isinstance(value, str):
432 # Don't put quotes around numeric values
436 return "'" + value + "'"
438 raise RuntimeError('no toml')
441 def configure_section(lines, config):
445 for i, line in enumerate(lines):
446 if not line.startswith('#' + key + ' = '):
449 lines[i] = "{} = {}".format(key, to_toml(value))
452 # These are used by rpm, but aren't accepted by x.py.
453 # Give a warning that they're ignored, but not a hard error.
454 if key in ["infodir", "localstatedir"]:
455 print("warning: {} will be ignored".format(key))
457 raise RuntimeError("failed to find config line for {}".format(key))
460 for section_key in config:
461 section_config = config[section_key]
462 if section_key not in sections:
463 raise RuntimeError("config key {} not in sections".format(section_key))
465 if section_key == 'target':
466 for target in section_config:
467 configure_section(targets[target], section_config[target])
469 configure_section(sections[section_key], section_config)
471 # Now that we've built up our `config.toml`, write it all out in the same
472 # order that we read it in.
474 p("writing `config.toml` in current directory")
475 with bootstrap.output('config.toml') as f:
476 for section in section_order:
477 if section == 'target':
478 for target in targets:
479 for line in targets[target]:
482 for line in sections[section]:
485 with bootstrap.output('Makefile') as f:
486 contents = os.path.join(rust_dir, 'src', 'bootstrap', 'mk', 'Makefile.in')
487 contents = open(contents).read()
488 contents = contents.replace("$(CFG_SRC_DIR)", rust_dir + '/')
489 contents = contents.replace("$(CFG_PYTHON)", sys.executable)
493 p("run `python {}/x.py --help`".format(rust_dir))