TipsAndTricks/Packaging Prebuilt Libraries - Revision history

Michael Opdenacker: Keeping only link to official docs

2022-02-04T07:17:43Z

Keeping only link to official docs

← Older revision		Revision as of 07:17, 4 February 2022
Line 1:		Line 1:
	~~Back to [[TipsAndTricks]]~~

	See https://docs.yoctoproject.org/dev-manual/common-tasks.html#working-with-pre-built-libraries		See https://docs.yoctoproject.org/dev-manual/common-tasks.html#working-with-pre-built-libraries

	~~== Versioned Libraries ==~~
	~~In this example we work with libraries for the FT4222 USB I/O chip. Libraries are built for x86 32 and 64bit architectures and packaged in zip file as follows.~~
	~~<pre>~~
	~~├── build-arm-v6-hf~~
	~~│ └── libft4222.so.1.2.1.35~~
	~~├── build-i386~~
	~~│ └── libft4222.so.1.2.1.35~~
	~~├── build-x86_64~~
	~~│ └── libft4222.so.1.2.1.35~~
	~~├── ftd2xx.h~~
	~~├── libft4222.h~~
	~~└── WinTypes.h~~
	~~</pre>~~
	~~The key steps are as follows~~
	* The vendor will have licence so add a licence flag
	* Vendor provides a tarball containing libraries so set <tt>SRC_URI</tt> appropriately.
	* Set COMPATIBLE_HOST so that recipe cannot be be used with an unsupported architectures. In this example we only support x86 architecture in 32 and 64bit variants.
	* We installing, use the TRANSLATED_TARGET_ARCH override to set source directory within tarball (ARCH_DIR) appropriately.
	* As vendor provides versioned libraries, we can use <tt>so_oeinstall</tt> to install shared library and creates symbolic links. If vendor does not do this we need to follow the non-versioned library guidelines below
	* As the vendor likely used the different LDFLAGS from your Yocto build, disable checking by adding <tt>ldflags</tt> to <tt>INSANE_SKIP</tt>
	* The vendor will typically ship release builds without debug symbols. Avoid errors by preventing the packaging task from stripping out the symbols and adding them to a separate debug package. This is done by setting the 'INHIBIT' flags shown below..

	~~Complete recipe would look like this.~~

	~~<pre>~~
	~~SUMMARY = "FTDI FT4222 Library"~~
	~~SECTION = "libs"~~
	~~LICENSE_FLAGS = "ftdi"~~
	~~LICENSE = "CLOSED"~~

	~~COMPATIBLE_HOST = "(i.86\|x86_64).*-linux"~~

	~~# BUILD_NUMBER is set to build number of libft4222 release tarball~~
	~~BUILD_NUMBER = "35"~~
	~~# Set SRC_URI subdir to ${P} so that files are unpacked into ${S}~~
	~~SRC_URI = "http://www.ftdichip.com/Support/SoftwareExamples/${P}.${BUILD_NUMBER}.tgz;subdir=${P}"~~
	~~SRC_URI[md5sum] = "c5bc189fb5b167daf662ff81c66cde55"~~
	~~SRC_URI[sha256sum] = "df03e50f4a205474eaacadcdb59dc602237e95d48008ede8fc2d1f2493e54845"~~

	~~ARCH_DIR_x86-64 = "build-x86_64"~~
	~~ARCH_DIR_i586 = "build-i386"~~
	~~ARCH_DIR_i686 = "build-i386"~~

	~~INSANE_SKIP:${PN} = "ldflags"~~
	~~INHIBIT_PACKAGE_STRIP = "1"~~
	~~INHIBIT_SYSROOT_STRIP = "1"~~
	~~INHIBIT_PACKAGE_DEBUG_SPLIT = "1"~~

	~~do_install () {~~
	~~install -m 0755 -d ${D}${libdir}~~
	~~oe_soinstall ${S}/${ARCH_DIR}/libft4222.so.${PV}.${BUILD_NUMBER} ${D}${libdir}~~
	~~install -d ${D}${includedir}~~
	~~install -m 0755 ${S}/*.h ${D}${includedir}~~
	}
	~~</pre>~~

	If the precompiled binaries are not statically linked and have dependencies on other libraries, then by adding those libraries to DEPENDS the linking can be examined and the appropriate RDEPENDS automatically added.

	~~== Non-versioned Libraries ==~~
	~~=== Some Background ===~~
	Libraries in Linux systems are generally versioned so that it is possible to have multiple versions of the same library installed, which eases upgrades and support for older software. For example, suppose that in a versioned library an actual library is called "libfoo.so.1.2", a symbolic link named "libfoo.so.1" points to "libfoo.so.1.2", and a symbolic link named "libfoo.so" points to "libfoo.so.1.2". Given these conditions, when you link a binary against a library, you typically provide the unversioned file name (i.e. -lfoo to the linker). However, the linker follows the symbolic link and actually links against the versioned filename. The unversioned symbolic link is only used at development time. Consequently, the library is packaged along with the headers in the development package ${PN}-dev along with the actual library and versioned symbolic links in ${PN}. Because versioned libraries are far more common than unversioned libraries, the default packaging rules assume versioned libraries.

	~~=== Yocto Packaging Overview ===~~
	It follows that packaging an unversioned library requires a bit of work in the recipe. By default, "libfoo.so" gets packaged into ${PN}-dev, which triggers a QA warning that a non-symlink library is in a -dev package, and binaries in the same recipe link to the library in ${PN}-dev, which triggers more QA warnings. To solve this problem, you need to package the unversioned library into ${PN} where it belongs. Following are the abridged default FILES variables in bitbake.conf:

	~~SOLIBS = ".so.*"~~
	~~SOLIBSDEV = ".so"~~
	~~FILES_${PN} = "... ${libdir}/lib*${SOLIBS} ..."~~
	~~FILES_SOLIBSDEV ?= "... ${libdir}/lib*${SOLIBSDEV} ..."~~
	~~FILES_${PN}-dev = "... ${FILES_SOLIBSDEV} ..."~~

	SOLIBS defines a pattern that matches real shared object libraries. SOLIBSDEV matches the development form (unversioned symlink). These two variables are then used in FILES_${PN} and FILES_${PN}-dev, which puts the real libraries into ${PN} and the unversioned symbolic link into PN-dev. To package unversioned libraries, you need to modify the variables in the recipe as follows:

	~~SOLIBS = ".so"~~
	~~FILES_SOLIBSDEV = ""~~

	The modifications cause .so to be the real library and unsets FILES_SOLIBSDEV so that no libraries get packaged into PN-dev. The changes are required because unless PACKAGES is changed, PN-dev collects files before PN. PN-dev must not collect any of the files you want in PN.

	Finally, loadable modules (i.e. essentially unversioned libraries that are linked at runtime using dlopen() instead of at build time) should generally be installed in a private directory. However, if they are installed in ${libdir}, then the modules can be treated as unversioned libraries.

	~~=== Example ===~~
	The example below installs an unversioned x86-64 pre-built library libfoo.so. The COMPATIBLE_HOST limits recipes to x86-64 architecture while INSANE_SKIP, INHIBIT_PACKAGE_STRIP and INHIBIT_SYSROOT_STRIP variables are all set as for the versioned example above. The "magic" is setting the SOLIBS and FILES_SOLIBSDEV variables are explained above.

	~~<pre>~~
	~~SUMMARY = "libfoo sample recipe"~~
	~~SECTION = "libs"~~
	~~LICENSE = "CLOSED"~~

	~~SRC_URI = "file://libfoo.so"~~

	~~COMPATIBLE_HOST = "x86_64.*-linux"~~

	~~INSANE_SKIP_${PN} = "ldflags"~~
	~~INHIBIT_PACKAGE_STRIP = "1"~~
	~~INHIBIT_SYSROOT_STRIP = "1"~~
	~~SOLIBS = ".so"~~
	~~FILES_SOLIBSDEV = ""~~

	~~do_install () {~~
	~~install -d ${D}${libdir}~~
	~~install -m 0755 ${WORKDIR}/libfoo.so ${D}${libdir}~~
	}

	~~</pre>~~

Michael Opdenacker: Contents integrated in the official docs; add corresponding link

2022-02-04T07:17:04Z

Contents integrated in the official docs; add corresponding link

← Older revision		Revision as of 07:17, 4 February 2022
Line 1:		Line 1:
	Back to [[TipsAndTricks]]		Back to [[TipsAndTricks]]

	~~== Introduction ==~~		See https://docs.yoctoproject.org/dev-manual/common-tasks.html#working-with-pre-built-libraries
	~~Some library vendors do not release source code for their software but do release pre-built binaries. When shared libraries are built, they should be versioned ([http~~://~~tldp~~.org/~~HOWTO/Program-Library~~-~~HOWTO~~/~~shared~~-~~libraries~~.html ~~see this article for some background]), but sometimes this is not done.~~

	~~To summarize, a versioned library must two conditions~~
	# ~~The filename must have the version appended. e.g. libfoo.so.1.2.3~~
	~~# The library must have the ELF tag SONAME set to the major version of thje library. e.g. libfoo.so.1~~

	~~This article shows how to deal~~ with ~~both versioned and unversioned~~ libraries.

	== Versioned Libraries ==		== Versioned Libraries ==

Michael Opdenacker: /* Versioned Libraries */ Override syntax fix

2022-01-11T09:08:05Z

Versioned Libraries: Override syntax fix

← Older revision		Revision as of 09:08, 11 January 2022
Line 53:		Line 53:
	ARCH_DIR_i686 = "build-i386"		ARCH_DIR_i686 = "build-i386"

	~~INSANE_SKIP_~~${PN} = "ldflags"		INSANE_SKIP:${PN} = "ldflags"
	INHIBIT_PACKAGE_STRIP = "1"		INHIBIT_PACKAGE_STRIP = "1"
	INHIBIT_SYSROOT_STRIP = "1"		INHIBIT_SYSROOT_STRIP = "1"

RossBurton: /* Versioned Libraries */

2016-10-13T13:05:00Z

Versioned Libraries

← Older revision		Revision as of 13:05, 13 October 2016
Line 65:		Line 65:
	}		}
	</pre>		</pre>

			If the precompiled binaries are not statically linked and have dependencies on other libraries, then by adding those libraries to DEPENDS the linking can be examined and the appropriate RDEPENDS automatically added.

	== Non-versioned Libraries ==		== Non-versioned Libraries ==

