path: root/include/tree.sh

# SPDX-License-Identifier: GPL-3.0-or-later

# Copyright (c) 2022-2023 Alper Nebi Yasak <alpernebiyasak@gmail.com>
# Copyright (c) 2022 Ferass El Hafidi <vitali64pmemail@protonmail.com>
# Copyright (c) 2023-2025 Leah Rowe <leah@libreboot.org>

# flag e.g. ./mk -b <-- mkflag would be "b"
flag=""

xarch=""
srcdir=""
premake=""
gnatdir=""
xlang=""
mode=""
makeargs=""
elfdir=""
cmd=""
project=""
target=""
target_dir=""
targets=""
xgcctree=""
release=""
bootstrapargs=""
mkhelper=""
autoconfargs=""
listfile=""
autogenargs=""
buildtype=""
rev=""
build_depend=""
gccdir=""
cmakedir=""
defconfig=""
postmake=""
mkhelpercfg=""
if_not_dry_build=""
dest_dir=""
mdir=""
cleanargs=""
gccver=""
gccfull=""
gnatver=""
gnatfull=""
do_make=""
badhash=""
badtghash=""
tree=""
forcepull=""

trees()
{
	flags="f:b:m:u:c:x:s:l:n:d:"

	while getopts $flags option
	do
		if [ -n "$flag" ]; then
			err "only one flag is permitted" "trees" "$@"
		fi

		flag="$1"

		# the "mode" variable is affixed to a make command, example:
		# ./mk -m coreboot does: make menuconfig -C src/coreboot/tree

		case "$flag" in
		-d)
			# -d is similar to -b, except that
			# a large number of operations will be
			# skipped. these are "if_not_dry_build build" scenarios
			# where only a subset of build tasks are done,
			# and $if_not_dry_build is prefixed to skipped commands

			if_not_dry_build=":"
			;;
		-b) : ;;
		-u) mode="oldconfig" ;;
		-m) mode="menuconfig" ;;
		-c) mode="distclean" ;;
		-x) mode="crossgcc-clean" ;;
		-f) # download source code for a project
			do_make="n" # lets us know not to build anything
			if_not_dry_build=":"
			;;
		-F) # same as -F, but don't skip git fetch/pull on cache
			do_make="n" # lets us know not to build anything
			if_not_dry_build=":"
			forcepull="y"
			;;
		-s) mode="savedefconfig" ;;
		-l) mode="olddefconfig" ;;
		-n) mode="nconfig" ;;
		*) err "invalid option '-$option'" "trees" "$@" ;;
		esac

		if [ -z "${OPTARG+x}" ]; then
			shift 1

			break
		fi

		project="${OPTARG#src/}"
		project="${project#config/git/}"

		shift 2
	done

	if [ -z "$flag" ]; then
		err "missing flag ($flags)" "trees" "$@"
	elif [ -z "$project" ]; then
		fx_ "x_ ./mk $flag" x_ ls -1 config/git

		return 1

	elif [ ! -f "config/git/$project/pkg.cfg" ]; then
		err "config/git/$project/pkg.cfg missing" "trees" "$@"
	fi

	elfdir="elf/$project"
	datadir="config/data/$project"
	configdir="config/$project"
	srcdir="src/$project"
	dest_dir="$elfdir"

	listfile="$datadir/build.list"
	if [ ! -f "$listfile" ]; then
		listfile="" # build.list is optional on all projects
	fi

	mkhelpercfg="$datadir/mkhelper.cfg"
	if e "$mkhelpercfg" f missing; then
		mkhelpercfg="$xbtmp/mkhelper.cfg"
		x_ touch "$mkhelpercfg"
	fi

	targets="$*"
	cmd="build_targets $targets"
	if singletree "$project"; then
		cmd="build_project"
	fi

	remkdir "${tmpgit%/*}"
}

build_project()
{
	if ! configure_project "$configdir"; then
		return 0
	elif [ -f "$listfile" ]; then
		if ! $if_not_dry_build elfcheck; then
			return 0
		fi
	fi

	if [ "$mode" = "distclean" ]; then
		mode="clean"
	fi

	if ! run_make_command; then
		return 0
	fi

	if [ -z "$mode" ]; then
		$if_not_dry_build \
			copy_elf; :
	fi
}

