prepare.mk

# Copyright 2014 The Rust Project Developers. See the COPYRIGHT
# file at the top-level directory of this distribution and at
# http://rust-lang.org/COPYRIGHT.
#
# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
# http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
# <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
# option. This file may not be copied, modified, or distributed
# except according to those terms.

# Basic support for producing installation images.
#
# The 'prepare' build target copies all release artifacts from the build
# directory to some other location, placing all binaries, libraries, and
# docs in their final locations relative to each other.
#
# It requires the following variables to be set:
#
#   PREPARE_HOST - the host triple
#   PREPARE_TARGETS - the target triples, space separated
#   PREPARE_DEST_DIR - the directory to put the image

PREPARE_STAGE=2

DEFAULT_PREPARE_DIR_CMD = umask 022 && mkdir -p
DEFAULT_PREPARE_BIN_CMD = install -m755
DEFAULT_PREPARE_LIB_CMD = install -m644
DEFAULT_PREPARE_MAN_CMD = install -m644

# Create a directory
# $(1) is the directory
#
# XXX: These defines are called to generate make steps.
# Adding blank lines means two steps from different defines will not end up on
# the same line.
define PREPARE_DIR

	@$(call E, prepare: $(1))
	$(Q)$(PREPARE_DIR_CMD) $(1)

endef

# Copy an executable
# $(1) is the filename/libname-glob
#
# See above for an explanation on the surrounding blank lines
define PREPARE_BIN

	@$(call E, prepare: $(PREPARE_DEST_BIN_DIR)/$(1))
	$(Q)$(PREPARE_BIN_CMD) $(PREPARE_SOURCE_BIN_DIR)/$(1) $(PREPARE_DEST_BIN_DIR)/$(1)

endef

# Copy a dylib or rlib
# $(1) is the filename/libname-glob
#
# See above for an explanation on the surrounding blank lines
define PREPARE_LIB

	@$(call E, prepare: $(PREPARE_WORKING_DEST_LIB_DIR)/$(1))
	$(Q)LIB_NAME="$(notdir $(lastword $(wildcard $(PREPARE_WORKING_SOURCE_LIB_DIR)/$(1))))"; \
	MATCHES="$(filter-out %$(notdir $(lastword $(wildcard $(PREPARE_WORKING_SOURCE_LIB_DIR)/$(1)))), \
                        $(wildcard $(PREPARE_WORKING_DEST_LIB_DIR)/$(1)))"; \
	if [ -n "$$MATCHES" ]; then \
	  echo "warning: one or libraries matching Rust library '$(1)'" && \
	  echo "  (other than '$$LIB_NAME' itself) already present"     && \
	  echo "  at destination $(PREPARE_WORKING_DEST_LIB_DIR):"      && \
	  echo $$MATCHES ; \
	fi
	$(Q)$(PREPARE_LIB_CMD) `ls -drt1 $(PREPARE_WORKING_SOURCE_LIB_DIR)/$(1)` $(PREPARE_WORKING_DEST_LIB_DIR)/

endef

# Copy a man page
# $(1) - source dir
#
# See above for an explanation on the surrounding blank lines
define PREPARE_MAN

	@$(call E, prepare: $(PREPARE_DEST_MAN_DIR)/$(1))
	$(Q)$(PREPARE_MAN_CMD) $(PREPARE_SOURCE_MAN_DIR)/$(1) $(PREPARE_DEST_MAN_DIR)/$(1)

endef

PREPARE_TOOLS = $(filter-out compiletest rustbook error-index-generator, $(TOOLS))


# $(1) is tool
# $(2) is stage
# $(3) is host
# $(4) tag
define DEF_PREPARE_HOST_TOOL
prepare-host-tool-$(1)-$(2)-$(3)-$(4): \
	PREPARE_SOURCE_BIN_DIR=$$(HBIN$(2)_H_$(3))
prepare-host-tool-$(1)-$(2)-$(3)-$(4): prepare-maybe-clean-$(4) \
                                  $$(foreach dep,$$(TOOL_DEPS_$(1)),prepare-host-lib-$$(dep)-$(2)-$(3)-$(4)) \
                                  $$(HBIN$(2)_H_$(3))/$(1)$$(X_$(3)) \
                                  prepare-host-dirs-$(4)
	$$(if $$(findstring $(2), $$(PREPARE_STAGE)), \
      $$(if $$(findstring $(3), $$(PREPARE_HOST)), \
        $$(call PREPARE_BIN,$(1)$$(X_$$(PREPARE_HOST))),),)
	$$(if $$(findstring $(2), $$(PREPARE_STAGE)), \
      $$(if $$(findstring $(3), $$(PREPARE_HOST)), \
        $$(call PREPARE_MAN,$(1).1),),)
endef

# Libraries are compiled using the --libdir provided to configure, but
# we store them in the tarball using just "lib" so that the install
# script can then rewrite them back to the correct path.
PREPARE_TAR_LIB_DIR = $(patsubst $(CFG_LIBDIR_RELATIVE)%,lib%,$(1))

