Makefile

#!/usr/bin/make -f
#
# Copyright (c) 2016 Dream Property GmbH, Germany
#                    https://dreambox.de/
# Author:
#   Andreas Oberritter <obi@opendreambox.org>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#

# Note: You can override all variables by storing them
# in an external file called "make.conf".
-include conf/make.conf

# Target platforms:
# dm520, dm820, dm900, dm7080
#
# This only sets the default value. All platforms now use a shared build
# directory. Run "MACHINE=dm820 bitbake dreambox-image" to build an image
# for the dm820, if it is not the default.
MACHINE ?= dm900

USER_MACHINE := $(MACHINE)

MAKE_IMAGE_BB ?= dreambox-image

# Adjust according to the number CPU cores to use for parallel build.
# Default: Number of processors in /proc/cpuinfo, if present, or 1.
NR_CPU := $(shell [ -f /proc/cpuinfo ] && grep -c '^processor\s*:' /proc/cpuinfo || echo 1)
BB_NUMBER_THREADS ?= $(NR_CPU)
PARALLEL_MAKE ?= -j $(NR_CPU)

NICE ?= nice -n 19
XSUM ?= md5sum

BUILD_DIR = $(CURDIR)/build
TOPDIR = $(BUILD_DIR)/$(MACHINE)
DL_DIR = $(CURDIR)/sources
PERSISTENT_DIR = $(CURDIR)/persist-cache
SSTATE_DIR = $(CURDIR)/sstate-cache
TMPDIR = $(TOPDIR)/tmp
DEPDIR = $(CURDIR)/.deps

BITBAKE = . $(CURDIR)/bitbake.env && cd $(TOPDIR) && $(NICE) bitbake

BBLAYERS ?= \
	$(CURDIR)/meta-dreambox \
	$(CURDIR)/meta-opendreambox \
	$(CURDIR)/meta-openembedded/meta-filesystems \
	$(CURDIR)/meta-openembedded/meta-multimedia \
	$(CURDIR)/meta-openembedded/meta-networking \
	$(CURDIR)/meta-openembedded/meta-oe \
	$(CURDIR)/meta-openembedded/meta-python \
	$(CURDIR)/meta-openembedded/meta-ruby \
	$(CURDIR)/meta-openembedded/meta-webserver \
	$(CURDIR)/meta-qt5 \
	$(CURDIR)/openembedded-core/meta

CONFFILES_AUTO = \
	bitbake.env \
	conf/opendreambox.conf \
	$(TOPDIR)/Makefile \
	$(TOPDIR)/bitbake.env \
	$(TOPDIR)/conf/bblayers.conf \
	$(TOPDIR)/conf/local.conf

CONFFILES_MANUAL = \
	.cross-compile-$(MACHINE).env

CONFDEPS = \
	$(DEPDIR)/.bitbake.env.$(BITBAKE_ENV_HASH) \
	$(DEPDIR)/.opendreambox.conf.$(OPENDREAMBOX_CONF_HASH) \
	$(DEPDIR)/.bblayers.conf.$(MACHINE).$(BBLAYERS_CONF_HASH) \
	$(DEPDIR)/.local.conf.$(MACHINE).$(LOCAL_CONF_HASH) \
	$(DEPDIR)/.cross-compile.env.$(MACHINE).$(CROSS_COMPILE_ENV_HASH)

CONFFILES_BITBAKE = \
	conf/opendreambox.conf \
	openembedded-core/meta/conf/bitbake.conf \
	$(wildcard \
		conf/bblayers-ext.conf \
		conf/bblayers-$(MACHINE)-ext.conf \
		conf/local-ext.conf \
		conf/local-$(MACHINE)-ext.conf)

GIT ?= git
GIT_REMOTE := $(shell $(GIT) remote)
GIT_AUTHOR_NAME ?= $(shell $(GIT) config user.name)
GIT_AUTHOR_EMAIL ?= $(shell $(GIT) config user.email)

hash = $(shell echo $(1) | $(XSUM) | awk '{print $$1}')

.DEFAULT_GOAL := all
all: init usage

$(BBLAYERS):
	[ -d $@ ] || $(MAKE) $(MFLAGS) update

init: $(BBLAYERS) $(CONFFILES_AUTO)

