build.sh - 3p/renode/renode - Git at Google

 #!/usr/bin/env bash

 set -u
 set -e

 export ROOT_PATH="$(cd $(dirname $0); echo $PWD)"
 OUTPUT_DIRECTORY="$ROOT_PATH/output"
 EXPORT_DIRECTORY=""

 UPDATE_SUBMODULES=false
 CONFIGURATION="Release"
 BUILD_PLATFORM="Any CPU"
 CLEAN=false
 PACKAGES=false
 NIGHTLY=false
 PORTABLE=false
 HEADLESS=false
 SKIP_FETCH=false
 NET=false
 TFM="net6.0"
 PARAMS=()
 CUSTOM_PROP=
 NET_FRAMEWORK_VER=
 RID="linux-x64"

 function print_help() {
   echo "Usage: $0 [-cdvspnt] [-b properties-file.csproj] [--no-gui] [--skip-fetch] [--profile-build]"
   echo ""
   echo "-c                                clean instead of building"
   echo "-d                                build Debug configuration"
   echo "-v                                verbose output"
   echo "-p                                create packages after building"
   echo "-n                                create nightly packages after building"
   echo "-t                                create a portable package (experimental, Linux only)"
   echo "-s                                update submodules"
   echo "-b                                custom build properties file"
   echo "-o                                custom output directory"
   echo "--skip-fetch                      skip fetching submodules and additional resources"
   echo "--no-gui                          build with GUI disabled"
   echo "--force-net-framework-version     build against different version of .NET Framework than specified in the solution"
   echo "--net                             build with dotnet"
   echo "-B                                bundle target runtime (default value: $RID, requires --net, -t)"
   echo "--profile-build                   build optimized for tlib profiling"
 }

 while getopts "cdvpnstb:o:B:-:" opt
 do
   case $opt in
     c)
       CLEAN=true
       ;;
     d)
       CONFIGURATION="Debug"
       ;;
     v)
       PARAMS+=(verbosity:detailed)
       ;;
     p)
       PACKAGES=true
       ;;
     n)
       NIGHTLY=true
       PACKAGES=true
       ;;
     t)
       PORTABLE=true
       ;;
     s)
       UPDATE_SUBMODULES=true
       ;;
     b)
       CUSTOM_PROP=$OPTARG
       ;;
     o)
       EXPORT_DIRECTORY=$OPTARG
       echo "Setting the output directory to $EXPORT_DIRECTORY"
       ;;
     B)
       RID=$OPTARG
       ;;
     -)
       case $OPTARG in
         "no-gui")
           HEADLESS=true
           ;;
         "skip-fetch")
           SKIP_FETCH=true
           ;;
         "force-net-framework-version")
           shift $((OPTIND-1))
           NET_FRAMEWORK_VER=p:TargetFrameworkVersion=v$1
           PARAMS+=($NET_FRAMEWORK_VER)
           OPTIND=2
           ;;
         "net")
           NET=true
           PARAMS+=(p:NET=true)
           ;;
         "profile-build")
           PARAMS+=('p:TlibProfilingBuild=true')
           ;;
         *)
           print_help
           exit 1
           ;;
       esac
       ;;
     \?)
       print_help
       exit 1
       ;;
   esac
 done
 shift "$((OPTIND-1))"

 if [ -n "${PLATFORM:-}" ]
 then
     echo "PLATFORM environment variable is currently set to: >>$PLATFORM<<"
     echo "This might cause problems during the build."
     echo "Please clear it with:"
     echo ""
     echo "    unset PLATFORM"
     echo ""
     echo " and run the build script again."

     exit 1
 fi

 # We can only update parts of this repository if Renode is built from within the git tree
 if [ ! -e .git ]
 then
   SKIP_FETCH=true
   UPDATE_SUBMODULES=false
 fi

 if $SKIP_FETCH
 then
   echo "Skipping init/update of submodules"
 else
   # Update submodules if not initialized or if requested by the user
   # Warn if not updating, but unclean
   # Disabling -e to allow grep to fail
   set +e
   git submodule status --recursive | grep -q "^-"
   SUBMODULES_NOT_INITED=$?

   git submodule status --recursive | grep -q "^+"
   SUBMODULES_NOT_CLEAN=$?
   set -e
   if $UPDATE_SUBMODULES || [ $SUBMODULES_NOT_INITED -eq 0 ]
   then
       echo "Updating submodules..."
       git submodule update --init --recursive
   elif [ $SUBMODULES_NOT_CLEAN -eq 0 ]
   then
       echo "Submodules are not updated. Use -s to force update."
   fi
 fi

 . "${ROOT_PATH}/tools/common.sh"

 if $SKIP_FETCH
 then
   echo "Skipping library fetch"
 else
   "${ROOT_PATH}"/tools/building/fetch_libraries.sh
 fi

 if $HEADLESS
 then
     BUILD_TARGET=Headless
     PARAMS+=(p:GUI_DISABLED=true)
 elif $ON_WINDOWS
 then
     BUILD_TARGET=Windows
     TFM="net6.0-windows10.0.17763.0"
 else
     BUILD_TARGET=Mono
 fi

 if $NET
 then
   CS_COMPILER="dotnet build"
   TARGET="`get_path \"$PWD/Renode_NET.sln\"`"
 else
   TARGET="`get_path \"$PWD/Renode.sln\"`"
 fi

 # Verify Mono and mcs version on Linux and macOS
 if ! $ON_WINDOWS && ! $NET
 then
     if ! [ -x "$(command -v mcs)" ]
     then
         MINIMUM_MONO=`get_min_mono_version`
         echo "mcs not found. Renode requries Mono $MINIMUM_MONO or newer. Please refer to documentation for installation instructions. Exiting!"
         exit 1
     fi

     verify_mono_version
 fi

 # Copy properties file according to the running OS
 mkdir -p "$OUTPUT_DIRECTORY"
 if [ -n "${CUSTOM_PROP}" ]; then
     PROP_FILE=$CUSTOM_PROP
 else
     if $ON_OSX
     then
       PROP_FILE="${CURRENT_PATH:=.}/src/Infrastructure/src/Emulator/Cores/osx-properties.csproj"
     elif $ON_LINUX
     then
       PROP_FILE="${CURRENT_PATH:=.}/src/Infrastructure/src/Emulator/Cores/linux-properties.csproj"
     else
       PROP_FILE="${CURRENT_PATH:=.}/src/Infrastructure/src/Emulator/Cores/windows-properties.csproj"
     fi
 fi
 cp "$PROP_FILE" "$OUTPUT_DIRECTORY/properties.csproj"

 if ! $NET
 then
   # Assets files are not deleted during `dotnet clean`, as it would confuse intellisense per comment in https://github.com/NuGet/Home/issues/7368#issuecomment-457411014,
   # but we need to delete them to build Renode again for .NETFramework since `project.assets.json` doesn't play well if project files share the same directory.
   # If `Renode_NET.sln` is picked for OmniSharp, it will trigger reanalysis of the project after removing assets files.
   # We don't remove these files as part of `clean` target, because other intermediate files are well separated between .NET and .NETFramework
   # and enforcing `clean` every time before rebuilding would slow down the build process on both frameworks.
   find $ROOT_PATH -type f -name 'project.assets.json' -delete
 fi

 # Build CCTask in Release configuration
 CCTASK_OUTPUT=`mktemp`
 CCTASK_BUILD_ARGS=($NET_FRAMEWORK_VER p:Configuration=Release p:Platform="\"$BUILD_PLATFORM\"")
 set +e
 CCTASK_SLN=CCTask.sln
 if $NET
 then
     CCTASK_SLN=CCTask_NET.sln
 fi
 eval "$CS_COMPILER $(build_args_helper "${CCTASK_BUILD_ARGS[@]}") $(get_path $ROOT_PATH/lib/cctask/$CCTASK_SLN)" 2>&1 > $CCTASK_OUTPUT

 if [ $? -ne 0 ]; then
     cat $CCTASK_OUTPUT
     rm $CCTASK_OUTPUT
     exit 1
 fi
 rm $CCTASK_OUTPUT
 set -e

 # clean instead of building
 if $CLEAN
 then
     if ! $NET
     then
       PARAMS+=(t:Clean)
     fi
     for conf in Debug Release
     do
       for build_target in Windows Mono Headless
       do
         if $NET
         then
             dotnet clean $(build_args_helper ${PARAMS[@]}) $(build_args_helper p:Configuration=${conf}${build_target}) "$TARGET"
         else
             $CS_COMPILER $(build_args_helper ${PARAMS[@]}) $(build_args_helper p:Configuration=${conf}${build_target}) "$TARGET"
         fi
       done
       rm -fr $OUTPUT_DIRECTORY/bin/$conf
     done
     exit 0
 fi

 # check weak implementations of core libraries
 pushd "$ROOT_PATH/tools/building" > /dev/null
 ./check_weak_implementations.sh
 popd > /dev/null

 PARAMS+=(p:Configuration=${CONFIGURATION}${BUILD_TARGET} p:GenerateFullPaths=true p:Platform="\"$BUILD_PLATFORM\"")

 # build
 eval "$CS_COMPILER $(build_args_helper "${PARAMS[@]}") $TARGET"

 # copy llvm library
 if $NET
 then
   cp src/Infrastructure/src/Emulator/Peripherals/bin/$CONFIGURATION/$TFM/libllvm-disas.* output/bin/$CONFIGURATION/$TFM
 else
   cp src/Infrastructure/src/Emulator/Peripherals/bin/$CONFIGURATION/libllvm-disas.* output/bin/$CONFIGURATION
 fi

 # build packages after successful compilation
 params=""

 if [ $CONFIGURATION == "Debug" ]
 then
     params="$params -d"
 fi

 if [ -n "$EXPORT_DIRECTORY" ]
 then
     if [ "${DETECTED_OS}" != "linux" ]
     then
         echo "Custom output directory is currently available on Linux only"
         exit 1
     fi

     $ROOT_PATH/tools/packaging/export_${DETECTED_OS}_workdir.sh $EXPORT_DIRECTORY $params
     echo "Renode built to $EXPORT_DIRECTORY"
 fi

 if $PACKAGES && $NIGHTLY
 then
     params="$params -n"
 fi

 if $PACKAGES
 then
     if $NET
     then
         # Restore dependecies for linux-x64 runtime. It prevents error NETSDK1112 during publish.
         dotnet restore --runtime linux-x64 Renode_NET.sln

         eval "dotnet publish -f $TFM --self-contained false $(build_args_helper "${PARAMS[@]}") $TARGET"
         export RID TFM
         $ROOT_PATH/tools/packaging/make_linux_dotnet_package.sh $params
     else
         $ROOT_PATH/tools/packaging/make_${DETECTED_OS}_packages.sh $params
         $ROOT_PATH/tools/packaging/make_source_package.sh $params
     fi
 fi

 if $PORTABLE
 then
     PARAMS+=(p:PORTABLE=true)
     if $ON_LINUX
     then
       if $NET
       then
           eval "dotnet publish -r $RID -f $TFM --self-contained true $(build_args_helper "${PARAMS[@]}") $TARGET"
           export RID TFM
           $ROOT_PATH/tools/packaging/make_linux_portable_dotnet.sh $params
       else
           $ROOT_PATH/tools/packaging/make_linux_portable.sh $params
       fi
     else
       echo "Portable packages are only available on Linux. Exiting!"
       exit 1
     fi
 fi
	#!/usr/bin/env bash

	set -u
	set -e

	export ROOT_PATH="$(cd $(dirname $0); echo $PWD)"
	OUTPUT_DIRECTORY="$ROOT_PATH/output"
	EXPORT_DIRECTORY=""

	UPDATE_SUBMODULES=false
	CONFIGURATION="Release"
	BUILD_PLATFORM="Any CPU"
	CLEAN=false
	PACKAGES=false
	NIGHTLY=false
	PORTABLE=false
	HEADLESS=false
	SKIP_FETCH=false
	NET=false
	TFM="net6.0"
	PARAMS=()
	CUSTOM_PROP=
	NET_FRAMEWORK_VER=
	RID="linux-x64"

	function print_help() {
	echo "Usage: $0 [-cdvspnt] [-b properties-file.csproj] [--no-gui] [--skip-fetch] [--profile-build]"
	echo ""
	echo "-c clean instead of building"
	echo "-d build Debug configuration"
	echo "-v verbose output"
	echo "-p create packages after building"
	echo "-n create nightly packages after building"
	echo "-t create a portable package (experimental, Linux only)"
	echo "-s update submodules"
	echo "-b custom build properties file"
	echo "-o custom output directory"
	echo "--skip-fetch skip fetching submodules and additional resources"
	echo "--no-gui build with GUI disabled"
	echo "--force-net-framework-version build against different version of .NET Framework than specified in the solution"
	echo "--net build with dotnet"
	echo "-B bundle target runtime (default value: $RID, requires --net, -t)"
	echo "--profile-build build optimized for tlib profiling"
	}

	while getopts "cdvpnstb:o:B:-:" opt
	do
	case $opt in
	c)
	CLEAN=true
	;;
	d)
	CONFIGURATION="Debug"
	;;
	v)
	PARAMS+=(verbosity:detailed)
	;;
	p)
	PACKAGES=true
	;;
	n)
	NIGHTLY=true
	PACKAGES=true
	;;
	t)
	PORTABLE=true
	;;
	s)
	UPDATE_SUBMODULES=true
	;;
	b)
	CUSTOM_PROP=$OPTARG
	;;
	o)
	EXPORT_DIRECTORY=$OPTARG
	echo "Setting the output directory to $EXPORT_DIRECTORY"
	;;
	B)
	RID=$OPTARG
	;;
	-)
	case $OPTARG in
	"no-gui")
	HEADLESS=true
	;;
	"skip-fetch")
	SKIP_FETCH=true
	;;
	"force-net-framework-version")
	shift $((OPTIND-1))
	NET_FRAMEWORK_VER=p:TargetFrameworkVersion=v$1
	PARAMS+=($NET_FRAMEWORK_VER)
	OPTIND=2
	;;
	"net")
	NET=true
	PARAMS+=(p:NET=true)
	;;
	"profile-build")
	PARAMS+=('p:TlibProfilingBuild=true')
	;;
	*)
	print_help
	exit 1
	;;
	esac
	;;
	\?)
	print_help
	exit 1
	;;
	esac
	done
	shift "$((OPTIND-1))"

	if [ -n "${PLATFORM:-}" ]
	then
	echo "PLATFORM environment variable is currently set to: >>$PLATFORM<<"
	echo "This might cause problems during the build."
	echo "Please clear it with:"
	echo ""
	echo " unset PLATFORM"
	echo ""
	echo " and run the build script again."

	exit 1
	fi

	# We can only update parts of this repository if Renode is built from within the git tree
	if [ ! -e .git ]
	then
	SKIP_FETCH=true
	UPDATE_SUBMODULES=false
	fi

	if $SKIP_FETCH
	then
	echo "Skipping init/update of submodules"
	else
	# Update submodules if not initialized or if requested by the user
	# Warn if not updating, but unclean
	# Disabling -e to allow grep to fail
	set +e
	git submodule status --recursive \| grep -q "^-"
	SUBMODULES_NOT_INITED=$?

	git submodule status --recursive \| grep -q "^+"
	SUBMODULES_NOT_CLEAN=$?
	set -e
	if $UPDATE_SUBMODULES \|\| [ $SUBMODULES_NOT_INITED -eq 0 ]
	then
	echo "Updating submodules..."
	git submodule update --init --recursive
	elif [ $SUBMODULES_NOT_CLEAN -eq 0 ]
	then
	echo "Submodules are not updated. Use -s to force update."
	fi
	fi

	. "${ROOT_PATH}/tools/common.sh"

	if $SKIP_FETCH
	then
	echo "Skipping library fetch"
	else
	"${ROOT_PATH}"/tools/building/fetch_libraries.sh
	fi

	if $HEADLESS
	then
	BUILD_TARGET=Headless
	PARAMS+=(p:GUI_DISABLED=true)
	elif $ON_WINDOWS
	then
	BUILD_TARGET=Windows
	TFM="net6.0-windows10.0.17763.0"
	else
	BUILD_TARGET=Mono
	fi

	if $NET
	then
	CS_COMPILER="dotnet build"
	TARGET="`get_path \"$PWD/Renode_NET.sln\"`"
	else
	TARGET="`get_path \"$PWD/Renode.sln\"`"
	fi

	# Verify Mono and mcs version on Linux and macOS
	if ! $ON_WINDOWS && ! $NET
	then
	if ! [ -x "$(command -v mcs)" ]
	then
	MINIMUM_MONO=`get_min_mono_version`
	echo "mcs not found. Renode requries Mono $MINIMUM_MONO or newer. Please refer to documentation for installation instructions. Exiting!"
	exit 1
	fi

	verify_mono_version
	fi

	# Copy properties file according to the running OS
	mkdir -p "$OUTPUT_DIRECTORY"
	if [ -n "${CUSTOM_PROP}" ]; then
	PROP_FILE=$CUSTOM_PROP
	else
	if $ON_OSX
	then
	PROP_FILE="${CURRENT_PATH:=.}/src/Infrastructure/src/Emulator/Cores/osx-properties.csproj"
	elif $ON_LINUX
	then
	PROP_FILE="${CURRENT_PATH:=.}/src/Infrastructure/src/Emulator/Cores/linux-properties.csproj"
	else
	PROP_FILE="${CURRENT_PATH:=.}/src/Infrastructure/src/Emulator/Cores/windows-properties.csproj"
	fi
	fi
	cp "$PROP_FILE" "$OUTPUT_DIRECTORY/properties.csproj"

	if ! $NET
	then
	# Assets files are not deleted during `dotnet clean`, as it would confuse intellisense per comment in https://github.com/NuGet/Home/issues/7368#issuecomment-457411014,
	# but we need to delete them to build Renode again for .NETFramework since `project.assets.json` doesn't play well if project files share the same directory.
	# If `Renode_NET.sln` is picked for OmniSharp, it will trigger reanalysis of the project after removing assets files.
	# We don't remove these files as part of `clean` target, because other intermediate files are well separated between .NET and .NETFramework
	# and enforcing `clean` every time before rebuilding would slow down the build process on both frameworks.
	find $ROOT_PATH -type f -name 'project.assets.json' -delete
	fi

	# Build CCTask in Release configuration
	CCTASK_OUTPUT=`mktemp`
	CCTASK_BUILD_ARGS=($NET_FRAMEWORK_VER p:Configuration=Release p:Platform="\"$BUILD_PLATFORM\"")
	set +e
	CCTASK_SLN=CCTask.sln
	if $NET
	then
	CCTASK_SLN=CCTask_NET.sln
	fi
	eval "$CS_COMPILER $(build_args_helper "${CCTASK_BUILD_ARGS[@]}") $(get_path $ROOT_PATH/lib/cctask/$CCTASK_SLN)" 2>&1 > $CCTASK_OUTPUT

	if [ $? -ne 0 ]; then
	cat $CCTASK_OUTPUT
	rm $CCTASK_OUTPUT
	exit 1
	fi
	rm $CCTASK_OUTPUT
	set -e

	# clean instead of building
	if $CLEAN
	then
	if ! $NET
	then
	PARAMS+=(t:Clean)
	fi
	for conf in Debug Release
	do
	for build_target in Windows Mono Headless
	do
	if $NET
	then
	dotnet clean $(build_args_helper ${PARAMS[@]}) $(build_args_helper p:Configuration=${conf}${build_target}) "$TARGET"
	else
	$CS_COMPILER $(build_args_helper ${PARAMS[@]}) $(build_args_helper p:Configuration=${conf}${build_target}) "$TARGET"
	fi
	done
	rm -fr $OUTPUT_DIRECTORY/bin/$conf
	done
	exit 0
	fi

	# check weak implementations of core libraries
	pushd "$ROOT_PATH/tools/building" > /dev/null
	./check_weak_implementations.sh
	popd > /dev/null

	PARAMS+=(p:Configuration=${CONFIGURATION}${BUILD_TARGET} p:GenerateFullPaths=true p:Platform="\"$BUILD_PLATFORM\"")

	# build
	eval "$CS_COMPILER $(build_args_helper "${PARAMS[@]}") $TARGET"

	# copy llvm library
	if $NET
	then
	cp src/Infrastructure/src/Emulator/Peripherals/bin/$CONFIGURATION/$TFM/libllvm-disas.* output/bin/$CONFIGURATION/$TFM
	else
	cp src/Infrastructure/src/Emulator/Peripherals/bin/$CONFIGURATION/libllvm-disas.* output/bin/$CONFIGURATION
	fi

	# build packages after successful compilation
	params=""

	if [ $CONFIGURATION == "Debug" ]
	then
	params="$params -d"
	fi

	if [ -n "$EXPORT_DIRECTORY" ]
	then
	if [ "${DETECTED_OS}" != "linux" ]
	then
	echo "Custom output directory is currently available on Linux only"
	exit 1
	fi

	$ROOT_PATH/tools/packaging/export_${DETECTED_OS}_workdir.sh $EXPORT_DIRECTORY $params
	echo "Renode built to $EXPORT_DIRECTORY"
	fi

	if $PACKAGES && $NIGHTLY
	then
	params="$params -n"
	fi

	if $PACKAGES
	then
	if $NET
	then
	# Restore dependecies for linux-x64 runtime. It prevents error NETSDK1112 during publish.
	dotnet restore --runtime linux-x64 Renode_NET.sln

	eval "dotnet publish -f $TFM --self-contained false $(build_args_helper "${PARAMS[@]}") $TARGET"
	export RID TFM
	$ROOT_PATH/tools/packaging/make_linux_dotnet_package.sh $params
	else
	$ROOT_PATH/tools/packaging/make_${DETECTED_OS}_packages.sh $params
	$ROOT_PATH/tools/packaging/make_source_package.sh $params
	fi
	fi

	if $PORTABLE
	then
	PARAMS+=(p:PORTABLE=true)
	if $ON_LINUX
	then
	if $NET
	then
	eval "dotnet publish -r $RID -f $TFM --self-contained true $(build_args_helper "${PARAMS[@]}") $TARGET"
	export RID TFM
	$ROOT_PATH/tools/packaging/make_linux_portable_dotnet.sh $params
	else
	$ROOT_PATH/tools/packaging/make_linux_portable.sh $params
	fi
	else
	echo "Portable packages are only available on Linux. Exiting!"
	exit 1
	fi
	fi