Adding a secondary toolchain - Revision history

Mhatle: /* Further comments and information */

2013-05-21T22:59:10Z

Further comments and information

← Older revision		Revision as of 22:59, 21 May 2013
Line 353:		Line 353:

	== Further comments and information ==		== Further comments and information ==

			For questions, comments or bug reports please contact the author at markDOThatleATwindriverDOTcom, also be sure to CC the openembedded-devel mailing list.

	[[Category:Dev]]		[[Category:Dev]]
	[[Category:Layers]]		[[Category:Layers]]

Mhatle at 21:38, 8 January 2013

2013-01-08T21:38:43Z

← Older revision		Revision as of 21:38, 8 January 2013
Line 109:		Line 109:
	An example implementation has been created in the layer "meta-tc-example". The file format follows:		An example implementation has been created in the layer "meta-tc-example". The file format follows:

	meta-tc-example/		meta-tc-example/
	meta-tc-example/bin		meta-tc-example/bin
	meta-tc-example/bin/example-toolchain		meta-tc-example/bin/example-toolchain
	meta-tc-example/conf		meta-tc-example/conf
	meta-tc-example/conf/layer.conf		meta-tc-example/conf/layer.conf
	meta-tc-example/conf/tc-example.conf		meta-tc-example/conf/tc-example.conf
	meta-tc-example/conf/tc-example-blacklist.conf		meta-tc-example/conf/tc-example-blacklist.conf
	meta-tc-example/classes		meta-tc-example/classes
	meta-tc-example/classes/tc-secondary.bbclass		meta-tc-example/classes/tc-secondary.bbclass
	meta-tc-example/classes/tc-blacklist.bbclass		meta-tc-example/classes/tc-blacklist.bbclass

	The following example is available at: [http://gate.crashing.org/~fray/yocto/meta-tc-example.tar.bz2 meta-tc-example.tar.bz2]		The following example is available at: [http://gate.crashing.org/~fray/yocto/meta-tc-example.tar.bz2 meta-tc-example.tar.bz2]

PaulEggleton: Fix typo

2012-11-15T16:51:59Z

Fix typo

← Older revision		Revision as of 16:51, 15 November 2012
Line 1:		Line 1:
	== Background ==		== Background ==

	In OpenEmbedded-Core there in an included toolchain that is built up of GNU binutils, gcc, and eglibc. In addition related components such as gdb, cross-prelink, mklibs and others provider additional toolchain functionality. In this document we focus on explaining best practices for including an additional toolchain that is capable of assembling, compiling and linking code. This document does not cover replacing the existing toolchain or toolchain components with external elements.		In OpenEmbedded-Core there is an included toolchain that is built up of GNU binutils, gcc, and eglibc. In addition related components such as gdb, cross-prelink, mklibs and others provider additional toolchain functionality. In this document we focus on explaining best practices for including an additional toolchain that is capable of assembling, compiling and linking code. This document does not cover replacing the existing toolchain or toolchain components with external elements.

	Many companies have commercial / highly optimized toolchains for specific purposes, such as ICC from Intel, LLVM, ARM Ltd toolchains, etc.. In some cases, these highly optimized toolchains may result in better performance for some applications, however they are often not generally applicable as they can not compile all of the system software. So instead of replacing the included GNU toolchain, a mechanism for providing an alternative/secondary toolchain is desired.		Many companies have commercial / highly optimized toolchains for specific purposes, such as ICC from Intel, LLVM, ARM Ltd toolchains, etc.. In some cases, these highly optimized toolchains may result in better performance for some applications, however they are often not generally applicable as they can not compile all of the system software. So instead of replacing the included GNU toolchain, a mechanism for providing an alternative/secondary toolchain is desired.

Mhatle: /* Implementation Example */

2012-11-14T22:32:35Z

Implementation Example

← Older revision		Revision as of 22:32, 14 November 2012
Line 119:		Line 119:
	meta-tc-example/classes/tc-secondary.bbclass		meta-tc-example/classes/tc-secondary.bbclass
	meta-tc-example/classes/tc-blacklist.bbclass		meta-tc-example/classes/tc-blacklist.bbclass

			The following example is available at: [http://gate.crashing.org/~fray/yocto/meta-tc-example.tar.bz2 meta-tc-example.tar.bz2]

	=== conf/layer.conf ===		=== conf/layer.conf ===

Mhatle: /* classes/tc-secondary.bbclass */

2012-11-14T22:29:19Z

classes/tc-secondary.bbclass

Mhatle: /* classes/tc-secondary.bbclass */

2012-11-14T22:25:18Z

classes/tc-secondary.bbclass

← Older revision		Revision as of 22:25, 14 November 2012
Line 291:		Line 291:
	echo 'export NM="${NM_toolchain-${SECONDARYTC}}"' >> $script		echo 'export NM="${NM_toolchain-${SECONDARYTC}}"' >> $script
	fi		fi

	if [ '${CFLAGS_toolchain-${SECONDARYTC}}' != '${''CFLAGS_toolchain-${SECONDARYTC}}' ]; then		if [ '${CFLAGS_toolchain-${SECONDARYTC}}' != '${''CFLAGS_toolchain-${SECONDARYTC}}' ]; then
	echo 'export CFLAGS="${CFLAGS_toolchain-${SECONDARYTC}}"' >> $script		echo 'export CFLAGS="${CFLAGS_toolchain-${SECONDARYTC}}"' >> $script

Mhatle: /* classes/tc-secondary.bbclass */

2012-11-14T22:24:58Z

classes/tc-secondary.bbclass

← Older revision		Revision as of 22:24, 14 November 2012
Line 304:		Line 304:
	echo 'export CPPFLAGS="${CPPFLAGS_toolchain-${SECONDARYTC}}"' >> $script		echo 'export CPPFLAGS="${CPPFLAGS_toolchain-${SECONDARYTC}}"' >> $script
	fi		fi

	# Fixup any sysroot references		# Fixup any sysroot references
	sed -i -e "s:${STAGING_DIR_TARGET}:${SDKTARGETSYSROOT}:g" $script		sed -i -e "s:${STAGING_DIR_TARGET}:${SDKTARGETSYSROOT}:g" $script

	# All environment scripts require OECORE_NATIVE_SYSROOT		# All environment scripts require OECORE_NATIVE_SYSROOT
	echo 'export OECORE_NATIVE_SYSROOT="${SDKPATHNATIVE}"' >> $script		echo 'export OECORE_NATIVE_SYSROOT="${SDKPATHNATIVE}"' >> $script

Mhatle: /* classes/tc-secondary.bbclass */

2012-11-14T22:24:15Z

classes/tc-secondary.bbclass

← Older revision		Revision as of 22:24, 14 November 2012
Line 249:		Line 249:

	require conf/tc-${SECONDARYTC}.conf		require conf/tc-${SECONDARYTC}.conf

			The above code configures the basic overrides and loads the configuration file. There is one limitation to the above however. It will only load one secondary toolchain. A simple way around this is to rename the inherit and change to using something other then SECONDARYTC. This likely will not be a problem.

			toolchain_create_sdk_env_script_alt () {
			set -x

			# Create environment setup script (secondary toolchain)
			orig_script=${1:-${SDK_OUTPUT}/${SDKPATH}/environment-setup-${REAL_MULTIMACH_TARGET_SYS}}
			script="$orig_script""-${SECONDARYTC}"
			rm -f $script
			touch $script
			echo ". $orig_script" \| sed -e "s:${SDK_OUTPUT}::" >> $script
			if [ '${CC_toolchain-${SECONDARYTC}}' != '${''CC_toolchain-${SECONDARYTC}}' ]; then
			echo 'export CC="${CC_toolchain-${SECONDARYTC}}"' >> $script
			fi
			if [ '${CXX_toolchain-${SECONDARYTC}}' != '${''CXX_toolchain-${SECONDARYTC}}' ]; then
			echo 'export CXX="${CXX_toolchain-${SECONDARYTC}}"' >> $script
			fi
			if [ '${CPP_toolchain-${SECONDARYTC}}' != '${''CPP_toolchain-${SECONDARYTC}}' ]; then
			echo 'export CPP="${CPP_toolchain-${SECONDARYTC}}"' >> $script
			fi
			if [ '${AS_toolchain-${SECONDARYTC}}' != '${''AS_toolchain-${SECONDARYTC}}' ]; then
			echo 'export AS="${AS_toolchain-${SECONDARYTC}}"' >> $script
			fi
			if [ '${LD_toolchain-${SECONDARYTC}}' != '${''LD_toolchain-${SECONDARYTC}}' ]; then
			echo 'export LD="${LD_toolchain-${SECONDARYTC}}"' >> $script
			fi
			if [ '${RANLIB_toolchain-${SECONDARYTC}}' != '${''RANLIB_toolchain-${SECONDARYTC}}' ]; then
			echo 'export RANLIB="${RANLIB_toolchain-${SECONDARYTC}}"' >> $script
			fi
			if [ '${STRIP_toolchain-${SECONDARYTC}}' != '${''STRIP_toolchain-${SECONDARYTC}}' ]; then
			echo 'export STRIP="${STRIP_toolchain-${SECONDARYTC}}"' >> $script
			fi
			if [ '${OBJCOPY_toolchain-${SECONDARYTC}}' != '${''OBJCOPY_toolchain-${SECONDARYTC}}' ]; then
			echo 'export OBJCOPY="${OBJCOPY_toolchain-${SECONDARYTC}}"' >> $script
			fi
			if [ '${OBJDUMP_toolchain-${SECONDARYTC}}' != '${''OBJDUMP_toolchain-${SECONDARYTC}}' ]; then
			echo 'export OBJDUMP="${OBJDUMP_toolchain-${SECONDARYTC}}"' >> $script
			fi
			if [ '${NM_toolchain-${SECONDARYTC}}' != '${''NM_toolchain-${SECONDARYTC}}' ]; then
			echo 'export NM="${NM_toolchain-${SECONDARYTC}}"' >> $script
			fi

			if [ '${CFLAGS_toolchain-${SECONDARYTC}}' != '${''CFLAGS_toolchain-${SECONDARYTC}}' ]; then
			echo 'export CFLAGS="${CFLAGS_toolchain-${SECONDARYTC}}"' >> $script
			fi
			if [ '${CXXFLAGS_toolchain-${SECONDARYTC}}' != '${''CXXFLAGS_toolchain-${SECONDARYTC}}' ]; then
			echo 'export CXXFLAGS="${CXXFLAGS_toolchain-${SECONDARYTC}}"' >> $script
			fi
			if [ '${LDFLAGS_toolchain-${SECONDARYTC}}' != '${''LDFLAGS_toolchain-${SECONDARYTC}}' ]; then
			echo 'export LDFLAGS="${LDFLAGS_toolchain-${SECONDARYTC}}"' >> $script
			fi
			if [ '${CPPFLAGS_toolchain-${SECONDARYTC}}' != '${''CPPFLAGS_toolchain-${SECONDARYTC}}' ]; then
			echo 'export CPPFLAGS="${CPPFLAGS_toolchain-${SECONDARYTC}}"' >> $script
			fi

			# Fixup any sysroot references
			sed -i -e "s:${STAGING_DIR_TARGET}:${SDKTARGETSYSROOT}:g" $script

			# All environment scripts require OECORE_NATIVE_SYSROOT
			echo 'export OECORE_NATIVE_SYSROOT="${SDKPATHNATIVE}"' >> $script
			}

			populate_sdk_image_append() {
			toolchain_create_sdk_env_script_alt ${SDK_OUTPUT}/${SDKPATH}/environment-setup-${REAL_MULTIMACH_TARGET_SYS}
			}

			The above code will add an additional environment-setup-*-<toolchain> file. This can be used to enable the right environment to use the alternative toolchain. Note, it does not add anything to the path so the user will still need to configure the path to the alternative toolchain. (The layer creator can always provide the necessary 'nativesdk' or similar package that provides the alternative toolchain as part of the SDK as well.)

	=== classes/tc-blacklist.bbclass ===		=== classes/tc-blacklist.bbclass ===

Mhatle: /* SDK */

2012-11-14T22:19:17Z

SDK

← Older revision		Revision as of 22:19, 14 November 2012
Line 101:		Line 101:
	=== SDK ===		=== SDK ===

	~~TBD: Add~~ SDK ~~extension details~~		In order to make it easier to use the alternative toolchain within the SDK. An additional environment-* file should be created. The purpose of this file is to simply override the settings in the main environment file.

	~~Notes:~~		See the example section for an implementation that will create this file automatically.

	* need to add a custom toolchain_create_sdk_env_script for ~~the secondary toolchain(s) (supporting override).~~
	* need to support more then one secondary toolchain
	* populate_sdk_image_append -- define a python class to dump the secondary toolchain bits...

	== Implementation Example ==		== Implementation Example ==

Mhatle: /* Implementation Example */

2012-11-14T17:45:45Z

Implementation Example

← Older revision		Revision as of 17:45, 14 November 2012
Line 145:		Line 145:
	# Define the alternative toolchain		# Define the alternative toolchain
	SECONDARYTC = 'example'		SECONDARYTC = 'example'
	~~require ${LAYERDIR}/conf/tc-${SECONDARYTC}.conf~~
	~~include ${LAYERDIR}/conf/~~tc-~~${SECONDARYTC}~~-blacklist~~.conf~~		# Enable the secondary toolchain
			INHERIT += 'tc-secondary tc-blacklist'

	Define the alternative toolchain name in SECONDARYTC. ~~This is then used to bring in~~ the ~~two configuration files. The first~~ tc-~~example~~.~~conf is required, while the~~ tc~~-example~~-blacklist.~~conf is optional~~.		Define the alternative toolchain name in SECONDARYTC. The inherit causes the tc-secondary.bbclass and tc-blacklist.bbclass to be loaded later. Eventually this class used SECONDARYTC to load in the secondary toolchain configuration files.

	=== conf/tc-example.conf ===		=== conf/tc-example.conf ===

	~~# Enable the override:~~
	~~INHERIT += 'tc-secondary'~~

	~~This inherit is mandatory and adds the secondary toolchain control class. All secondary toolchains should contain the same class.~~

	# Define default system toolchain (default to built-in)		# Define default system toolchain (default to built-in)
Line 219:		Line 215:

	# Override values:		# Override values:
	~~export~~ CC_toolchain-example = "example-toolchain ${HOST_PREFIX}gcc ${HOST_CC_ARCH}${TOOLCHAIN_OPTIONS}"		CC_toolchain-example = "example-toolchain ${HOST_PREFIX}gcc ${HOST_CC_ARCH}${TOOLCHAIN_OPTIONS}"
	~~export~~ CXX_toolchain-example = "example-toolchain ${HOST_PREFIX}g++ ${HOST_CC_ARCH}${TOOLCHAIN_OPTIONS}"		CXX_toolchain-example = "example-toolchain ${HOST_PREFIX}g++ ${HOST_CC_ARCH}${TOOLCHAIN_OPTIONS}"
	~~export~~ CPP_toolchain-example = "example-toolchain ${HOST_PREFIX}gcc -E${TOOLCHAIN_OPTIONS} ${HOST_CC_ARCH}"		CPP_toolchain-example = "example-toolchain ${HOST_PREFIX}gcc -E${TOOLCHAIN_OPTIONS} ${HOST_CC_ARCH}"
	~~export~~ LD_toolchain-example = "example-toolchain ${HOST_PREFIX}ld${TOOLCHAIN_OPTIONS} ${HOST_LD_ARCH}"		LD_toolchain-example = "example-toolchain ${HOST_PREFIX}ld${TOOLCHAIN_OPTIONS} ${HOST_LD_ARCH}"

	The above implements the necessary overrides for the example toolchain.		The above implements the necessary overrides for the example toolchain.
Line 230:		Line 226:
	Example configuration file that enables the blacklist and defines the defaults.		Example configuration file that enables the blacklist and defines the defaults.

	~~INHERIT += 'tc-blacklist'~~

	# Blacklist certain items...		# Blacklist certain items...
	TCBLACKLIST[eglibc] = 'example'		TCBLACKLIST[eglibc] = 'example'
Line 257:		Line 251:
	OVERRIDES .= "${TOOLCHAINOVERRIDES}"		OVERRIDES .= "${TOOLCHAINOVERRIDES}"
	OVERRIDES[vardepsexclude] += "TOOLCHAINOVERRIDES"		OVERRIDES[vardepsexclude] += "TOOLCHAINOVERRIDES"

			require conf/tc-${SECONDARYTC}.conf

	=== classes/tc-blacklist.bbclass ===		=== classes/tc-blacklist.bbclass ===
Line 271:		Line 267:
	# TCBLACKLIST = 'toolchain'		# TCBLACKLIST = 'toolchain'
	# TCWHITELIST[pn] = 'toolchain'		# TCWHITELIST[pn] = 'toolchain'

			include conf/tc-${SECONDARYTC}-blacklist.conf

	python () {		python () {

← Older revision		Revision as of 22:29, 14 November 2012
Line 261:		Line 261:
	touch $script		touch $script
	echo ". $orig_script" \| sed -e "s:${SDK_OUTPUT}::" >> $script		echo ". $orig_script" \| sed -e "s:${SDK_OUTPUT}::" >> $script
	if [ '${CC_toolchain-${SECONDARYTC}}' != '${''CC_toolchain-${SECONDARYTC}}' ]; then		if [ '${CC_toolchain-${SECONDARYTC}}' != '${<nowiki>''</nowiki>CC_toolchain-${SECONDARYTC}}' ]; then
	echo 'export CC="${CC_toolchain-${SECONDARYTC}}"' >> $script		echo 'export CC="${CC_toolchain-${SECONDARYTC}}"' >> $script
	fi		fi
	if [ '${CXX_toolchain-${SECONDARYTC}}' != '${''CXX_toolchain-${SECONDARYTC}}' ]; then		if [ '${CXX_toolchain-${SECONDARYTC}}' != '${<nowiki>''</nowiki>CXX_toolchain-${SECONDARYTC}}' ]; then
	echo 'export CXX="${CXX_toolchain-${SECONDARYTC}}"' >> $script		echo 'export CXX="${CXX_toolchain-${SECONDARYTC}}"' >> $script
	fi		fi
	if [ '${CPP_toolchain-${SECONDARYTC}}' != '${''CPP_toolchain-${SECONDARYTC}}' ]; then		if [ '${CPP_toolchain-${SECONDARYTC}}' != '${<nowiki>''</nowiki>CPP_toolchain-${SECONDARYTC}}' ]; then
	echo 'export CPP="${CPP_toolchain-${SECONDARYTC}}"' >> $script		echo 'export CPP="${CPP_toolchain-${SECONDARYTC}}"' >> $script
	fi		fi
	if [ '${AS_toolchain-${SECONDARYTC}}' != '${''AS_toolchain-${SECONDARYTC}}' ]; then		if [ '${AS_toolchain-${SECONDARYTC}}' != '${<nowiki>''</nowiki>AS_toolchain-${SECONDARYTC}}' ]; then
	echo 'export AS="${AS_toolchain-${SECONDARYTC}}"' >> $script		echo 'export AS="${AS_toolchain-${SECONDARYTC}}"' >> $script
	fi		fi
	if [ '${LD_toolchain-${SECONDARYTC}}' != '${''LD_toolchain-${SECONDARYTC}}' ]; then		if [ '${LD_toolchain-${SECONDARYTC}}' != '${<nowiki>''</nowiki>LD_toolchain-${SECONDARYTC}}' ]; then
	echo 'export LD="${LD_toolchain-${SECONDARYTC}}"' >> $script		echo 'export LD="${LD_toolchain-${SECONDARYTC}}"' >> $script
	fi		fi
	if [ '${RANLIB_toolchain-${SECONDARYTC}}' != '${''RANLIB_toolchain-${SECONDARYTC}}' ]; then		if [ '${RANLIB_toolchain-${SECONDARYTC}}' != '${<nowiki>''</nowiki>RANLIB_toolchain-${SECONDARYTC}}' ]; then
	echo 'export RANLIB="${RANLIB_toolchain-${SECONDARYTC}}"' >> $script		echo 'export RANLIB="${RANLIB_toolchain-${SECONDARYTC}}"' >> $script
	fi		fi
	if [ '${STRIP_toolchain-${SECONDARYTC}}' != '${''STRIP_toolchain-${SECONDARYTC}}' ]; then		if [ '${STRIP_toolchain-${SECONDARYTC}}' != '${<nowiki>''</nowiki>STRIP_toolchain-${SECONDARYTC}}' ]; then
	echo 'export STRIP="${STRIP_toolchain-${SECONDARYTC}}"' >> $script		echo 'export STRIP="${STRIP_toolchain-${SECONDARYTC}}"' >> $script
	fi		fi
	if [ '${OBJCOPY_toolchain-${SECONDARYTC}}' != '${''OBJCOPY_toolchain-${SECONDARYTC}}' ]; then		if [ '${OBJCOPY_toolchain-${SECONDARYTC}}' != '${<nowiki>''</nowiki>OBJCOPY_toolchain-${SECONDARYTC}}' ]; then
	echo 'export OBJCOPY="${OBJCOPY_toolchain-${SECONDARYTC}}"' >> $script		echo 'export OBJCOPY="${OBJCOPY_toolchain-${SECONDARYTC}}"' >> $script
	fi		fi
	if [ '${OBJDUMP_toolchain-${SECONDARYTC}}' != '${''OBJDUMP_toolchain-${SECONDARYTC}}' ]; then		if [ '${OBJDUMP_toolchain-${SECONDARYTC}}' != '${<nowiki>''</nowiki>OBJDUMP_toolchain-${SECONDARYTC}}' ]; then
	echo 'export OBJDUMP="${OBJDUMP_toolchain-${SECONDARYTC}}"' >> $script		echo 'export OBJDUMP="${OBJDUMP_toolchain-${SECONDARYTC}}"' >> $script
	fi		fi
	if [ '${NM_toolchain-${SECONDARYTC}}' != '${''NM_toolchain-${SECONDARYTC}}' ]; then		if [ '${NM_toolchain-${SECONDARYTC}}' != '${<nowiki>''</nowiki>NM_toolchain-${SECONDARYTC}}' ]; then
	echo 'export NM="${NM_toolchain-${SECONDARYTC}}"' >> $script		echo 'export NM="${NM_toolchain-${SECONDARYTC}}"' >> $script
	fi		fi

	if [ '${CFLAGS_toolchain-${SECONDARYTC}}' != '${''CFLAGS_toolchain-${SECONDARYTC}}' ]; then		if [ '${CFLAGS_toolchain-${SECONDARYTC}}' != '${<nowiki>''</nowiki>CFLAGS_toolchain-${SECONDARYTC}}' ]; then
	echo 'export CFLAGS="${CFLAGS_toolchain-${SECONDARYTC}}"' >> $script		echo 'export CFLAGS="${CFLAGS_toolchain-${SECONDARYTC}}"' >> $script
	fi		fi
	if [ '${CXXFLAGS_toolchain-${SECONDARYTC}}' != '${''CXXFLAGS_toolchain-${SECONDARYTC}}' ]; then		if [ '${CXXFLAGS_toolchain-${SECONDARYTC}}' != '${<nowiki>''</nowiki>CXXFLAGS_toolchain-${SECONDARYTC}}' ]; then
	echo 'export CXXFLAGS="${CXXFLAGS_toolchain-${SECONDARYTC}}"' >> $script		echo 'export CXXFLAGS="${CXXFLAGS_toolchain-${SECONDARYTC}}"' >> $script
	fi		fi
	if [ '${LDFLAGS_toolchain-${SECONDARYTC}}' != '${''LDFLAGS_toolchain-${SECONDARYTC}}' ]; then		if [ '${LDFLAGS_toolchain-${SECONDARYTC}}' != '${<nowiki>''</nowiki>LDFLAGS_toolchain-${SECONDARYTC}}' ]; then
	echo 'export LDFLAGS="${LDFLAGS_toolchain-${SECONDARYTC}}"' >> $script		echo 'export LDFLAGS="${LDFLAGS_toolchain-${SECONDARYTC}}"' >> $script
	fi		fi
	if [ '${CPPFLAGS_toolchain-${SECONDARYTC}}' != '${''CPPFLAGS_toolchain-${SECONDARYTC}}' ]; then		if [ '${CPPFLAGS_toolchain-${SECONDARYTC}}' != '${<nowiki>''</nowiki>CPPFLAGS_toolchain-${SECONDARYTC}}' ]; then
	echo 'export CPPFLAGS="${CPPFLAGS_toolchain-${SECONDARYTC}}"' >> $script		echo 'export CPPFLAGS="${CPPFLAGS_toolchain-${SECONDARYTC}}"' >> $script
	fi		fi