mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
ba7815163c
- Add the new EXTERNAL_BOARD_DIRS variable that can contain a space separated
list of folders containing external boards
- Introduce $(BOARDDIR) as shortcut for $(BOARDSDIR)/$(BOARD)
- Map the existing BOARDSDIR to the new approach
- If BOARDSDIR is provided by the user, it will be added to
EXTERNAL_BOARD_DIRS for backward compatibility. (And a warning is issued
to encourage users migrating to EXTRA_BOARDS.)
- BOARDSDIR is updated after the board is found to "$(BOARDDIR)/..".
- Useful for `include $(BOARDSDIR)/common/external_common/Makefile.dep`
- Provides backward compatibility
293 lines
11 KiB
Makefile
293 lines
11 KiB
Makefile
export DOCKER_IMAGE ?= riot/riotbuild:latest
|
|
export DOCKER_BUILD_ROOT ?= /data/riotbuild
|
|
DOCKER_RIOTBASE ?= $(DOCKER_BUILD_ROOT)/riotbase
|
|
export DOCKER_FLAGS ?= --rm
|
|
# List of Docker-enabled make goals
|
|
export DOCKER_MAKECMDGOALS_POSSIBLE = \
|
|
all \
|
|
buildtest-indocker \
|
|
scan-build \
|
|
scan-build-analyze \
|
|
tests-% \
|
|
archive-check \
|
|
#
|
|
export DOCKER_MAKECMDGOALS = $(filter $(DOCKER_MAKECMDGOALS_POSSIBLE),$(MAKECMDGOALS))
|
|
|
|
# Docker creates the files .dockerinit and .dockerenv in the root directory of
|
|
# the container, we check for the files to determine if we are inside a container.
|
|
ifneq (,$(wildcard /.dockerinit /.dockerenv))
|
|
export INSIDE_DOCKER := 1
|
|
else
|
|
export INSIDE_DOCKER := 0
|
|
endif
|
|
|
|
# Default target for building inside a Docker container if nothing was given
|
|
export DOCKER_MAKECMDGOALS ?= all
|
|
# List of all exported environment variables that shall be passed on to the
|
|
# Docker container, they will only be passed if they are set from the
|
|
# environment, not if they are only default Makefile values.
|
|
export DOCKER_ENV_VARS += \
|
|
APPDIR \
|
|
AR \
|
|
ARFLAGS \
|
|
AS \
|
|
ASFLAGS \
|
|
BINDIR \
|
|
BINDIRBASE \
|
|
BOARD \
|
|
BOARDS \
|
|
BUILDRELPATH \
|
|
BUILDTEST_MCU_GROUP \
|
|
BUILDTEST_VERBOSE \
|
|
CC \
|
|
CC_NOCOLOR \
|
|
CFLAGS \
|
|
CPPMIX \
|
|
CXX \
|
|
CXXEXFLAGS \
|
|
CXXUWFLAGS \
|
|
ELFFILE \
|
|
HEXFILE \
|
|
FLASHFILE \
|
|
LINK \
|
|
LINKFLAGPREFIX \
|
|
LINKFLAGS \
|
|
LTO \
|
|
OBJCOPY \
|
|
OFLAGS \
|
|
PREFIX \
|
|
QUIET \
|
|
WERROR \
|
|
PROGRAMMER \
|
|
RIOT_CI_BUILD \
|
|
RIOT_VERSION \
|
|
SCANBUILD_ARGS \
|
|
SCANBUILD_OUTPUTDIR \
|
|
SIZE \
|
|
TOOLCHAIN \
|
|
UNDEF \
|
|
#
|
|
|
|
# Find which variables were set using the command line or the environment and
|
|
# pass those to Docker.
|
|
# DOCKER_ENVIRONMENT_CMDLINE must be immediately assigned (:=) or otherwise some
|
|
# of the environment variables will be overwritten by Makefile.include and their
|
|
# origin is changed to "file"
|
|
DOCKER_ENVIRONMENT_CMDLINE_AUTO := $(foreach varname,$(DOCKER_ENV_VARS), \
|
|
$(if $(filter environment command,$(origin $(varname))), \
|
|
-e '$(varname)=$(subst ','\'',$($(varname)))', \
|
|
))
|
|
DOCKER_ENVIRONMENT_CMDLINE += $(strip $(DOCKER_ENVIRONMENT_CMDLINE_AUTO))
|
|
|
|
|
|
# The variables set on the command line will also be passed on the command line
|
|
# in Docker
|
|
DOCKER_OVERRIDE_CMDLINE_AUTO := $(foreach varname,$(DOCKER_ENV_VARS), \
|
|
$(if $(filter command,$(origin $(varname))), \
|
|
'$(varname)=$($(varname))', \
|
|
))
|
|
DOCKER_OVERRIDE_CMDLINE += $(strip $(DOCKER_OVERRIDE_CMDLINE_AUTO))
|
|
|
|
# Overwrite if you want to use `docker` with sudo
|
|
DOCKER ?= docker
|
|
|
|
# 'make' arguments inside docker
|
|
DOCKER_MAKE_ARGS += $(DOCKER_MAKECMDGOALS) $(DOCKER_OVERRIDE_CMDLINE)
|
|
|
|
# Resolve symlink of /etc/localtime to its real path
|
|
# This is a workaround for docker on macOS, for more information see:
|
|
# https://github.com/docker/for-mac/issues/2396
|
|
ETC_LOCALTIME = $(realpath /etc/localtime)
|
|
|
|
|
|
# # # # # # # # # # # # # # # #
|
|
# Directory mapping functions #
|
|
# # # # # # # # # # # # # # # #
|
|
#
|
|
# This part handles mapping and mounting directories variables from the
|
|
# host system in the docker container.
|
|
#
|
|
# In the container all directories are mapped in subdirectories of
|
|
# `DOCKER_BUILD_ROOT` (`/data/riotbuild` by default).
|
|
#
|
|
#
|
|
# The RIOT directory `RIOTBASE` is mounted to `DOCKER_RIOTBASE`
|
|
# (`DOCKER_BUILD_ROOT/riotbase` by default).
|
|
#
|
|
# For other directories variables:
|
|
#
|
|
# * if the directory is contained within the `RIOT` repository,
|
|
# the variable is mapped to a path inside `DOCKER_RIOTBASE` in the container.
|
|
#
|
|
# * if the directory is not contained in the `RIOT` repository,
|
|
# the directory must be mounted in the countainer.
|
|
# The variable and directory are mapped to a path outside `DOCKER_RIOTBASE`.
|
|
# Some variables have hardwritten mapping directories (`RIOTCPU` for example),
|
|
# and other have a mapping directory based on their directory name.
|
|
|
|
|
|
# Test if a directory is a subdirectory of `RIOTBASE`
|
|
#
|
|
# dir_is_outside_riotbase <directory>
|
|
#
|
|
# $1 = directory
|
|
# Returns: a non empty value if it is True
|
|
#
|
|
# From env:
|
|
# * RIOTBASE
|
|
#
|
|
# The terminating '/' in patsubst is important to match $1 == $(RIOTBASE)
|
|
# It also handles relative directories
|
|
|
|
define dir_is_outside_riotbase
|
|
$(filter $(abspath $1)/,$(patsubst $(RIOTBASE)/%,%,$(abspath $1)/))
|
|
endef
|
|
|
|
|
|
# Mapping of directores inside docker
|
|
#
|
|
# Return the path of directories from the host within the container
|
|
#
|
|
# path_in_docker <directories> <map base directory|> <mapname|>
|
|
#
|
|
# $1 = directories (can be a list of relative directories)
|
|
# $2 = docker remap base directory (defaults to DOCKER_BUILD_ROOT)
|
|
# $3 = mapname (defaults to each directory name).
|
|
# If provided $1 must only contain one directory.
|
|
# Returns: the path the directory would have in docker
|
|
#
|
|
# For each directory:
|
|
# * if inside $(RIOTBASE), returns $(DOCKER_RIOTBASE)/<relative_path_in_riotbase>
|
|
# * if outside $(RIOTBASE), returns <docker remapbase>/<mapname>
|
|
#
|
|
# From env:
|
|
# * RIOTBASE
|
|
# * DOCKER_RIOTBASE
|
|
# * DOCKER_BUILD_ROOT
|
|
|
|
path_in_docker = $(foreach d,$1,$(strip $(call _dir_path_in_docker,$d,$2,$3)))
|
|
define _dir_path_in_docker
|
|
$(if $(call dir_is_outside_riotbase,$1),\
|
|
$(if $2,$2,$(DOCKER_BUILD_ROOT))/$(if $3,$3,$(notdir $(abspath $1))),\
|
|
$(patsubst %/,%,$(patsubst $(RIOTBASE)/%,$(DOCKER_RIOTBASE)/%,$(abspath $1)/)))
|
|
endef
|
|
|
|
# Volume mapping and environment arguments
|
|
#
|
|
# Docker arguments for mapping directories:
|
|
#
|
|
# * volume mapping for each directory not in RIOT
|
|
# * remap environment variable directories to the docker ones
|
|
#
|
|
#
|
|
# docker_volume_and_env <path_in_docker_args|...>
|
|
# docker_volumes_mapping and docker_environ_mapping on different lines
|
|
#
|
|
# docker_volumes_mapping <path_in_docker_args|...>
|
|
# Command line argument for mapping volumes, if it should be mounted
|
|
# -v 'directory:docker_directory'
|
|
#
|
|
# docker_environ_mapping <path_in_docker_args|...>
|
|
# Command line argument for mapping environment variables
|
|
# -e variable=docker_directory
|
|
#
|
|
# docker_cmdline_mapping <path_in_docker_args|...>
|
|
# Command line argument for mapping environment variables
|
|
# variable=docker_directory
|
|
#
|
|
# Arguments are the same as 'path_in_docker'
|
|
# If the 'directories' variable is empty, it will not be exported to docker
|
|
|
|
# docker_volume command line arguments. Allows giving volume mount options.
|
|
# By default 'DOCKER_VOLUME_OPTIONS'. Argument option ignore the default.
|
|
DOCKER_VOLUME_OPTIONS ?= delegated
|
|
docker_volume = -v '$1:$2$(addprefix :,$(or $3,$(DOCKER_VOLUME_OPTIONS)))'
|
|
|
|
docker_volume_and_env = $(strip $(call _docker_volume_and_env,$1,$2,$3))
|
|
define _docker_volume_and_env
|
|
$(call docker_volumes_mapping,$($1),$2,$3)
|
|
$(call docker_environ_mapping,$1,$2,$3)
|
|
endef
|
|
docker_volumes_mapping = $(foreach d,$1,$(call _docker_volume_mapping,$d,$2,$3))
|
|
_docker_volume_mapping = $(if $1,$(if $(call dir_is_outside_riotbase,$1),$(call docker_volume,$(abspath $1),$(call path_in_docker,$1,$2,$3))))
|
|
docker_environ_mapping = $(addprefix -e ,$(call docker_cmdline_mapping,$1,$2,$3))
|
|
docker_cmdline_mapping = $(if $($1),'$1=$(call path_in_docker,$($1),$2,$3)')
|
|
|
|
|
|
# Application directory relative to either riotbase or riotproject
|
|
DOCKER_RIOTPROJECT = $(call path_in_docker,$(RIOTPROJECT),,riotproject)
|
|
DOCKER_APPDIR = $(DOCKER_RIOTPROJECT)/$(BUILDRELPATH)
|
|
|
|
|
|
# Directory mapping in docker and directories environment variable configuration
|
|
DOCKER_VOLUMES_AND_ENV += $(call docker_volume,$(ETC_LOCALTIME),/etc/localtime,ro)
|
|
DOCKER_VOLUMES_AND_ENV += $(call docker_volume,$(RIOTBASE),$(DOCKER_RIOTBASE))
|
|
DOCKER_VOLUMES_AND_ENV += -e 'RIOTBASE=$(DOCKER_RIOTBASE)'
|
|
DOCKER_VOLUMES_AND_ENV += -e 'CCACHE_BASEDIR=$(DOCKER_RIOTBASE)'
|
|
|
|
DOCKER_VOLUMES_AND_ENV += $(call docker_volume_and_env,BUILD_DIR,,build)
|
|
|
|
DOCKER_VOLUMES_AND_ENV += $(call docker_volume_and_env,RIOTPROJECT,,riotproject)
|
|
DOCKER_VOLUMES_AND_ENV += $(call docker_volume_and_env,RIOTCPU,,riotcpu)
|
|
DOCKER_VOLUMES_AND_ENV += $(call docker_volume_and_env,RIOTBOARD,,riotboard)
|
|
DOCKER_VOLUMES_AND_ENV += $(call docker_volume_and_env,RIOTMAKE,,riotmake)
|
|
|
|
# Add GIT_CACHE_DIR if the directory exists
|
|
DOCKER_VOLUMES_AND_ENV += $(if $(wildcard $(GIT_CACHE_DIR)),$(call docker_volume,$(GIT_CACHE_DIR),$(DOCKER_BUILD_ROOT)/gitcache))
|
|
DOCKER_VOLUMES_AND_ENV += $(if $(wildcard $(GIT_CACHE_DIR)),-e 'GIT_CACHE_DIR=$(DOCKER_BUILD_ROOT)/gitcache')
|
|
|
|
# Remap external module directories.
|
|
#
|
|
# This remaps directories from EXTERNAL_MODULE_DIRS to subdirectories of
|
|
# $(DOCKER_BUILD_ROOT)/external
|
|
#
|
|
# Remapped directories must all have different basenames
|
|
#
|
|
# Limitation: If a directory is inside RIOTPROJECT and not in RIOT it is
|
|
# remapped anyway instead of loading from inside RIOTPROJECT.
|
|
#
|
|
# As EXTERNAL_MODULE_DIRS should ignore the 'Makefile' configuration, they must
|
|
# be set using command line variable settings to not be modified within docker.
|
|
DOCKER_VOLUMES_AND_ENV += $(call docker_volumes_mapping,$(EXTERNAL_MODULE_DIRS),$(DOCKER_BUILD_ROOT)/external,)
|
|
DOCKER_OVERRIDE_CMDLINE += $(call docker_cmdline_mapping,EXTERNAL_MODULE_DIRS,$(DOCKER_BUILD_ROOT)/external,)
|
|
|
|
# Remap 'EXTERNAL_BOARD_DIRS' if they are external
|
|
DOCKER_VOLUMES_AND_ENV += $(call docker_volumes_mapping,$(EXTERNAL_BOARD_DIRS),$(DOCKER_BUILD_ROOT)/external,)
|
|
# Value is overridden from command line if it is not the default value
|
|
# This allows handling even if the value is set in the 'Makefile'.
|
|
DOCKER_OVERRIDE_CMDLINE += $(call docker_cmdline_mapping,EXTERNAL_BOARD_DIRS,$(DOCKER_BUILD_ROOT)/external,)
|
|
|
|
# External module directories sanity check:
|
|
#
|
|
# Detect if there are remapped directories with the same name as it is not handled.
|
|
# Having EXTERNAL_MODULE_DIRS = /path/to/dir/name \
|
|
# /another/directory/also/called/name
|
|
# would lead to both being mapped to '$(DOCKER_BUILD_ROOT)/external/name'
|
|
_mounted_dirs = $(foreach d,$(EXTERNAL_MODULE_DIRS),$(if $(call dir_is_outside_riotbase,$(d)),$(d)))
|
|
ifneq ($(words $(sort $(notdir $(_mounted_dirs)))),$(words $(sort $(_mounted_dirs))))
|
|
$(warning Mounted EXTERNAL_MODULE_DIRS: $(_mounted_dirs))
|
|
$(error Mapping EXTERNAL_MODULE_DIRS in docker is not supported for directories with the same name)
|
|
endif
|
|
|
|
# Handle worktree by mounting the git common dir in the same location
|
|
_is_git_worktree = $(shell grep '^gitdir: ' $(RIOTBASE)/.git 2>/dev/null)
|
|
GIT_WORKTREE_COMMONDIR = $(abspath $(shell git rev-parse --git-common-dir))
|
|
DOCKER_VOLUMES_AND_ENV += $(if $(_is_git_worktree),$(call docker_volume,$(GIT_WORKTREE_COMMONDIR),$(GIT_WORKTREE_COMMONDIR)))
|
|
|
|
# This will execute `make $(DOCKER_MAKECMDGOALS)` inside a Docker container.
|
|
# We do not push the regular $(MAKECMDGOALS) to the container's make command in
|
|
# order to only perform building inside the container and defer executing any
|
|
# extra commands such as flashing or debugging until after leaving the
|
|
# container.
|
|
# The `flash`, `term`, `debugserver` etc. targets usually require access to
|
|
# hardware which may not be reachable from inside the container.
|
|
..in-docker-container:
|
|
@$(COLOR_ECHO) '$(COLOR_GREEN)Launching build container using image "$(DOCKER_IMAGE)".$(COLOR_RESET)'
|
|
@# HACK: Handle directory creation here until it is provided globally
|
|
$(Q)mkdir -p $(BUILD_DIR)
|
|
$(DOCKER) run $(DOCKER_FLAGS) -t -u "$$(id -u)" \
|
|
$(DOCKER_VOLUMES_AND_ENV) \
|
|
$(DOCKER_ENVIRONMENT_CMDLINE) \
|
|
-w '$(DOCKER_APPDIR)' \
|
|
'$(DOCKER_IMAGE)' make $(DOCKER_MAKE_ARGS)
|