mk/rt.mk

   1 # Copyright 2014 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.
   4 #
   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.
  10
  11 ################################################################################
  12 # Native libraries built as part of the rust build process
  13 #
  14 # This portion of the rust build system is meant to keep track of native
  15 # dependencies and how to build them. It is currently required that all native
  16 # dependencies are built as static libraries, as slinging around dynamic
  17 # libraries isn't exactly the most fun thing to do.
  18 #
  19 # This section should need minimal modification to add new libraries. The
  20 # relevant variables are:
  21 #
  22 #   NATIVE_LIBS
  23 #       This is a list of all native libraries which are built as part of the
  24 #       build process. It will build all libraries into RT_OUTPUT_DIR with the
  25 #       appropriate name of static library as dictated by the target platform
  26 #
  27 #   NATIVE_DEPS_<lib>
  28 #       This is a list of files relative to the src/rt directory which are
  29 #       needed to build the native library. Each file will be compiled to an
  30 #       object file, and then all the object files will be assembled into an
  31 #       archive (static library). The list contains files of any extension
  32 #
  33 # If adding a new library, you should update the NATIVE_LIBS list, and then list
  34 # the required files below it. The list of required files is a list of files
  35 # that's per-target so you're allowed to conditionally add files based on the
  36 # target.
  37 ################################################################################
  38 NATIVE_LIBS := rust_builtin hoedown miniz rust_test_helpers
  39
  40 # $(1) is the target triple
  41 define NATIVE_LIBRARIES
  42
  43 NATIVE_DEPS_hoedown_$(1) := hoedown/src/autolink.c \
  44                         hoedown/src/buffer.c \
  45                         hoedown/src/document.c \
  46                         hoedown/src/escape.c \
  47                         hoedown/src/html.c \
  48                         hoedown/src/html_blocks.c \
  49                         hoedown/src/html_smartypants.c \
  50                         hoedown/src/stack.c \
  51                         hoedown/src/version.c
  52 NATIVE_DEPS_miniz_$(1) = miniz.c
  53 NATIVE_DEPS_rust_builtin_$(1) := rust_builtin.c \
  54                         rust_android_dummy.c
  55 NATIVE_DEPS_rust_test_helpers_$(1) := rust_test_helpers.c
  56
  57 ################################################################################
  58 # You shouldn't find it that necessary to edit anything below this line.
  59 ################################################################################
  60
  61 # While we're defining the native libraries for each target, we define some
  62 # common rules used to build files for various targets.
  63
  64 RT_OUTPUT_DIR_$(1) := $(1)/rt
  65
  66 $$(RT_OUTPUT_DIR_$(1))/%.o: $(S)src/rt/%.c $$(MKFILE_DEPS)
  67         @mkdir -p $$(@D)
  68         @$$(call E, compile: $$@)
  69         $$(Q)$$(call CFG_COMPILE_C_$(1), $$@, \
  70                 $$(call CFG_CC_INCLUDE_$(1),$$(S)src/rt/hoedown/src) \
  71                 $$(call CFG_CC_INCLUDE_$(1),$$(S)src/rt) \
  72                  $$(RUNTIME_CFLAGS_$(1))) $$<
  73
  74 $$(RT_OUTPUT_DIR_$(1))/%.o: $(S)src/rt/%.S $$(MKFILE_DEPS) \
  75             $$(LLVM_CONFIG_$$(CFG_BUILD))
  76         @mkdir -p $$(@D)
  77         @$$(call E, compile: $$@)
  78         $$(Q)$$(call CFG_ASSEMBLE_$(1),$$@,$$<)
  79
  80 # On MSVC targets the compiler's default include path (e.g. where to find system
  81 # headers) is specified by the INCLUDE environment variable. This may not be set
  82 # so the ./configure script scraped the relevant values and this is the location
  83 # that we put them into cl.exe's environment.
  84 ifeq ($$(findstring msvc,$(1)),msvc)
  85 $$(RT_OUTPUT_DIR_$(1))/%.o: \
  86         export INCLUDE := $$(CFG_MSVC_INCLUDE_PATH_$$(HOST_$(1)))
  87 $(1)/rustllvm/%.o: \
  88         export INCLUDE := $$(CFG_MSVC_INCLUDE_PATH_$$(HOST_$(1)))
  89 endif
  90 endef
  91
  92 $(foreach target,$(CFG_TARGET),$(eval $(call NATIVE_LIBRARIES,$(target))))
  93
  94 # A macro for devining how to build third party libraries listed above (based
  95 # on their dependencies).
  96 #
  97 # $(1) is the target
  98 # $(2) is the lib name
  99 define THIRD_PARTY_LIB
 100
 101 OBJS_$(2)_$(1) := $$(NATIVE_DEPS_$(2)_$(1):%=$$(RT_OUTPUT_DIR_$(1))/%)
 102 OBJS_$(2)_$(1) := $$(OBJS_$(2)_$(1):.c=.o)
 103 OBJS_$(2)_$(1) := $$(OBJS_$(2)_$(1):.cpp=.o)
 104 OBJS_$(2)_$(1) := $$(OBJS_$(2)_$(1):.S=.o)
 105 NATIVE_$(2)_$(1) := $$(call CFG_STATIC_LIB_NAME_$(1),$(2))
 106 $$(RT_OUTPUT_DIR_$(1))/$$(NATIVE_$(2)_$(1)): $$(OBJS_$(2)_$(1))
 107         @$$(call E, link: $$@)
 108         $$(Q)$$(call CFG_CREATE_ARCHIVE_$(1),$$@) $$^
 109
 110 endef
 111
 112 $(foreach target,$(CFG_TARGET), \
 113  $(eval $(call RUNTIME_RULES,$(target))))
 114 $(foreach lib,$(NATIVE_LIBS), \
 115  $(foreach target,$(CFG_TARGET), \
 116   $(eval $(call THIRD_PARTY_LIB,$(target),$(lib)))))
 117
 118
 119 ################################################################################
 120 # Building third-party targets with external build systems
 121 #
 122 # This location is meant for dependencies which have external build systems. It
 123 # is still assumed that the output of each of these steps is a static library
 124 # in the correct location.
 125 ################################################################################
 126
 127 define DEF_THIRD_PARTY_TARGETS
 128
 129 # $(1) is the target triple
 130
 131 ifeq ($$(CFG_WINDOWSY_$(1)),1)
 132   # A bit of history here, this used to be --enable-lazy-lock added in #14006
 133   # which was filed with jemalloc in jemalloc/jemalloc#83 which was also
 134   # reported to MinGW: http://sourceforge.net/p/mingw-w64/bugs/395/
 135   #
 136   # When updating jemalloc to 4.0, however, it was found that binaries would
 137   # exit with the status code STATUS_RESOURCE_NOT_OWNED indicating that a thread
 138   # was unlocking a mutex it never locked. Disabling this "lazy lock" option
 139   # seems to fix the issue, but it was enabled by default for MinGW targets in
 140   # 13473c7 for jemalloc.
 141   #
 142   # As a result of all that, force disabling lazy lock on Windows, and after
 143   # reading some code it at least *appears* that the initialization of mutexes
 144   # is otherwise ok in jemalloc, so shouldn't cause problems hopefully...
 145   #
 146   # tl;dr: make windows behave like other platforms by disabling lazy locking,
 147   #        but requires passing an option due to a historical default with
 148   #        jemalloc.
 149   JEMALLOC_ARGS_$(1) := --disable-lazy-lock
 150 else ifeq ($(OSTYPE_$(1)), apple-ios)
 151   JEMALLOC_ARGS_$(1) := --disable-tls
 152 else ifeq ($(findstring android, $(OSTYPE_$(1))), android)
 153   JEMALLOC_ARGS_$(1) := --disable-tls
 154 endif
 155
 156 ifdef CFG_ENABLE_DEBUG_JEMALLOC
 157   JEMALLOC_ARGS_$(1) += --enable-debug --enable-fill
 158 endif
 159
 160 ################################################################################
 161 # jemalloc
 162 ################################################################################
 163
 164 ifdef CFG_ENABLE_FAST_MAKE
 165 JEMALLOC_DEPS := $(S)/.gitmodules
 166 else
 167 JEMALLOC_DEPS := $(wildcard \
 168                    $(S)src/jemalloc/* \
 169                    $(S)src/jemalloc/*/* \
 170                    $(S)src/jemalloc/*/*/* \
 171                    $(S)src/jemalloc/*/*/*/*)
 172 endif
 173
 174 # See #17183 for details, this file is touched during the build process so we
 175 # don't want to consider it as a dependency.
 176 JEMALLOC_DEPS := $(filter-out $(S)src/jemalloc/VERSION,$(JEMALLOC_DEPS))
 177
 178 JEMALLOC_NAME_$(1) := $$(call CFG_STATIC_LIB_NAME_$(1),jemalloc)
 179 ifeq ($$(CFG_WINDOWSY_$(1)),1)
 180   JEMALLOC_REAL_NAME_$(1) := $$(call CFG_STATIC_LIB_NAME_$(1),jemalloc_s)
 181 else
 182   JEMALLOC_REAL_NAME_$(1) := $$(call CFG_STATIC_LIB_NAME_$(1),jemalloc_pic)
 183 endif
 184 JEMALLOC_LIB_$(1) := $$(RT_OUTPUT_DIR_$(1))/$$(JEMALLOC_NAME_$(1))
 185 JEMALLOC_BUILD_DIR_$(1) := $$(RT_OUTPUT_DIR_$(1))/jemalloc
 186 JEMALLOC_LOCAL_$(1) := $$(JEMALLOC_BUILD_DIR_$(1))/lib/$$(JEMALLOC_REAL_NAME_$(1))
 187
 188 $$(JEMALLOC_LOCAL_$(1)): $$(JEMALLOC_DEPS) $$(MKFILE_DEPS)
 189         @$$(call E, make: jemalloc)
 190         cd "$$(JEMALLOC_BUILD_DIR_$(1))"; "$(S)src/jemalloc/configure" \
 191                 $$(JEMALLOC_ARGS_$(1)) --with-jemalloc-prefix=je_ $(CFG_JEMALLOC_FLAGS) \
 192                 --build=$$(CFG_GNU_TRIPLE_$(CFG_BUILD)) --host=$$(CFG_GNU_TRIPLE_$(1)) \
 193                 CC="$$(CC_$(1)) $$(CFG_JEMALLOC_CFLAGS_$(1))" \
 194                 AR="$$(AR_$(1))" \
 195                 RANLIB="$$(AR_$(1)) s" \
 196                 CPPFLAGS="-I $(S)src/rt/" \
 197                 EXTRA_CFLAGS="-g1 -ffunction-sections -fdata-sections"
 198         $$(Q)$$(MAKE) -C "$$(JEMALLOC_BUILD_DIR_$(1))" build_lib_static
 199
 200 ifeq ($(1),$$(CFG_BUILD))
 201 ifneq ($$(CFG_JEMALLOC_ROOT),)
 202 $$(JEMALLOC_LIB_$(1)): $$(CFG_JEMALLOC_ROOT)/libjemalloc_pic.a
 203         @$$(call E, copy: jemalloc)
 204         $$(Q)cp $$< $$@
 205 else
 206 $$(JEMALLOC_LIB_$(1)): $$(JEMALLOC_LOCAL_$(1))
 207         $$(Q)cp $$< $$@
 208 endif
 209 else
 210 $$(JEMALLOC_LIB_$(1)): $$(JEMALLOC_LOCAL_$(1))
 211         $$(Q)cp $$< $$@
 212 endif
 213
 214 ################################################################################
 215 # compiler-rt
 216 ################################################################################
 217
 218 ifdef CFG_ENABLE_FAST_MAKE
 219 COMPRT_DEPS := $(S)/.gitmodules
 220 else
 221 COMPRT_DEPS := $(wildcard \
 222               $(S)src/compiler-rt/* \
 223               $(S)src/compiler-rt/*/* \
 224               $(S)src/compiler-rt/*/*/* \
 225               $(S)src/compiler-rt/*/*/*/*)
 226 endif
 227
 228 COMPRT_NAME_$(1) := $$(call CFG_STATIC_LIB_NAME_$(1),compiler-rt)
 229 COMPRT_LIB_$(1) := $$(RT_OUTPUT_DIR_$(1))/$$(COMPRT_NAME_$(1))
 230 COMPRT_BUILD_DIR_$(1) := $$(RT_OUTPUT_DIR_$(1))/compiler-rt
 231
 232 ifeq ($$(findstring msvc,$(1)),msvc)
 233 $$(COMPRT_LIB_$(1)): $$(COMPRT_DEPS) $$(MKFILE_DEPS) $$(LLVM_CONFIG_$(1))
 234         @$$(call E, cmake: compiler-rt)
 235         $$(Q)cd "$$(COMPRT_BUILD_DIR_$(1))"; $$(CFG_CMAKE) "$(S)src/compiler-rt" \
 236                 -DCMAKE_BUILD_TYPE=$$(LLVM_BUILD_CONFIG_MODE) \
 237                 -DLLVM_CONFIG_PATH=$$(LLVM_CONFIG_$(1)) \
 238                 -G"$$(CFG_CMAKE_GENERATOR)"
 239         $$(Q)$$(CFG_CMAKE) --build "$$(COMPRT_BUILD_DIR_$(1))" \
 240                 --target lib/builtins/builtins \
 241                 --config $$(LLVM_BUILD_CONFIG_MODE) \
 242                 -- //v:m //nologo
 243         $$(Q)cp $$(COMPRT_BUILD_DIR_$(1))/lib/windows/$$(LLVM_BUILD_CONFIG_MODE)/clang_rt.builtins-$$(HOST_$(1)).lib $$@
 244 else
 245 COMPRT_CC_$(1) := $$(CC_$(1))
 246 COMPRT_AR_$(1) := $$(AR_$(1))
 247 # We chomp -Werror here because GCC warns about the type signature of
 248 # builtins not matching its own and the build fails. It's a bit hacky,
 249 # but what can we do, we're building libclang-rt using GCC ......
 250 COMPRT_CFLAGS_$(1) := $$(subst -Werror,,$$(CFG_GCCISH_CFLAGS_$(1))) -std=c99
 251
 252 # FreeBSD Clang's packaging is problematic; it doesn't copy unwind.h to
 253 # the standard include directory. This should really be in our changes to
 254 # compiler-rt, but we override the CFLAGS here so there isn't much choice
 255 ifeq ($$(findstring freebsd,$(1)),freebsd)
 256         COMPRT_CFLAGS_$(1) += -I/usr/include/c++/v1
 257 endif
 258
 259 $$(COMPRT_LIB_$(1)): $$(COMPRT_DEPS) $$(MKFILE_DEPS)
 260         @$$(call E, make: compiler-rt)
 261         $$(Q)$$(MAKE) -C "$(S)src/compiler-rt" \
 262                 ProjSrcRoot="$(S)src/compiler-rt" \
 263                 ProjObjRoot="$$(abspath $$(COMPRT_BUILD_DIR_$(1)))" \
 264                 CC='$$(COMPRT_CC_$(1))' \
 265                 AR='$$(COMPRT_AR_$(1))' \
 266                 RANLIB='$$(COMPRT_AR_$(1)) s' \
 267                 CFLAGS="$$(COMPRT_CFLAGS_$(1))" \
 268                 TargetTriple=$(1) \
 269                 triple-builtins
 270         $$(Q)cp $$(COMPRT_BUILD_DIR_$(1))/triple/builtins/libcompiler_rt.a $$@
 271 endif
 272 ################################################################################
 273 # libbacktrace
 274 #
 275 # We use libbacktrace on linux to get symbols in backtraces, but only on linux.
 276 # Elsewhere we use other system utilities, so this library is only built on
 277 # linux.
 278 ################################################################################
 279
 280 BACKTRACE_NAME_$(1) := $$(call CFG_STATIC_LIB_NAME_$(1),backtrace)
 281 BACKTRACE_LIB_$(1) := $$(RT_OUTPUT_DIR_$(1))/$$(BACKTRACE_NAME_$(1))
 282 BACKTRACE_BUILD_DIR_$(1) := $$(RT_OUTPUT_DIR_$(1))/libbacktrace
 283
 284 # We don't use this on platforms that aren't linux-based (with the exception of
 285 # msys2/mingw builds on windows, which use it to read the dwarf debug
 286 # information) so just make the file available, the compilation of libstd won't
 287 # actually build it.
 288 ifeq ($$(findstring darwin,$$(OSTYPE_$(1))),darwin)
 289 # See comment above
 290 $$(BACKTRACE_LIB_$(1)):
 291         touch $$@
 292
 293 else
 294 ifeq ($$(findstring ios,$$(OSTYPE_$(1))),ios)
 295 # See comment above
 296 $$(BACKTRACE_LIB_$(1)):
 297         touch $$@
 298 else
 299
 300 ifeq ($$(findstring msvc,$(1)),msvc)
 301 # See comment above
 302 $$(BACKTRACE_LIB_$(1)):
 303         touch $$@
 304 else
 305
 306 ifdef CFG_ENABLE_FAST_MAKE
 307 BACKTRACE_DEPS := $(S)/.gitmodules
 308 else
 309 BACKTRACE_DEPS := $(wildcard $(S)src/libbacktrace/*)
 310 endif
 311
 312 # We need to export CFLAGS because otherwise it doesn't pick up cross compile
 313 # builds. If libbacktrace doesn't realize this, it will attempt to read 64-bit
 314 # elf headers when compiled for a 32-bit system, yielding blank backtraces.
 315 #
 316 # This also removes the -Werror flag specifically to prevent errors during
 317 # configuration.
 318 #
 319 # Down below you'll also see echos into the config.h generated by the
 320 # ./configure script. This is done to force libbacktrace to *not* use the
 321 # atomic/sync functionality because it pulls in unnecessary dependencies and we
 322 # never use it anyway.
 323 #
 324 # We also use `env PWD=` to clear the PWD environment variable, and then
 325 # execute the command in a new shell. This is necessary to workaround a
 326 # buildbot/msys2 bug: the shell is launched with PWD set to a windows-style path,
 327 # which results in all further uses of `pwd` also printing a windows-style path,
 328 # which breaks libbacktrace's configure script. Clearing PWD within the same
 329 # shell is not sufficient.
 330
 331 $$(BACKTRACE_BUILD_DIR_$(1))/Makefile: $$(BACKTRACE_DEPS) $$(MKFILE_DEPS)
 332         @$$(call E, configure: libbacktrace for $(1))
 333         $$(Q)rm -rf $$(BACKTRACE_BUILD_DIR_$(1))
 334         $$(Q)mkdir -p $$(BACKTRACE_BUILD_DIR_$(1))
 335         $$(Q)(cd $$(BACKTRACE_BUILD_DIR_$(1)) && env \
 336               PWD= \
 337               CC="$$(CC_$(1))" \
 338               AR="$$(AR_$(1))" \
 339               RANLIB="$$(AR_$(1)) s" \
 340               CFLAGS="$$(CFG_GCCISH_CFLAGS_$(1):-Werror=) -fno-stack-protector" \
 341               $(S)src/libbacktrace/configure --build=$(CFG_GNU_TRIPLE_$(CFG_BUILD)) --host=$(CFG_GNU_TRIPLE_$(1)))
 342         $$(Q)echo '#undef HAVE_ATOMIC_FUNCTIONS' >> \
 343               $$(BACKTRACE_BUILD_DIR_$(1))/config.h
 344         $$(Q)echo '#undef HAVE_SYNC_FUNCTIONS' >> \
 345               $$(BACKTRACE_BUILD_DIR_$(1))/config.h
 346
 347 $$(BACKTRACE_LIB_$(1)): $$(BACKTRACE_BUILD_DIR_$(1))/Makefile $$(MKFILE_DEPS)
 348         @$$(call E, make: libbacktrace)
 349         $$(Q)$$(MAKE) -C $$(BACKTRACE_BUILD_DIR_$(1)) \
 350                 INCDIR=$(S)src/libbacktrace
 351         $$(Q)cp $$(BACKTRACE_BUILD_DIR_$(1))/.libs/libbacktrace.a $$@
 352
 353 endif # endif for msvc
 354 endif # endif for ios
 355 endif # endif for darwin
 356
 357 ################################################################################
 358 # libc/libunwind for musl
 359 #
 360 # When we're building a musl-like target we're going to link libc/libunwind
 361 # statically into the standard library and liblibc, so we need to make sure
 362 # they're in a location that we can find
 363 ################################################################################
 364
 365 ifeq ($$(findstring musl,$(1)),musl)
 366 $$(RT_OUTPUT_DIR_$(1))/%: $$(CFG_MUSL_ROOT)/lib/%
 367         cp $$^ $$@
 368 else
 369 # Ask gcc where it is
 370 $$(RT_OUTPUT_DIR_$(1))/%:
 371         cp $$(shell $$(CC_$(1)) -print-file-name=$$(@F)) $$@
 372 endif
 373
 374 endef
 375
 376 # Instantiate template for all stages/targets
 377 $(foreach target,$(CFG_TARGET), \
 378      $(eval $(call DEF_THIRD_PARTY_TARGETS,$(target))))