help:
	@echo "Your options:"
	@echo
	@echo "  * Update the SDK"
	@echo "      $$ $(MAKE) update"
	@echo
	@echo "  * Build the PDF documentation (doc/opendreambox.pdf, requires pdfTeX):"
	@echo "      $$ $(MAKE) doc"
	@echo
	@echo "  * View the documentation in text format:"
	@echo "      $$ view doc/opendreambox.txt"
	@echo
	@echo "  * Select a new target machine:"
	@echo "      $$ echo MACHINE=dm820 >> conf/make.conf"
	@echo "    [Valid values: dm520, dm820, dm900, dm7080]"
	@echo
	@echo "  * Build a firmware image for the selected target machine:"
	@echo "      $$ $(MAKE) image"
	@echo
	@echo "  * Build a firmware image for a different target machine:"
	@echo "      $$ $(MAKE) image MACHINE=dm820"
	@echo "    [Valid values: dm520, dm820, dm900, dm7080]"
	@echo
	@echo "  * Download all source files at once:"
	@echo "      $$ $(MAKE) download"
	@echo
	@echo "  * Set up the environment to build recipes manually:"
	@echo "      $$ source bitbake.env"
	@echo "      $$ cd build/$(MACHINE)"
	@echo "      $$ bitbake <target>"
	@echo "    [Replace <target> with a recipe name, e.g. $(MAKE_IMAGE_BB) or enigma2]"
	@echo
	@echo "Your current settings:"
	@echo "  MACHINE = $(USER_MACHINE)"
	@echo
	@echo "  BB_NUMBER_THREADS = $(BB_NUMBER_THREADS)"
	@echo "  PARALLEL_MAKE = $(PARALLEL_MAKE)"
	@echo
	@echo "Trouble finding a recipe? Try ./scripts/drepo grep 'search string'"
	@echo "or ./scripts/drepo find -name \"*recipe*\"."
	@echo
	@if [ -z "$(GIT_AUTHOR_NAME)" -o -z "$(GIT_AUTHOR_EMAIL)" ]; then \
		echo "Before doing any commits, please configure your name and email"; \
		echo "address using the following commands:"; \
		echo; \
		echo "  $$ $(GIT) config user.name \"Your Name\""; \
		echo "  $$ $(GIT) config user.email \"mail@example.com\""; \
	else \
		echo "Git has been configured for $(GIT_AUTHOR_NAME) <$(GIT_AUTHOR_EMAIL)>."; \
		echo "Please submit patches to <enigma2-devel@lists.elitedvb.net>."; \
	fi

usage:
	@echo "[*] Please run '$(MAKE) help' to display further information!"

clean:
	@echo '[*] Deleting generated configuration files'
	@$(RM) $(CONFFILES_AUTO) $(CONFFILES_MANUAL) $(CONFDEPS)
	@$(MAKE) $(MFLAGS) -C doc clean

distclean: clean
	@echo '[*] Deleting dependencies directory'
	@$(RM) -r $(DEPDIR)
	@echo '[*] Deleting download directory'
	@$(RM) -r $(DL_DIR)
	@echo '[*] Deleting tmp directory'
	@$(RM) -r $(TMPDIR)
	@echo '[*] Deleting sstate directory'
	@$(RM) -r $(SSTATE_DIR)
	@echo '[*] Deleting persistent directory'
	@$(RM) -r $(PERSISTENT_DIR)
	@echo '[*] Deleting build directory'
	@$(RM) -r $(BUILD_DIR)
	@echo '[*] Deleting git submodules'
	@$(GIT) submodule foreach 'rm -rf .* * 2>/dev/null || true'

# function to convert simple space separated list to csv
space :=
space +=
comma := ,
csv = $(subst $(space),$(comma),$(strip $1))

sstate-cache-clean: init
	@echo '[*] Cleaning up sstate-cache'
	@. $(CURDIR)/bitbake.env && sstate-cache-management.sh --cache-dir=$(SSTATE_DIR) --stamps-dir=$(call csv,$(wildcard $(CURDIR)/build/*/tmp*/stamps)) -v

doc:
	@$(MAKE) $(MFLAGS) -C doc

dreambox-image enigma2 package-index: init
	@echo '[*] Building $@ for $(USER_MACHINE)'
	@$(BITBAKE) $@

image: init
	@echo '[*] Building $@ for $(USER_MACHINE)'
	@$(BITBAKE) $(MAKE_IMAGE_BB)

console-image: init
	@echo '[*] Building $@ for $(USER_MACHINE)'
	@$(BITBAKE) dreambox-$@

rescue-image: init
	@echo '[*] Building $@ for $(USER_MACHINE)'
	@$(BITBAKE) linux-dreambox

download: init
	@echo '[*] Downloading sources'
	@$(BITBAKE) -cfetchall -k $(MAKE_IMAGE_BB)

