package_core.sh

#!/bin/bash

# Copyright ARDUINO SRL (https://www.arduino.cc)
# SPDX-License-Identifier: Apache-2.0

# Package the core into a distributable tar.bz2 archive.

set -e
RET=0

if [ -z "$1" ]; then
	echo "Usage: $0 ARTIFACT VERSION [OUTPUT_FILE]"
	exit 1
fi

if [ ! -f platform.txt ]; then
	echo "Launch this script from the root core folder."
	exit 2
fi

ARTIFACT=$1
VERSION=$2
OUTPUT_FILE=${3:-distrib/${ARTIFACT}-${VERSION}.tar.bz2}

log_msg() {
	if [ -n $GITHUB_WORKSPACE ] ; then
		echo "::$1::$2"
	else
		echo "$2"
	fi
}

# we use variants for include because we filter on file paths
# and boards for exclude because we want to remove matching lines in boards.txt
BOARD_DETAILS=$(extra/get_board_details.sh)
if [ $ARTIFACT == "zephyr" ] ; then
	INCLUDED_VARIANTS=$(echo ${BOARD_DETAILS} | jq -cr ".[].variant")
	EXCLUDED_BOARDS=""
elif [ ! -f extra/artifacts/${ARTIFACT}.json ]; then
	echo "Unknown artifact '$ARTIFACT'."
	exit 3
else
	ARTIFACT_NAME="$(grep '"name"' extra/artifacts/${ARTIFACT}.json | head -n 1 | cut -d '"' -f 4) (${VERSION})"
	INCLUDED_VARIANTS=$(echo ${BOARD_DETAILS} | jq -cr "map(select(.artifact == \"$ARTIFACT\")) | .[].variant")
	EXCLUDED_BOARDS=$(echo ${BOARD_DETAILS} | jq -cr "map(select(.artifact != \"$ARTIFACT\")) | .[].board")
fi

log_msg group "Packaging ${ARTIFACT_NAME:-all variants} ($(basename $OUTPUT_FILE))"

# create a temporary boards.txt file with the correct list of boards
TEMP_BOARDS=$(mktemp -p . | sed 's/\.\///')
cat boards.txt >> $TEMP_BOARDS
for board in $EXCLUDED_BOARDS ; do
	# remove (even commented) lines for excluded boards
	sed -i "/^\(\s*#\s*\)\?${board}\./d" $TEMP_BOARDS
done
# set proper maximum sizes for included variants
# and test that the load address matches the build 
for variant in $INCLUDED_VARIANTS ; do
	board=$(echo ${BOARD_DETAILS} | jq -cr "map(select(.variant == \"${variant}\")) | .[0].board")
	# maximum sketch size: size of sketch partition (exact limit)
	# maximum data size: configured LLEXT heap size (larger bound, real limit is smaller)
	CODE_SIZE=$(( $(cat variants/${variant}/syms-static.ld | grep '\<_sketch_max_size\>' | cut -d '=' -f 2 | tr -d ');') ))
	DATA_SIZE=$(( 1024*$(cat firmwares/zephyr-${variant}.config | grep 'LLEXT_HEAP_SIZE' | cut -d '=' -f 2) ))
	sed -i -e "s/^${board}\.upload\.maximum_size=.*/${board}.upload.maximum_size=${CODE_SIZE}/" $TEMP_BOARDS
	sed -i -e "s/^${board}\.upload\.maximum_data_size=.*/${board}.upload.maximum_data_size=${DATA_SIZE}/" $TEMP_BOARDS

	# load address: must match the one used in the linker script
	CODE_ADDR=$(cat variants/${variant}/syms-static.ld | grep '\<_sketch_load_addr\>' | cut -d '=' -f 2 | tr -d ');')
	BOARDS_ADDR=$(grep "/^${board}\.upload\.address=.*/" $TEMP_BOARDS | cut -d '=' -f 2)
	if [ "${CODE_ADDR,,}" != "${BOARDS_ADDR,,}" ] ; then
		log_msg error "boards.txt: '${board}.upload.address' should be ${CODE_ADDR,,}"
		RET=3
	fi
done
# remove multiple empty lines
sed -i '/^$/N;/^\n$/D' $TEMP_BOARDS

# create a temporary platform.txt file with the correct version
TEMP_PLATFORM=$(mktemp -p . | sed 's/\.\///')
cat platform.txt > ${TEMP_PLATFORM}
[ -z "$ARTIFACT_NAME" ] || sed -ie "s/^name=.*/name=${ARTIFACT_NAME}/" ${TEMP_PLATFORM}
sed -i -e "s/^version=.*/version=$(extra/get_core_version.sh)/" ${TEMP_PLATFORM}

declutter_file() {
	# remove comments, whitespace at EOL, '/' dir terminators and empty lines
	[ -f "$1" ] || return 0
	cat "$1" | sed -e 's/\s*#.*//' -e 's/\s*$//' -e 's/\/$//' | grep -v '^\s*$'
}

# create the list of files and directories to include
TEMP_INC=$(mktemp -p . | sed 's/\.\///')
echo ${TEMP_BOARDS} >> ${TEMP_INC}
echo ${TEMP_PLATFORM} >> ${TEMP_INC}
declutter_file extra/artifacts/_common.inc >> ${TEMP_INC}
declutter_file extra/artifacts/$ARTIFACT.inc >> ${TEMP_INC}
declutter_file extra/artifacts/$ARTIFACT.only >> ${TEMP_INC}
for variant in $INCLUDED_VARIANTS ; do
	echo "- ${variant}"
	echo "variants/${variant}/" >> ${TEMP_INC}
	# add the firmwares, if some are missing notify at end
	if ! ls firmwares/zephyr-${variant}.* >> ${TEMP_INC} ; then
		log_msg error "No firmware for '${variant}' found."
		RET=3
	fi
done

# create the list of files and directories to exclude
TEMP_EXC=$(mktemp -p . | sed 's/\.\///')
declutter_file extra/artifacts/_common.exc >> ${TEMP_EXC}
declutter_file extra/artifacts/$ARTIFACT.exc >> ${TEMP_EXC}
for f in $(ls extra/artifacts/*.only | grep -v "$ARTIFACT.only") ; do
	declutter_file $f >> ${TEMP_EXC}
done

mkdir -p $(dirname ${OUTPUT_FILE})
tar -cjhf ${OUTPUT_FILE} -X ${TEMP_EXC} -T ${TEMP_INC} \
	--transform "s,zephyr/blobs/ArduinoCore-API,cores/arduino," \
	--transform "s,${TEMP_BOARDS},boards.txt," \
	--transform "s,${TEMP_PLATFORM},platform.txt," \
	--transform "s,^,ArduinoCore-zephyr/,"
rm -f ${TEMP_INC} ${TEMP_EXC} ${TEMP_BOARDS} ${TEMP_PLATFORM}

log_msg endgroup

exit $RET