build_targets()
{
	if [ ! -d "$configdir" ]; then
		err "directory '$configdir' doesn't exist" "build_targets" "$@"
	elif [ $# -lt 1 ]; then
		targets="$(ls -1 "$configdir")" || \
		    err "'$configdir': can't list targets" "build_targets" "$@"
	fi

	for x in $targets
	do
		unset CROSS_COMPILE
		export PATH="$xbmkpath"

		if [ "$x" = "list" ]; then
			x_ ls -1 "config/$project"

			listfile=""

			break
		fi

		printf "'make %s', '%s', '%s'\n" "$mode" "$project" "$x"

		target="$x"

		x_ handle_defconfig

		if [ -z "$mode" ]; then
			x_ $postmake
		fi
	done; :
}

handle_defconfig()
{
	target_dir="$configdir/$target"

	if [ ! -f "CHANGELOG" ]; then
		fetch_project "$project"
	fi
	if ! configure_project "$target_dir"; then
		return 0
	fi

	if [ -z "$tree" ]; then
		err "$configdir: 'tree' not set" "handle_defconfig" "$@"
	fi

	srcdir="src/$project/$tree"

	if [ "$mode" = "${mode%clean}" ] && [ ! -d "$srcdir" ]; then
		return 0
	fi

	for y in "$target_dir/config"/*
	do
		if [ "$flag" != "-d" ] && [ ! -f "$y" ]; then
			continue
		elif [ "$flag" != "-d" ]; then
			defconfig="$y"
		fi

		if [ -z "$mode" ]; then
			check_defconfig || continue; :
		fi

		if [ -z "$mode" ]; then
			for _xarch in $xarch; do
				if [ -n "$_xarch" ]; then
					$if_not_dry_build \
						check_cross_compiler "$_xarch"
				fi
			done; :
		fi

		handle_makefile

		if [ -z "$mode" ]; then
			$if_not_dry_build \
				copy_elf
		fi
	done; :
}

configure_project()
{
	cleanargs=""
	build_depend=""
	autoconfargs=""
	xgcctree=""
	postmake=""
	makeargs=""
	buildtype=""
	mkhelper=""
	bootstrapargs=""
	premake=""
	release=""
	xlang=""
	xarch=""
	badhash=""
	badtghash=""

	_tcfg="$1/target.cfg"

	if [ ! -f "$_tcfg" ]; then
		buildtype="auto"
	fi

	# globally initialise all variables for a source tree / target:

	if e "$datadir/mkhelper.cfg" f; then
		. "$datadir/mkhelper.cfg" || \
		    err "Can't read '$datadir/mkhelper.cfg'" \
		    "configure_project" "$@"
	fi

	# override target/tree specific variables from per-target config:

	while e "$_tcfg" f || [ "$cmd" != "build_project" ]
	do
		# TODO: implement infinite loop detection here, caused
		#       by project targets pointing to other targets/trees
		#       when then ultimate point back repeatedly; this is
		#       currently avoided simply by careful configuration.
		#       temporary files per tree/target name could be created
		#	per iteration, and then checked the next time

		printf "Loading %s config: %s\n" "$project" "$_tcfg"

		rev=""
		tree=""

		. "$_tcfg" || \
		    err "Can't read '$_tcfg'" "configure_project" "$@"

		if [ "$flag" = "-d" ]; then
			build_depend="" # dry run
		fi
		if [ "$cmd" = "build_project" ]; then
			# single-tree, so it can't be a target pointing
			# to a main source tree

			break
		fi
		if [ "$do_make" != "n" ]; then
			# if we're *downloading* a project, then
			# we don't need to to change the target.cfg 

			break
		fi
		if [ "${_tcfg%/*/target.cfg}" = "${_tcfg%"/$tree/target.cfg"}" ]
		then
			# we have found the main source tree that
			# a given target uses; no need to continue

			break
		else
			_tcfg="${_tcfg%/*/target.cfg}/$tree/target.cfg"
		fi

	done

	if [ "$XBMK_RELEASE" = "y" ] && [ "$release" = "n" ]; then
		return 1
	fi
	if [ -n "$buildtype" ] && [ "${mode%config}" != "$mode" ]; then
		return 1
	fi

	if [ -z "$mode" ]; then
		$if_not_dry_build \
			build_dependencies
	fi

	mdir="$xbmkpwd/config/submodule/$project"
	if [ -n "$tree" ]; then
		mdir="$mdir/$tree"
	fi

	if [ ! -f "CHANGELOG" ]; then
		delete_old_project_files
	fi
	if [ "$do_make" = "n" ]; then
		if [ ! -f "CHANGELOG" ]; then
			fetch_${cmd#build_}
		fi

		return 1
	fi

	x_ ./mk -f "$project" "$target"
}

# projects can specify which other projects
# to build first, as declared dependencies:

build_dependencies()
{
	for bd in $build_depend
	do
		bd_project="${bd%%/*}"
		bd_tree="${bd##*/}"

		if [ -z "$bd_project" ]; then
			$if_not_dry_build \
				err "$project/$tree: !bd '$bd'" \
				    "build_dependencies" "$@"
		fi
		if [ "${bd##*/}" = "$bd" ]; then
			bd_tree=""
		fi
		if [ -n "$bd_project" ]; then
			$if_not_dry_build \
				x_ ./mk -b $bd_project $bd_tree; :
		fi
	done; :
}

# delete_old_project_files along with project_up_to_date,
# concatenates the sha512sum hashes of all files related to
# a project, tree or target, then gets the sha512sum of that
# concatenation. this is checked against any existing
# calculation previously cached; if the result differs, or
# nothing was previously stored, we know to delete resources
# such as builds, project sources and so on, for auto-rebuild:

delete_old_project_files()
{
	# delete an entire source tree along with its builds:
	if ! project_up_to_date hash "$tree" badhash "$datadir" \
	    "$configdir/$tree" "$mdir"; then
		x_ rm -Rf "src/$project/$tree" "elf/$project/$tree"
	fi

	x_ cp "$xbtmp/new.hash" "$XBMK_CACHE/hash/$project$tree"

	if singletree "$project" || [ -z "$target" ] || [ "$target" = "$tree" ]
	then
		return 0
	fi

	# delete only the builds of a given target, but not src.
	# this is useful when only the target config changes, for
	# example x200_8mb coreboot configs change, but not coreboot:

	if ! project_up_to_date tghash "$target" badtghash "$configdir/$target"
	then
		x_ rm -Rf "elf/$project/$tree/$target"
	fi

	x_ cp "$xbtmp/new.hash" "$XBMK_CACHE/tghash/$project$target"
}

project_up_to_date()
{
	old_hash=""
	hash=""

	hashdir="$1"
	hashname="$2"
	badhashvar="$3"

	shift 3

	x_ mkdir -p "$XBMK_CACHE/$hashdir"

	if [ -f "$XBMK_CACHE/$hashdir/$project$hashname" ]; then
		read -r old_hash < "$XBMK_CACHE/$hashdir/$project$hashname" \
		    || err \
		    "$hashdir: err '$XBMK_CACHE/$hashdir/$project$hashname'" \
		    "project_up_to_date" "$hashdir" "$hashname" "$badhashvar" \
		    "$@"
	fi

	build_sbase
	fx_ "x_ util/sbase/sha512sum" find "$@" -type f -not -path \
	    "*/.git*/*" | awk '{print $1}' > "$xbtmp/tmp.hash" || \
	    err "!h $project $hashdir" \
	    "project_up_to_date" "$hashdir" "$hashname" "$badhashvar" "$@"

	hash="$(x_ "$sha512sum" "$xbtmp/tmp.hash" | awk '{print $1}' || \
	    err)" || err "$hashname: Can't read sha512 of '$xbtmp/tmp.hash'" \
	    "project_up_to_date" "$hashdir" "$hashname" "$badhashvar" "$@"

	if [ "$hash" != "$old_hash" ] || \
	    [ ! -f "$XBMK_CACHE/$hashdir/$project$hashname" ]; then
		eval "$badhashvar=\"y\""
	fi

	printf "%s\n" "$hash" > "$xbtmp/new.hash" || \
	    err "!mkhash $xbtmp/new.hash ($hashdir $hashname $badhashvar)" \
	    "project_up_to_date" "$hashdir" "$hashname" "$badhashvar" "$@"

	eval "[ \"\$$badhashvar\" = \"y\" ] && return 1"; :
}

check_cross_compiler()
{
	cbdir="src/coreboot/$tree"

	if [ "$project" != "coreboot" ]; then
		cbdir="src/coreboot/default"
	fi
	if [ -n "$xgcctree" ]; then
		cbdir="src/coreboot/$xgcctree"
	fi

	xfix="${1%-*}"

	if [ "$xfix" = "x86_64" ]; then
		xfix="x64"
	fi

	xgccfile="elf/coreboot/$tree/xgcc_${xfix}_was_compiled"
	xgccargs="crossgcc-$xfix UPDATED_SUBMODULES=1 CPUS=$XBMK_THREADS"

	x_ ./mk -f coreboot "${cbdir#src/coreboot/}"
	x_ mkdir -p "elf/coreboot/$tree" # TODO: is this needed?

	export PATH="$xbmkpwd/$cbdir/util/crossgcc/xgcc/bin:$PATH"
	export CROSS_COMPILE="${xarch% *}-"

	if [ -n "$xlang" ]; then
		export BUILD_LANGUAGES="$xlang"
	fi

	if [ -f "$xgccfile" ]; then
		# skip the build, because a build already exists:

		return 0
	fi

	check_gnu_path gcc gnat || x_ check_gnu_path gnat gcc
	make -C "$cbdir" $xgccargs || x_ make -C "$cbdir" $xgccargs

	# this tells subsequent runs that the build was already done:
	x_ touch "$xgccfile"

	# reset hostcc in PATH:
	remkdir "$xbtmp/gnupath"
}

# fix mismatching gcc/gnat versions on debian trixie/sid. as of december 2024,
# trixie/sid had gnat-13 as gnat and gcc-14 as gcc, but has gnat-14 in apt. in
# some cases, gcc 13+14 and gnat-13 are present; or gnat-14 and gcc-14, but
# gnat in PATH never resolves to gnat-14, because gnat-14 was "experimental"

check_gnu_path()
{
	if ! command -v "$1" 1>/dev/null; then
		err "Host '$1' unavailable" "check_gnu_path" "$@"
	fi

	gccver=""
	gccfull=""
	gnatver=""
	gnatfull=""
	gccdir=""
	gnatdir=""

	if host_gcc_gnat_match "$@"; then
		return 0
	fi

	if ! match_gcc_gnat_versions "$@"; then
		return 1
	fi
}

# check if gcc/gnat versions already match:

host_gcc_gnat_match()
{
	if ! gnu_setver "$1" "$1"; then
		err "Command '$1' unavailable." "check_gnu_path" "$@"
	fi
	gnu_setver "$2" "$2" || :

	eval "[ -z \"\$$1ver\" ] && err \"Cannot detect host '$1' version\""

	if [ "$gnatfull" != "$gccfull" ]; then
		# non-matching gcc/gnat versions

		return 1
	fi
}

# find all gcc/gnat versions, matching them up in PATH:

match_gcc_gnat_versions()
{
	eval "$1dir=\"$(dirname "$(command -v "$1")")\""
	eval "_gnudir=\"\$$1dir\""
	eval "_gnuver=\"\$$1ver\""

	for _bin in "$_gnudir/$2-"*
	do
		if [ "${_bin#"$_gnudir/$2-"}" = "$_gnuver" ] && [ -x "$_bin" ]
		then
			_gnuver="${_bin#"$_gnudir/$2-"}"
			break
		fi
	done

	if ! gnu_setver "$2" "$_gnudir/$2-$_gnuver"; then
		return 1
	elif [ "$gnatfull" != "$gccfull" ]; then
		return 1
	fi

	( link_gcc_gnat_versions "$@" "$_gnudir" "$_gnuver" ) || \
	    err "Can't link '$2-$_gnuver' '$_gnudir'" "check_gnu_path" "$@"; :
}

# create symlinks in PATH, so that the GCC/GNAT versions match:

link_gcc_gnat_versions()
{
	_gnudir="$3"
	_gnuver="$4"

	remkdir "$xbtmp/gnupath"

	x_ cd "$xbtmp/gnupath"

	for _gnubin in "$_gnudir/$2"*"-$_gnuver"
	do
		_gnuutil="${_gnubin##*/}"
		if [ -e "$_gnubin" ]; then
			x_ ln -s "$_gnubin" "${_gnuutil%"-$_gnuver"}"
		fi
	done
}

# get the gcc/gnat version
# fail: return 1 if util not found
gnu_setver()
{
	eval "$2 --version 1>/dev/null 2>/dev/null || return 1"

	eval "$1ver=\"`"$2" --version 2>/dev/null | head -n1`\""
	eval "$1ver=\"\${$1ver##* }\""
	eval "$1full=\"\$$1ver\""
	eval "$1ver=\"\${$1ver%%.*}\""; :
}

check_defconfig()
{
	if [ ! -f "$defconfig" ]; then
		$if_not_dry_build \
			err "$project/$target: no config" "check_defconfig" "$@"
	fi

	dest_dir="$elfdir/$tree/$target/${defconfig#"$target_dir/config/"}"

	# skip build if a previous one exists:

	if ! $if_not_dry_build elfcheck; then
		return 1
	fi
}

elfcheck()
{
	# TODO: *STILL* very hacky check. do it properly (based on build.list)

	( fx_ "eval exit 1 && err" find "$dest_dir" -type f ) || return 1; :
}

handle_makefile()
{
	if $if_not_dry_build check_makefile "$srcdir"; then
		$if_not_dry_build \
			x_ make -C "$srcdir" $cleanargs clean
	fi

	if [ -f "$defconfig" ]; then
		x_ cp "$defconfig" "$srcdir/.config"
	fi

	run_make_command || \
	    err "no makefile!" "handle_makefile" "$@"

	_copy=".config"

	if [ "$mode" = "savedefconfig" ]; then
		_copy="defconfig"
	fi

	if [ "${mode%config}" != "$mode" ]; then
		$if_not_dry_build \
			x_ cp "$srcdir/$_copy" "$defconfig"; :
	fi

	if [ -e "$srcdir/.git" ] && [ "$project" = "u-boot" ] && \
	    [ "$mode" = "distclean" ]; then
		$if_not_dry_build \
			x_ git -C "$srcdir" $cleanargs clean -fdx; :
	fi
}

run_make_command()
{
	if [ -z "$mode" ]; then
		x_ $premake
	fi

	if $if_not_dry_build check_cmake "$srcdir"; then
		if [ -z "$mode" ]; then
			$if_not_dry_build \
				check_autoconf "$srcdir"
		fi
	fi
	if ! $if_not_dry_build check_makefile "$srcdir"; then
		return 1
	fi

	$if_not_dry_build \
		x_ make -C "$srcdir" $mode -j$XBMK_THREADS $makeargs

	if [ -z "$mode" ]; then
		x_ $mkhelper
	fi

	if ! check_makefile "$srcdir"; then
		return 0
	fi

	if [ "$mode" = "clean" ]; then
		$if_not_dry_build \
			make -C "$srcdir" $cleanargs distclean || \
			$if_not_dry_build \
				x_ make -C "$srcdir" $cleanargs clean; :
	fi
}

check_cmake()
{
	if [ -n "$cmakedir" ]; then
		if ! $if_not_dry_build check_makefile "$1"; then
			if ! cmake -B "$1" "$1/$cmakedir"; then
				$if_not_dry_build \
					x_ check_makefile "$1"
			fi
		fi
		$if_not_dry_build \
			x_ check_makefile "$1"; :
	fi
}

check_autoconf()
{
	(
		x_ cd "$1"

		if [ -f "bootstrap" ]; then
			x_ ./bootstrap $bootstrapargs
		fi
		if [ -f "autogen.sh" ]; then
			x_ ./autogen.sh $autogenargs
		fi
		if [ -f "configure" ]; then
			x_ ./configure $autoconfargs; :
		fi

	) || err "can't bootstrap project: $1" "check_autoconf" "$@"; :
}

check_makefile()
{
	if [ ! -f "$1/Makefile" ] && [ ! -f "$1/makefile" ] && \
	    [ ! -f "$1/GNUmakefile" ]; then

		return 1
	fi
}

copy_elf()
{
	if [ -f "$listfile" ]; then
		x_ mkdir -p "$dest_dir"
	fi

	if [ -f "$listfile" ]; then
		while read -r f
		do
			if [ -f "$srcdir/$f" ]; then
				x_ cp "$srcdir/$f" "$dest_dir"
			fi

		done < "$listfile" || err \
		    "cannot read '$listfile'" "copy_elf" "$@"; :
	fi

	( x_ make clean -C "$srcdir" $cleanargs ) || \
	    err "can't make-clean '$srcdir'" "copy_elf" "$@"; :
}