update:
	@echo '[*] Updating Git repositories...'
	@HASH=`$(XSUM) $(MAKEFILE_LIST)`; \
	if [ -n "$(GIT_REMOTE)" ]; then \
		$(GIT) pull --ff-only || $(GIT) pull --rebase || exit 1; \
	fi; \
	if [ "$$HASH" != "`$(XSUM) $(MAKEFILE_LIST)`" ]; then \
		echo '[*] Makefile changed. Restarting...'; \
		$(MAKE) $(MFLAGS) --no-print-directory $(MAKECMDGOALS); \
	else \
		$(GIT) submodule sync && \
		$(GIT) submodule update --init && \
		echo "[*] The Dreambox SDK is now up-to-date."; \
	fi

.PHONY: all clean doc help image init update usage

MACHINE_INCLUDE_CONF = $(CURDIR)/conf/$(basename $(@F))-$(MACHINE)-ext.conf
DISTRO_INCLUDE_CONF = $(CURDIR)/conf/$(basename $(@F))-ext.conf

BB_ENV_EXTRAWHITE = MACHINE DISTRO TCMODE TCLIBC HTTP_PROXY http_proxy \
	HTTPS_PROXY https_proxy FTP_PROXY ftp_proxy FTPS_PROXY ftps_proxy ALL_PROXY \
	all_proxy NO_PROXY no_proxy SSH_AGENT_PID SSH_AUTH_SOCK BB_SRCREV_POLICY \
	SDKMACHINE BB_NUMBER_THREADS BB_NO_NETWORK PARALLEL_MAKE GIT_PROXY_COMMAND \
	SOCKS5_PASSWD SOCKS5_USER SCREENDIR STAMPS_DIR BBPATH_EXTRA BB_SETSCENE_ENFORCE

BITBAKE_ENV_HASH := $(call hash, \
	'BITBAKE_ENV_VERSION = "0"' \
	'BB_ENV_EXTRAWHITE = "$(BB_ENV_EXTRAWHITE)"' \
	'CURDIR = "$(CURDIR)"' \
	)

bitbake.env: $(DEPDIR)/.bitbake.env.$(BITBAKE_ENV_HASH)
	@echo '[*] Generating $@'
	@echo '# Automatically generated file. Do not edit!' > $@
	@echo 'export BB_ENV_EXTRAWHITE="$(BB_ENV_EXTRAWHITE)"' >> $@
	@echo 'export PATH="$(CURDIR)/openembedded-core/scripts:$(CURDIR)/bitbake/bin:$${PATH}"' >> $@

OPENDREAMBOX_CONF_HASH := $(call hash, \
	'OPENDREAMBOX_CONF_VERSION = "2"' \
	'CURDIR = "$(CURDIR)"' \
	'BB_NUMBER_THREADS = "$(BB_NUMBER_THREADS)"' \
	'PARALLEL_MAKE = "$(PARALLEL_MAKE)"' \
	'DL_DIR = "$(DL_DIR)"' \
	'PERSISTENT_DIR = "$(PERSISTENT_DIR)"' \
	'SSTATE_DIR = "$(SSTATE_DIR)"' \
	)

conf/opendreambox.conf: $(DEPDIR)/.opendreambox.conf.$(OPENDREAMBOX_CONF_HASH)
	@echo '[*] Generating $@'
	@test -d $(@D) || mkdir -p $(@D)
	@echo '# Automatically generated file. Do not edit!' > $@
	@echo 'BB_NUMBER_THREADS = "$(BB_NUMBER_THREADS)"' >> $@
	@echo 'PARALLEL_MAKE = "$(PARALLEL_MAKE)"' >> $@
	@echo 'DL_DIR = "$(DL_DIR)"' >> $@
	@echo 'PERSISTENT_DIR = "$(PERSISTENT_DIR)"' >> $@
	@echo 'SSTATE_DIR = "$(SSTATE_DIR)"' >> $@
	@echo 'BB_GENERATE_MIRROR_TARBALLS = "0"' >> $@
	@echo 'BBINCLUDELOGS = "yes"' >> $@
	@echo 'CONF_VERSION = "1"' >> $@
	@echo 'DISTRO = "opendreambox"' >> $@
	@echo 'PATCHRESOLVE = "noop"' >> $@
	@echo 'PRSERV_HOST = "localhost:0"' >> $@

LOCAL_CONF_HASH := $(call hash, \
	'LOCAL_CONF_VERSION = "0"' \
	'CURDIR = "$(CURDIR)"' \
	'TOPDIR = "$(TOPDIR)"' \
	'MACHINE = "$(MACHINE)"' \
	'TMPDIR = "$(TMPDIR)"' \
	'DISTRO_INCLUDE_CONF = "$(DISTRO_INCLUDE_CONF)"' \
	'MACHINE_INCLUDE_CONF = "$(MACHINE_INCLUDE_CONF)"' \
	)