Henry Bruce: /* Versioned Libraries */

2016-10-12T16:39:54Z

Versioned Libraries

← Older revision		Revision as of 16:39, 12 October 2016
Line 30:		Line 30:
	* As vendor provides versioned libraries, we can use <tt>so_oeinstall</tt> to install shared library and creates symbolic links. If vendor does not do this we need to follow the non-versioned library guidelines below		* As vendor provides versioned libraries, we can use <tt>so_oeinstall</tt> to install shared library and creates symbolic links. If vendor does not do this we need to follow the non-versioned library guidelines below
	* As the vendor likely used the different LDFLAGS from your Yocto build, disable checking by adding <tt>ldflags</tt> to <tt>INSANE_SKIP</tt>		* As the vendor likely used the different LDFLAGS from your Yocto build, disable checking by adding <tt>ldflags</tt> to <tt>INSANE_SKIP</tt>
	* ~~Vendor~~ typically ship release builds ~~with~~ debug symbols ~~so disable~~ stripping to ~~prevent packaging errors~~ by setting ~~<tt>INHIBIT_PACKAGE_STRIP</tt> and <tt>INHIBIT_SYSROOT_STRIP</tt>~~.		* The vendor will typically ship release builds without debug symbols. Avoid errors by preventing the packaging task from stripping out the symbols and adding them to a separate debug package. This is done by setting the 'INHIBIT' flags shown below..

	Complete recipe would look like this.		Complete recipe would look like this.
