1 # Copyright 2012 The Rust Project Developers. See the COPYRIGHT
2 # file at the top-level directory of this distribution and at
3 # http://rust-lang.org/COPYRIGHT.
5 # Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 # http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 # <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 # option. This file may not be copied, modified, or distributed
9 # except according to those terms.
11 # An explanation of how the build is structured:
13 # There are multiple build stages (0-3) needed to verify that the
14 # compiler is properly self-hosting. Each stage is divided between
15 # 'host' artifacts and 'target' artifacts, where the stageN host
16 # compiler builds artifacts for 1 or more stageN target architectures.
17 # Once the stageN target compiler has been built for the host
18 # architecture it is promoted (copied) to a stageN+1 host artifact.
20 # The stage3 host compiler is a compiler that successfully builds
21 # itself and should (in theory) be bitwise identical to the stage2
22 # host compiler. The process is bootstrapped using a stage0 host
23 # compiler downloaded from a previous snapshot.
25 # At no time should stageN artifacts be interacting with artifacts
26 # from other stages. For consistency, we use the 'promotion' logic
27 # for all artifacts, even those that don't make sense on non-host
30 # The directory layout for a stage is intended to match the layout
31 # of the installed compiler, and looks like the following:
33 # stageN - this is the system root, corresponding to, e.g. /usr
34 # bin - binaries compiled for the host
35 # lib - libraries used by the host compiler
36 # rustlib - rustc's own place to organize libraries
37 # $(target) - target-specific artifacts
38 # bin - binaries for target architectures
39 # lib - libraries for target architectures
41 # A note about host libraries:
43 # The only libraries that get promoted to stageN/lib are those needed
44 # by rustc. In general, rust programs, even those compiled for the
45 # host architecture will use libraries from the target
46 # directories. This gives rust some freedom to experiment with how
47 # libraries are managed and versioned without polluting the common
48 # areas of the filesystem.
50 # General rust binaries may stil live in the host bin directory; they
51 # will just link against the libraries in the target lib directory.
53 # Admittedly this is a little convoluted.
57 ######################################################################
58 # Residual auto-configuration
59 ######################################################################
61 # Recursive wildcard function
62 # http://blog.jgc.org/2011/07/gnu-make-recursive-wildcard-function.html
63 rwildcard=$(foreach d,$(wildcard $1*),$(call rwildcard,$d/,$2) \
64 $(filter $(subst *,%,$2),$d))
68 # We track all of the object files we might build so that we can find
69 # and include all of the .d files in one fell swoop.
72 MKFILE_DEPS := config.stamp $(call rwildcard,$(CFG_SRC_DIR)mk/,*)
73 NON_BUILD_HOST = $(filter-out $(CFG_BUILD),$(CFG_HOST))
74 NON_BUILD_TARGET = $(filter-out $(CFG_BUILD),$(CFG_TARGET))
76 ifneq ($(MAKE_RESTARTS),)
77 CFG_INFO := $(info cfg: make restarts: $(MAKE_RESTARTS))
80 CFG_INFO := $(info cfg: build triple $(CFG_BUILD))
81 CFG_INFO := $(info cfg: host triples $(CFG_HOST))
82 CFG_INFO := $(info cfg: target triples $(CFG_TARGET))
84 ifneq ($(wildcard $(NON_BUILD_HOST)),)
85 CFG_INFO := $(info cfg: non-build host triples $(NON_BUILD_HOST))
87 ifneq ($(wildcard $(NON_BUILD_TARGET)),)
88 CFG_INFO := $(info cfg: non-build target triples $(NON_BUILD_TARGET))
91 CFG_RUSTC_FLAGS := $(RUSTFLAGS)
93 CFG_GCCISH_LINK_FLAGS :=
95 ifdef CFG_DISABLE_OPTIMIZE
96 $(info cfg: disabling rustc optimization (CFG_DISABLE_OPTIMIZE))
99 # The rtopt cfg turns off runtime sanity checks
100 CFG_RUSTC_FLAGS += -O --cfg rtopt
103 ifdef CFG_DISABLE_DEBUG
104 CFG_RUSTC_FLAGS += --cfg ndebug
105 CFG_GCCISH_CFLAGS += -DRUST_NDEBUG
107 $(info cfg: enabling more debugging (CFG_ENABLE_DEBUG))
108 CFG_RUSTC_FLAGS += --cfg debug
109 CFG_GCCISH_CFLAGS += -DRUST_DEBUG
113 CFG_RUSTC_FLAGS += --save-temps
116 CFG_RUSTC_FLAGS += -Z asm-comments
119 CFG_RUSTC_FLAGS += -Z time-passes
121 ifdef TIME_LLVM_PASSES
122 CFG_RUSTC_FLAGS += -Z time-llvm-passes
125 CFG_RUSTC_FLAGS += -Z trace
127 ifdef CFG_DISABLE_RPATH
128 # NOTE: make this CFG_RUSTC_FLAGS after stage0 snapshot
129 RUSTFLAGS_STAGE1 += -C no-rpath
130 RUSTFLAGS_STAGE2 += -C no-rpath
131 RUSTFLAGS_STAGE3 += -C no-rpath
134 # The executables crated during this compilation process have no need to include
135 # static copies of libstd and libextra. We also generate dynamic versions of all
136 # libraries, so in the interest of space, prefer dynamic linking throughout the
137 # compilation process.
139 # Note though that these flags are omitted for stage2+. This means that the
140 # snapshot will be generated with a statically linked rustc so we only have to
141 # worry about the distribution of one file (with its native dynamic
144 # NOTE: after a snapshot (stage0), put this on stage0 as well
145 RUSTFLAGS_STAGE1 += -C prefer-dynamic
147 # platform-specific auto-configuration
148 include $(CFG_SRC_DIR)mk/platform.mk
150 # Run the stage1/2 compilers under valgrind
151 ifdef VALGRIND_COMPILE
152 CFG_VALGRIND_COMPILE :=$(CFG_VALGRIND)
154 CFG_VALGRIND_COMPILE :=
157 # version-string calculation
158 CFG_GIT_DIR := $(CFG_SRC_DIR).git
159 CFG_RELEASE = 0.10-pre
160 CFG_VERSION = $(CFG_RELEASE)
161 # windows exe's need numeric versions - don't use anything but
162 # numbers and dots here
163 CFG_VERSION_WIN = 0.10
165 # since $(CFG_GIT) may contain spaces (especially on Windows),
166 # we need to escape them. (" " to r"\ ")
167 # Note that $(subst ...) ignores space after `subst`,
168 # so we use a hack: define $(SPACE) which contains space character.
171 ifneq ($(wildcard $(subst $(SPACE),\$(SPACE),$(CFG_GIT))),)
172 ifneq ($(wildcard $(subst $(SPACE),\$(SPACE),$(CFG_GIT_DIR))),)
173 CFG_VERSION += $(shell git --git-dir='$(CFG_GIT_DIR)' log -1 \
174 --pretty=format:'(%h %ci)')
175 CFG_VER_HASH = $(shell git --git-dir='$(CFG_GIT_DIR)' rev-parse HEAD)
179 ifdef CFG_ENABLE_VALGRIND
180 $(info cfg: enabling valgrind (CFG_ENABLE_VALGRIND))
184 ifdef CFG_BAD_VALGRIND
185 $(info cfg: disabling valgrind due to its unreliability on this platform)
190 ######################################################################
191 # Target-and-rule "utility variables"
192 ######################################################################
205 X_$(1) := $(CFG_EXE_SUFFIX_$(1))
207 $(foreach target,$(CFG_TARGET),\
208 $(eval $(call DEF_X,$(target))))
210 # "Source" files we generate in builddir along the way.
213 # Delete the built-in rules.
222 ######################################################################
223 # Cleaning out old crates
224 ######################################################################
226 # $(1) is the path for directory to match against
227 # $(2) is the glob to use in the match
229 # Note that a common bug is to accidentally construct the glob denoted
230 # by $(2) with a space character prefix, which invalidates the
231 # construction $(1)$(2).
232 define CHECK_FOR_OLD_GLOB_MATCHES
233 $(Q)MATCHES="$(wildcard $(1))"; if [ -n "$$MATCHES" ] ; then echo "warning: there are previous" \'$(notdir $(2))\' "libraries:" $$MATCHES; fi
236 # Same interface as above, but deletes rather than just listing the files.
238 define REMOVE_ALL_OLD_GLOB_MATCHES
239 $(Q)MATCHES="$(wildcard $(1))"; if [ -n "$$MATCHES" ] ; then echo "warning: removing previous" \'$(notdir $(1))\' "libraries:" $$MATCHES; rm $$MATCHES ; fi
242 define REMOVE_ALL_OLD_GLOB_MATCHES
243 $(Q)MATCHES="$(wildcard $(1))"; if [ -n "$$MATCHES" ] ; then rm $$MATCHES ; fi
247 # We use a different strategy for LIST_ALL_OLD_GLOB_MATCHES_EXCEPT
248 # than in the macros above because it needs the result of running the
249 # `ls` command after other rules in the command list have run; the
250 # macro-expander for $(wildcard ...) would deliver its results too
251 # soon. (This is in contrast to the macros above, which are meant to
252 # be run at the outset of a command list in a rule.)
254 define LIST_ALL_OLD_GLOB_MATCHES
255 @echo "info: now are following matches for" '$(notdir $(1))' "libraries:"
256 @( ls $(1) 2>/dev/null || true )
259 define LIST_ALL_OLD_GLOB_MATCHES
263 ######################################################################
265 ######################################################################
268 LLVM_COMPONENTS=x86 arm mips ipo bitreader bitwriter linker asmparser jit mcjit \
269 interpreter instrumentation
271 # Only build these LLVM tools
272 LLVM_TOOLS=bugpoint llc llvm-ar llvm-as llvm-dis llvm-mc opt llvm-extract
275 # The configure script defines these variables with the target triples
276 # separated by Z. This defines new ones with the expected format.
277 CFG_LLVM_BUILD_DIR_$(1):=$$(CFG_LLVM_BUILD_DIR_$(subst -,_,$(1)))
278 CFG_LLVM_INST_DIR_$(1):=$$(CFG_LLVM_INST_DIR_$(subst -,_,$(1)))
280 # Any rules that depend on LLVM should depend on LLVM_CONFIG
281 LLVM_CONFIG_$(1):=$$(CFG_LLVM_INST_DIR_$(1))/bin/llvm-config$$(X_$(1))
282 LLVM_MC_$(1):=$$(CFG_LLVM_INST_DIR_$(1))/bin/llvm-mc$$(X_$(1))
283 LLVM_VERSION_$(1)=$$(shell "$$(LLVM_CONFIG_$(1))" --version)
284 LLVM_BINDIR_$(1)=$$(shell "$$(LLVM_CONFIG_$(1))" --bindir)
285 LLVM_INCDIR_$(1)=$$(shell "$$(LLVM_CONFIG_$(1))" --includedir)
286 LLVM_LIBDIR_$(1)=$$(shell "$$(LLVM_CONFIG_$(1))" --libdir)
287 LLVM_LIBS_$(1)=$$(shell "$$(LLVM_CONFIG_$(1))" --libs $$(LLVM_COMPONENTS))
288 LLVM_LDFLAGS_$(1)=$$(shell "$$(LLVM_CONFIG_$(1))" --ldflags)
289 # On FreeBSD, it may search wrong headers (that are for pre-installed LLVM),
290 # so we replace -I with -iquote to ensure that it searches bundled LLVM first.
291 LLVM_CXXFLAGS_$(1)=$$(subst -I, -iquote , $$(shell "$$(LLVM_CONFIG_$(1))" --cxxflags))
292 LLVM_HOST_TRIPLE_$(1)=$$(shell "$$(LLVM_CONFIG_$(1))" --host-target)
294 LLVM_AS_$(1)=$$(CFG_LLVM_INST_DIR_$(1))/bin/llvm-as$$(X_$(1))
295 LLC_$(1)=$$(CFG_LLVM_INST_DIR_$(1))/bin/llc$$(X_$(1))
299 $(foreach host,$(CFG_HOST), \
300 $(eval $(call DEF_LLVM_VARS,$(host))))
302 ######################################################################
303 # Exports for sub-utilities
304 ######################################################################
306 # Note that any variable that re-configure should pick up needs to be
312 export CFG_VERSION_WIN
316 export CFG_ENABLE_MINGW_CROSS
319 export CFG_RUSTLIBDIR
320 export CFG_LIBDIR_RELATIVE
321 export CFG_DISABLE_INJECT_STD_VERSION
323 ######################################################################
324 # Per-stage targets and runner
325 ######################################################################
327 include $(CFG_SRC_DIR)mk/crates.mk
330 # $(1) is the stage number
331 # $(2) is the target triple
332 # $(3) is the host triple
334 # Destinations of artifacts for the host compiler
335 HROOT$(1)_H_$(3) = $(3)/stage$(1)
336 HBIN$(1)_H_$(3) = $$(HROOT$(1)_H_$(3))/bin
337 HLIB$(1)_H_$(3) = $$(HROOT$(1)_H_$(3))/$$(CFG_LIBDIR_RELATIVE)
339 # Destinations of artifacts for target architectures
340 TROOT$(1)_T_$(2)_H_$(3) = $$(HLIB$(1)_H_$(3))/$$(CFG_RUSTLIBDIR)/$(2)
341 TBIN$(1)_T_$(2)_H_$(3) = $$(TROOT$(1)_T_$(2)_H_$(3))/bin
342 TLIB$(1)_T_$(2)_H_$(3) = $$(TROOT$(1)_T_$(2)_H_$(3))/lib
344 # Preqrequisites for using the stageN compiler
346 HSREQ$(1)_H_$(3) = $$(HBIN$(1)_H_$(3))/rustc$$(X_$(3))
349 $$(HBIN$(1)_H_$(3))/rustc$$(X_$(3)) \
350 $$(HLIB$(1)_H_$(3))/stamp.rustc \
351 $$(foreach dep,$$(RUST_DEPS_rustc),$$(HLIB$(1)_H_$(3))/stamp.$$(dep)) \
355 # Prerequisites for using the stageN compiler to build target artifacts
356 TSREQ$(1)_T_$(2)_H_$(3) = \
357 $$(HSREQ$(1)_H_$(3)) \
358 $$(TLIB$(1)_T_$(2)_H_$(3))/libmorestack.a \
359 $$(TLIB$(1)_T_$(2)_H_$(3))/libcompiler-rt.a
361 # Prerequisites for a working stageN compiler and libraries, for a specific
363 SREQ$(1)_T_$(2)_H_$(3) = \
364 $$(TSREQ$(1)_T_$(2)_H_$(3)) \
365 $$(foreach dep,$$(TARGET_CRATES),\
366 $$(TLIB$(1)_T_$(2)_H_$(3))/stamp.$$(dep))
368 # Prerequisites for a working stageN compiler and complete set of target
370 CSREQ$(1)_T_$(2)_H_$(3) = \
371 $$(TSREQ$(1)_T_$(2)_H_$(3)) \
372 $$(HBIN$(1)_H_$(3))/rustdoc$$(X_$(3)) \
373 $$(foreach dep,$$(CRATES),$$(TLIB$(1)_T_$(2)_H_$(3))/stamp.$$(dep)) \
374 $$(foreach dep,$$(HOST_CRATES),$$(HLIB$(1)_H_$(3))/stamp.$$(dep))
377 # Don't run the the stage0 compiler under valgrind - that ship has sailed
378 CFG_VALGRIND_COMPILE$(1) =
380 CFG_VALGRIND_COMPILE$(1) = $$(CFG_VALGRIND_COMPILE)
383 # Add RUSTFLAGS_STAGEN values to the build command
384 EXTRAFLAGS_STAGE$(1) = $$(RUSTFLAGS_STAGE$(1))
386 CFGFLAG$(1)_T_$(2)_H_$(3) = stage$(1)
388 # Pass --cfg stage0 only for the build->host part of stage0;
389 # if you're building a cross config, the host->* parts are
390 # effectively stage1, since it uses the just-built stage0.
392 ifneq ($(strip $(CFG_BUILD)),$(strip $(3)))
393 CFGFLAG$(1)_T_$(2)_H_$(3) = stage1
397 ifdef CFG_DISABLE_RPATH
398 ifeq ($$(OSTYPE_$(3)),apple-darwin)
399 RPATH_VAR$(1)_T_$(2)_H_$(3) := \
400 DYLD_LIBRARY_PATH="$$$$DYLD_LIBRARY_PATH:$$(HLIB$(1)_H_$(3))"
402 RPATH_VAR$(1)_T_$(2)_H_$(3) := \
403 LD_LIBRARY_PATH="$$$$LD_LIBRARY_PATH:$$(HLIB$(1)_H_$(3))"
406 RPATH_VAR$(1)_T_$(2)_H_$(3) :=
409 STAGE$(1)_T_$(2)_H_$(3) := \
410 $$(Q)$$(RPATH_VAR$(1)_T_$(2)_H_$(3)) \
411 $$(call CFG_RUN_TARG_$(3),$(1), \
412 $$(CFG_VALGRIND_COMPILE$(1)) \
413 $$(HBIN$(1)_H_$(3))/rustc$$(X_$(3)) \
414 --cfg $$(CFGFLAG$(1)_T_$(2)_H_$(3)) \
415 $$(CFG_RUSTC_FLAGS) $$(EXTRAFLAGS_STAGE$(1)) --target=$(2)) \
418 PERF_STAGE$(1)_T_$(2)_H_$(3) := \
419 $$(Q)$$(call CFG_RUN_TARG_$(3),$(1), \
421 $$(HBIN$(1)_H_$(3))/rustc$$(X_$(3)) \
422 --cfg $$(CFGFLAG$(1)_T_$(2)_H_$(3)) \
423 $$(CFG_RUSTC_FLAGS) $$(EXTRAFLAGS_STAGE$(1)) --target=$(2)) \
428 $(foreach build,$(CFG_HOST), \
429 $(eval $(foreach target,$(CFG_TARGET), \
430 $(eval $(foreach stage,$(STAGES), \
431 $(eval $(call SREQ,$(stage),$(target),$(build))))))))
433 ######################################################################
436 # Builds a functional Rustc for the given host.
437 ######################################################################
439 define DEF_RUSTC_STAGE_TARGET
440 # $(1) == architecture
443 rustc-stage$(2)-H-$(1): \
444 $$(foreach target,$$(CFG_TARGET),$$(SREQ$(2)_T_$$(target)_H_$(1)))
448 $(foreach host,$(CFG_HOST), \
449 $(eval $(foreach stage,1 2 3, \
450 $(eval $(call DEF_RUSTC_STAGE_TARGET,$(host),$(stage))))))
452 rustc-stage1: rustc-stage1-H-$(CFG_BUILD)
453 rustc-stage2: rustc-stage2-H-$(CFG_BUILD)
454 rustc-stage3: rustc-stage3-H-$(CFG_BUILD)
456 define DEF_RUSTC_TARGET
457 # $(1) == architecture
459 rustc-H-$(1): rustc-stage2-H-$(1)
462 $(foreach host,$(CFG_TARGET), \
463 $(eval $(call DEF_RUSTC_TARGET,$(host))))
465 rustc-stage1: rustc-stage1-H-$(CFG_BUILD)
466 rustc-stage2: rustc-stage2-H-$(CFG_BUILD)
467 rustc-stage3: rustc-stage3-H-$(CFG_BUILD)
468 rustc: rustc-H-$(CFG_BUILD)
470 rustc-H-all: $(foreach host,$(CFG_HOST),rustc-H-$(host))
472 ######################################################################
474 ######################################################################
478 ifneq ($(CFG_IN_TRANSITION),)
480 CFG_INFO := $(info cfg:)
481 CFG_INFO := $(info cfg: *** compiler is in snapshot transition ***)
482 CFG_INFO := $(info cfg: *** stage2 and later will not be built ***)
483 CFG_INFO := $(info cfg:)
485 #FIXME This is surely busted
486 all: $(SREQ1$(CFG_BUILD)) $(GENERATED) docs
491 ifneq ($$(findstring $(1),$$(CFG_HOST)),)
493 all-target-$(1)-host-$(2): $$(CSREQ2_T_$(1)_H_$(2))
495 # This is a target only
496 all-target-$(1)-host-$(2): $$(SREQ2_T_$(1)_H_$(2))
500 $(foreach target,$(CFG_TARGET), \
501 $(foreach host,$(CFG_HOST), \
502 $(eval $(call ALL_TARGET_N,$(target),$(host)))))
504 ALL_TARGET_RULES = $(foreach target,$(CFG_TARGET), \
505 $(foreach host,$(CFG_HOST), \
506 all-target-$(target)-host-$(host)))
508 all: $(ALL_TARGET_RULES) $(GENERATED) docs
513 ######################################################################
515 ######################################################################
517 ifndef CFG_DISABLE_MANAGE_SUBMODULES
518 # This is a pretty expensive operation but I don't see any way to avoid it
519 NEED_GIT_RECONFIG=$(shell cd "$(CFG_SRC_DIR)" && "$(CFG_GIT)" submodule status | grep -c '^\(+\|-\)')
524 ifeq ($(NEED_GIT_RECONFIG),0)
526 # If the submodules have changed then always execute config.mk
530 Makefile config.mk: config.stamp
532 config.stamp: $(S)configure $(S)Makefile.in $(S)src/snapshots.txt
533 @$(call E, cfg: reconfiguring)
534 $(Q)$(S)configure $(CFG_CONFIGURE_ARGS)
537 ######################################################################
538 # Primary-target makefiles
539 ######################################################################
541 # Issue #9531: If you change the order of any of the following (or add
542 # new definitions), make sure definitions always precede their uses,
543 # especially for the dependency lists of recipes.
545 include $(CFG_SRC_DIR)mk/rt.mk
546 include $(CFG_SRC_DIR)mk/target.mk
547 include $(CFG_SRC_DIR)mk/host.mk
548 include $(CFG_SRC_DIR)mk/stage0.mk
549 include $(CFG_SRC_DIR)mk/rustllvm.mk
550 include $(CFG_SRC_DIR)mk/docs.mk
551 include $(CFG_SRC_DIR)mk/llvm.mk
553 ######################################################################
554 # Secondary makefiles, conditionalized for speed
555 ######################################################################
557 ifneq ($(strip $(findstring dist,$(MAKECMDGOALS)) \
558 $(findstring check,$(MAKECMDGOALS)) \
559 $(findstring test,$(MAKECMDGOALS)) \
560 $(findstring tidy,$(MAKECMDGOALS)) \
561 $(findstring clean,$(MAKECMDGOALS))),)
562 CFG_INFO := $(info cfg: including dist rules)
563 include $(CFG_SRC_DIR)mk/dist.mk
566 ifneq ($(strip $(findstring snap,$(MAKECMDGOALS)) \
567 $(findstring clean,$(MAKECMDGOALS))),)
568 CFG_INFO := $(info cfg: including snap rules)
569 include $(CFG_SRC_DIR)mk/snap.mk
572 ifneq ($(strip $(findstring check,$(MAKECMDGOALS)) \
573 $(findstring test,$(MAKECMDGOALS)) \
574 $(findstring perf,$(MAKECMDGOALS)) \
575 $(findstring tidy,$(MAKECMDGOALS))),)
576 CFG_INFO := $(info cfg: including test rules)
577 include $(CFG_SRC_DIR)mk/tests.mk
580 ifneq ($(findstring perf,$(MAKECMDGOALS)),)
581 CFG_INFO := $(info cfg: including perf rules)
582 include $(CFG_SRC_DIR)mk/perf.mk
585 ifneq ($(findstring clean,$(MAKECMDGOALS)),)
586 CFG_INFO := $(info cfg: including clean rules)
587 include $(CFG_SRC_DIR)mk/clean.mk
590 ifneq ($(findstring install,$(MAKECMDGOALS)),)
591 CFG_INFO := $(info cfg: including install rules)
592 include $(CFG_SRC_DIR)mk/install.mk
595 ifneq ($(strip $(findstring TAGS.emacs,$(MAKECMDGOALS)) \
596 $(findstring TAGS.vi,$(MAKECMDGOALS))),)
597 CFG_INFO := $(info cfg: including ctags rules)
598 include $(CFG_SRC_DIR)mk/ctags.mk
601 # Find all of the .d files and include them to add information about
602 # header file dependencies.
603 ALL_DEP_FILES := $(ALL_OBJ_FILES:%.o=%.d)
604 -include $(ALL_DEP_FILES)