# For host libraries only install dylibs, not rlibs since the host libs are only
# used to support rustc and rustc uses dynamic linking
#
# $(1) is tool
# $(2) is stage
# $(3) is host
# $(4) tag
define DEF_PREPARE_HOST_LIB
prepare-host-lib-$(1)-$(2)-$(3)-$(4): \
	PREPARE_WORKING_SOURCE_LIB_DIR=$$(HLIB$(2)_H_$(3))
prepare-host-lib-$(1)-$(2)-$(3)-$(4): \
	PREPARE_WORKING_DEST_LIB_DIR=$$(PREPARE_DEST_DIR)/$$(call PREPARE_TAR_LIB_DIR,$$(HLIB_RELATIVE$(2)_H_$(3)))
prepare-host-lib-$(1)-$(2)-$(3)-$(4): prepare-maybe-clean-$(4) \
                                 $$(foreach dep,$$(RUST_DEPS_$(1)),prepare-host-lib-$$(dep)-$(2)-$(3)-$(4)) \
                                 $$(HLIB$(2)_H_$(3))/stamp.$(1) \
                                 prepare-host-dirs-$(4)
	$$(if $$(findstring $(2), $$(PREPARE_STAGE)), \
      $$(if $$(findstring $(3), $$(PREPARE_HOST)), \
        $$(if $$(findstring 1,$$(ONLY_RLIB_$(1))),, \
          $$(call PREPARE_LIB,$$(call CFG_LIB_GLOB_$$(PREPARE_HOST),$(1)))),),)
endef


# $(1) is stage
# $(2) is target
# $(3) is host
# $(4) tag
define DEF_PREPARE_TARGET_N
# Rebind PREPARE_*_LIB_DIR to point to rustlib, then install the libs for the targets
prepare-target-$(2)-host-$(3)-$(1)-$(4): \
	PREPARE_WORKING_SOURCE_LIB_DIR=$$(TLIB$(1)_T_$(2)_H_$(3))
prepare-target-$(2)-host-$(3)-$(1)-$(4): \
	PREPARE_WORKING_DEST_LIB_DIR=$$(PREPARE_DEST_LIB_DIR)/rustlib/$(2)/lib
prepare-target-$(2)-host-$(3)-$(1)-$(4): \
	PREPARE_SOURCE_BIN_DIR=$$(TBIN$(1)_T_$(2)_H_$(3))
prepare-target-$(2)-host-$(3)-$(1)-$(4): \
	PREPARE_DEST_BIN_DIR=$$(PREPARE_DEST_LIB_DIR)/rustlib/$(3)/bin
prepare-target-$(2)-host-$(3)-$(1)-$(4): prepare-maybe-clean-$(4) \
        $$(foreach crate,$$(TARGET_CRATES), \
          $$(TLIB$(1)_T_$(2)_H_$(3))/stamp.$$(crate)) \
        $$(if $$(findstring $(2),$$(CFG_HOST)), \
          $$(foreach crate,$$(HOST_CRATES), \
            $$(TLIB$(1)_T_$(2)_H_$(3))/stamp.$$(crate)),)
# Only install if this host and target combo is being prepared. Also be sure to
# *not* install the rlibs for host crates because there's no need to statically
# link against most of them. They just produce a large amount of extra size
# bloat.
	$$(if $$(findstring $(1), $$(PREPARE_STAGE)), \
      $$(if $$(findstring $(2), $$(PREPARE_TARGETS)), \
        $$(if $$(findstring $(3), $$(PREPARE_HOST)), \
          $$(call PREPARE_DIR,$$(PREPARE_WORKING_DEST_LIB_DIR)) \
          $$(call PREPARE_DIR,$$(PREPARE_DEST_BIN_DIR)) \
          $$(foreach crate,$$(TARGET_CRATES), \
	    $$(if $$(or $$(findstring 1, $$(ONLY_RLIB_$$(crate))),$$(findstring 1,$$(CFG_INSTALL_ONLY_RLIB_$(2)))),, \
              $$(call PREPARE_LIB,$$(call CFG_LIB_GLOB_$(2),$$(crate)))) \
            $$(call PREPARE_LIB,$$(call CFG_RLIB_GLOB,$$(crate)))) \
          $$(if $$(findstring $(2),$$(CFG_HOST)), \
            $$(foreach crate,$$(HOST_CRATES), \
              $$(call PREPARE_LIB,$$(call CFG_LIB_GLOB_$(2),$$(crate)))),) \
	  $$(foreach object,$$(INSTALLED_OBJECTS_$(2)),\
	    $$(call PREPARE_LIB,$$(object))) \
	  $$(foreach bin,$$(INSTALLED_BINS_$(3)),\
	    $$(call PREPARE_BIN,$$(bin))) \
	,),),)
endef