Line 56:		Line 56:
	INHIBIT_PACKAGE_STRIP = "1"		INHIBIT_PACKAGE_STRIP = "1"
	INHIBIT_SYSROOT_STRIP = "1"		INHIBIT_SYSROOT_STRIP = "1"
			INHIBIT_PACKAGE_DEBUG_SPLIT = "1"

	do_install () {		do_install () {

Henry Bruce: /* Example */

2016-09-27T21:25:07Z

Example

← Older revision		Revision as of 21:25, 27 September 2016
Line 98:		Line 98:

	COMPATIBLE_HOST = "x86_64.*-linux"		COMPATIBLE_HOST = "x86_64.*-linux"


	INSANE_SKIP_${PN} = "ldflags"		INSANE_SKIP_${PN} = "ldflags"

Henry Bruce: /* Versioned Libraries */

2016-09-22T17:35:47Z

Versioned Libraries

← Older revision		Revision as of 17:35, 22 September 2016
Line 43:		Line 43:

	# BUILD_NUMBER is set to build number of libft4222 release tarball		# BUILD_NUMBER is set to build number of libft4222 release tarball
	# Set subdir ~~variable~~ to ${P} so that files are unpacked into ${S}		BUILD_NUMBER = "35"
	SRC_URI = "http://www.ftdichip.com/Support/SoftwareExamples/${~~PN}-${PV~~}.${BUILD_NUMBER}.tgz;subdir=${P}"		# Set SRC_URI subdir to ${P} so that files are unpacked into ${S}
			SRC_URI = "http://www.ftdichip.com/Support/SoftwareExamples/${P}.${BUILD_NUMBER}.tgz;subdir=${P}"
	SRC_URI[md5sum] = "c5bc189fb5b167daf662ff81c66cde55"		SRC_URI[md5sum] = "c5bc189fb5b167daf662ff81c66cde55"
	SRC_URI[sha256sum] = "df03e50f4a205474eaacadcdb59dc602237e95d48008ede8fc2d1f2493e54845"		SRC_URI[sha256sum] = "df03e50f4a205474eaacadcdb59dc602237e95d48008ede8fc2d1f2493e54845"

Henry Bruce: /* Versioned Libraries */

2016-09-22T17:33:19Z

Versioned Libraries

← Older revision		Revision as of 17:33, 22 September 2016
Line 13:		Line 13:
	In this example we work with libraries for the FT4222 USB I/O chip. Libraries are built for x86 32 and 64bit architectures and packaged in zip file as follows.		In this example we work with libraries for the FT4222 USB I/O chip. Libraries are built for x86 32 and 64bit architectures and packaged in zip file as follows.
	<pre>		<pre>
			├── build-arm-v6-hf
			│ └── libft4222.so.1.2.1.35
	├── build-i386		├── build-i386
	│ └── libft4222.so.1.2.1.35		│ └── libft4222.so.1.2.1.35

Henry Bruce: /* Versioned Libraries */

2016-09-22T17:31:31Z

Versioned Libraries

← Older revision		Revision as of 17:31, 22 September 2016
Line 25:		Line 25:
	* Vendor provides a tarball containing libraries so set <tt>SRC_URI</tt> appropriately.		* Vendor provides a tarball containing libraries so set <tt>SRC_URI</tt> appropriately.
	* Set COMPATIBLE_HOST so that recipe cannot be be used with an unsupported architectures. In this example we only support x86 architecture in 32 and 64bit variants.		* Set COMPATIBLE_HOST so that recipe cannot be be used with an unsupported architectures. In this example we only support x86 architecture in 32 and 64bit variants.
	* We installing, use the TRANSLATED_TARGET_ARCH override to set source directory within tarball appropriately.		* We installing, use the TRANSLATED_TARGET_ARCH override to set source directory within tarball (ARCH_DIR) appropriately.
	* As vendor provides versioned libraries, we can use <tt>so_oeinstall</tt> to install shared library and creates symbolic links. If vendor does not do this we need to follow the non-versioned library guidelines below		* As vendor provides versioned libraries, we can use <tt>so_oeinstall</tt> to install shared library and creates symbolic links. If vendor does not do this we need to follow the non-versioned library guidelines below
	* As the vendor likely used the different LDFLAGS from your Yocto build, disable checking by adding <tt>ldflags</tt> to <tt>INSANE_SKIP</tt>		* As the vendor likely used the different LDFLAGS from your Yocto build, disable checking by adding <tt>ldflags</tt> to <tt>INSANE_SKIP</tt>

Henry Bruce: /* Versioned Libraries */

2016-09-21T19:50:07Z

Versioned Libraries

← Older revision		Revision as of 19:50, 21 September 2016
Line 46:		Line 46:
	SRC_URI[sha256sum] = "df03e50f4a205474eaacadcdb59dc602237e95d48008ede8fc2d1f2493e54845"		SRC_URI[sha256sum] = "df03e50f4a205474eaacadcdb59dc602237e95d48008ede8fc2d1f2493e54845"

	~~MACHINE_DIR_x86~~-64 = "build-x86_64"		ARCH_DIR_x86-64 = "build-x86_64"
	~~MACHINE_DIR_i586~~ = "build-i386"		ARCH_DIR_i586 = "build-i386"
	~~MACHINE_DIR_i686~~ = "build-i386"		ARCH_DIR_i686 = "build-i386"

	INSANE_SKIP_${PN} = "ldflags"		INSANE_SKIP_${PN} = "ldflags"
Line 56:		Line 56:
	do_install () {		do_install () {
	install -m 0755 -d ${D}${libdir}		install -m 0755 -d ${D}${libdir}
	oe_soinstall ${S}/${~~MACHINE_DIR~~}/libft4222.so.${PV}.${BUILD_NUMBER} ${D}${libdir}		oe_soinstall ${S}/${ARCH_DIR}/libft4222.so.${PV}.${BUILD_NUMBER} ${D}${libdir}
	install ~~-m 0755~~ -d ${D}${includedir}		install -d ${D}${includedir}
	install -m 0755 ${S}/*.h ${D}${includedir}		install -m 0755 ${S}/*.h ${D}${includedir}
	}		}