$(TOPDIR)/conf/local.conf: $(DEPDIR)/.local.conf.$(MACHINE).$(LOCAL_CONF_HASH)
	@echo '[*] Generating $@'
	@test -d $(@D) || mkdir -p $(@D)
	@echo '# Automatically generated file. Do not edit!' > $@
	@echo 'TOPDIR = "$(TOPDIR)"' >> $@
	@echo 'MACHINE = "$(MACHINE)"' >> $@
	@echo 'TMPDIR = "$(TMPDIR)"' >> $@
	@echo 'require $(CURDIR)/conf/opendreambox.conf' >> $@
	@echo 'include $(DISTRO_INCLUDE_CONF)' >> $@
	@echo 'include $(MACHINE_INCLUDE_CONF)' >> $@

BBLAYERS_CONF_HASH := $(call hash, \
	'BBLAYERS_CONF_VERSION = "0"' \
	'CURDIR = "$(CURDIR)"' \
	'LCONF_VERSION = "$(LCONF_VERSION)"' \
	'BBFILES = "$(BBFILES)"' \
	'BBLAYERS = "$(BBLAYERS)"' \
	'DISTRO_INCLUDE_CONF = "$(DISTRO_INCLUDE_CONF)"' \
	'MACHINE_INCLUDE_CONF = "$(MACHINE_INCLUDE_CONF)"' \
	)

$(TOPDIR)/conf/bblayers.conf: $(DEPDIR)/.bblayers.conf.$(MACHINE).$(BBLAYERS_CONF_HASH)
	@echo '[*] Generating $@'
	@test -d $(@D) || mkdir -p $(@D)
	@echo '# Automatically generated file. Do not edit!' > $@
	@echo 'LCONF_VERSION = "4"' >> $@
	@echo 'BBFILES = ""' >> $@
	@echo 'BBLAYERS = "$(BBLAYERS)"' >> $@
	@echo 'include $(DISTRO_INCLUDE_CONF)' >> $@
	@echo 'include $(MACHINE_INCLUDE_CONF)' >> $@

$(TOPDIR)/Makefile:
	@echo '[*] Generating $@'
	@test -d $(@D) || mkdir -p $(@D)
	@printf '%%::\n\tMACHINE=$(MACHINE) $$(MAKE) -C ../.. $$(MAKECMDGOALS)\n' > $@

$(TOPDIR)/bitbake.env:
	@echo '[*] Generating $@'
	@test -d $(@D) || mkdir -p $(@D)
	@echo '. ../../bitbake.env' > $@

CROSS_COMPILE_ENV_BLACKLIST = \
	HOME LOGNAME PWD SHELL SSH_AGENT_PID SSH_AUTH_SOCK TERM USER

CROSS_COMPILE_ENV_HASH := $(call hash, \
	'CROSS_COMPILE_ENV_VERSION = "0"' \
	'CURDIR = "$(CURDIR)"' \
	'PARALLEL_MAKE = "$(PARALLEL_MAKE)"' \
	'TMPDIR = "$(TMPDIR)"' \
	'TOPDIR = "$(TOPDIR)"' \
	'CROSS_COMPILE_ENV_BLACKLIST = "$(CROSS_COMPILE_ENV_BLACKLIST)"' \
	)

.cross-compile-$(MACHINE).env: $(DEPDIR)/.cross-compile.env.$(MACHINE).$(CROSS_COMPILE_ENV_HASH) $(CONFFILES_BITBAKE)
	@test -d $(TOPDIR) || (echo 'The directory "$(TOPDIR)" does not exist. Is "$(MACHINE)" a valid machine? Try running "make MACHINE=$(MACHINE)" first.' && exit 1)
	@echo '[*] Generating $@'
	@($(BITBAKE) -e | grep '^\(export\s\)\?[a-zA-Z0-9_]\+=".*"$$' | sed -e 's,^export\s,,' | grep -v $(foreach v,$(CROSS_COMPILE_ENV_BLACKLIST),-e ^$(v)=) | sed -e 's,^,local ,' | sort) > $@.tmp && [ -s $@.tmp ] && mv $@.tmp $@ || ($(RM) $@.tmp && echo 'Failed! Please verify that no instance of bitbake is currently running for this machine.' && exit 1)

$(CONFDEPS):
	@test -d $(@D) || mkdir -p $(@D)
	@$(RM) $(basename $@).*
	@touch $@