define INSTALL_GDB_DEBUGGER_SCRIPTS_COMMANDS
	$(Q)$(PREPARE_BIN_CMD) $(DEBUGGER_BIN_SCRIPTS_GDB_ABS) $(PREPARE_DEST_BIN_DIR)
	$(Q)$(PREPARE_LIB_CMD) $(DEBUGGER_RUSTLIB_ETC_SCRIPTS_GDB_ABS) $(PREPARE_DEST_LIB_DIR)/rustlib/etc
endef

define INSTALL_LLDB_DEBUGGER_SCRIPTS_COMMANDS
	$(Q)$(PREPARE_BIN_CMD) $(DEBUGGER_BIN_SCRIPTS_LLDB_ABS) $(PREPARE_DEST_BIN_DIR)
	$(Q)$(PREPARE_LIB_CMD) $(DEBUGGER_RUSTLIB_ETC_SCRIPTS_LLDB_ABS) $(PREPARE_DEST_LIB_DIR)/rustlib/etc
endef

define INSTALL_NO_DEBUGGER_SCRIPTS_COMMANDS
	$(Q)echo "No debugger scripts will be installed for host $(PREPARE_HOST)"
endef

# $(1) is PREPARE_HOST
INSTALL_DEBUGGER_SCRIPT_COMMANDS=$(if $(findstring windows,$(1)),\
                                   $(INSTALL_NO_DEBUGGER_SCRIPTS_COMMANDS),\
                                   $(if $(findstring darwin,$(1)),\
                                     $(INSTALL_LLDB_DEBUGGER_SCRIPTS_COMMANDS),\
                                     $(INSTALL_GDB_DEBUGGER_SCRIPTS_COMMANDS)))

define DEF_PREPARE

prepare-base-$(1)-%: PREPARE_SOURCE_MAN_DIR=$$(S)/man
prepare-base-$(1)-%: PREPARE_DEST_BIN_DIR=$$(PREPARE_DEST_DIR)/bin
prepare-base-$(1)-%: PREPARE_DEST_LIB_DIR=$$(PREPARE_DEST_DIR)/$$(call PREPARE_TAR_LIB_DIR,$$(CFG_LIBDIR_RELATIVE))
prepare-base-$(1)-%: PREPARE_DEST_MAN_DIR=$$(PREPARE_DEST_DIR)/share/man/man1

prepare-base-$(1)-target: prepare-target-$(1)
prepare-base-$(1)-host: prepare-host-$(1) prepare-debugger-scripts-$(1)

prepare-host-$(1): prepare-host-tools-$(1)

prepare-host-tools-$(1): \
        $$(foreach tool, $$(PREPARE_TOOLS), \
          $$(foreach host,$$(CFG_HOST), \
            prepare-host-tool-$$(tool)-$$(PREPARE_STAGE)-$$(host)-$(1)))

prepare-host-dirs-$(1): prepare-maybe-clean-$(1)
	$$(call PREPARE_DIR,$$(PREPARE_DEST_BIN_DIR))
	$$(call PREPARE_DIR,$$(PREPARE_DEST_LIB_DIR))
	$$(call PREPARE_DIR,$$(PREPARE_DEST_LIB_DIR)/rustlib/etc)
	$$(call PREPARE_DIR,$$(PREPARE_DEST_MAN_DIR))

prepare-debugger-scripts-$(1): prepare-host-dirs-$(1) \
                               $$(DEBUGGER_BIN_SCRIPTS_ALL_ABS) \
                               $$(DEBUGGER_RUSTLIB_ETC_SCRIPTS_ALL_ABS)
	$$(call INSTALL_DEBUGGER_SCRIPT_COMMANDS,$$(PREPARE_HOST))

$$(foreach tool,$$(PREPARE_TOOLS), \
  $$(foreach host,$$(CFG_HOST), \
      $$(eval $$(call DEF_PREPARE_HOST_TOOL,$$(tool),$$(PREPARE_STAGE),$$(host),$(1)))))

$$(foreach lib,$$(CRATES), \
  $$(foreach host,$$(CFG_HOST), \
    $$(eval $$(call DEF_PREPARE_HOST_LIB,$$(lib),$$(PREPARE_STAGE),$$(host),$(1)))))

prepare-target-$(1): \
        $$(foreach host,$$(CFG_HOST), \
           $$(foreach target,$$(CFG_TARGET), \
             prepare-target-$$(target)-host-$$(host)-$$(PREPARE_STAGE)-$(1)))

$$(foreach host,$$(CFG_HOST), \
  $$(foreach target,$$(CFG_TARGET), \
    $$(eval $$(call DEF_PREPARE_TARGET_N,$$(PREPARE_STAGE),$$(target),$$(host),$(1)))))

prepare-maybe-clean-$(1):
	$$(if $$(findstring true,$$(PREPARE_CLEAN)), \
      @$$(call E, cleaning destination $$(PREPARE_DEST_DIR)),)
	$$(if $$(findstring true,$$(PREPARE_CLEAN)), \
      $$(Q)rm -rf $$(PREPARE_DEST_DIR),)


endef