xref: /OK3568_Linux_fs/yocto/poky/meta/classes/populate_sdk_base.bbclass (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1PACKAGES = ""
2
3inherit image-postinst-intercepts image-artifact-names
4
5# Wildcards specifying complementary packages to install for every package that has been explicitly
6# installed into the rootfs
7COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev'
8COMPLEMENTARY_GLOB[staticdev-pkgs] = '*-staticdev'
9COMPLEMENTARY_GLOB[doc-pkgs] = '*-doc'
10COMPLEMENTARY_GLOB[dbg-pkgs] = '*-dbg'
11COMPLEMENTARY_GLOB[src-pkgs] = '*-src'
12COMPLEMENTARY_GLOB[ptest-pkgs] = '*-ptest'
13COMPLEMENTARY_GLOB[bash-completion-pkgs] = '*-bash-completion'
14
15def complementary_globs(featurevar, d):
16    all_globs = d.getVarFlags('COMPLEMENTARY_GLOB')
17    globs = []
18    features = set((d.getVar(featurevar) or '').split())
19    for name, glob in all_globs.items():
20        if name in features:
21            globs.append(glob)
22    return ' '.join(globs)
23
24SDKIMAGE_FEATURES ??= "dev-pkgs dbg-pkgs src-pkgs ${@bb.utils.contains('DISTRO_FEATURES', 'api-documentation', 'doc-pkgs', '', d)}"
25SDKIMAGE_INSTALL_COMPLEMENTARY = '${@complementary_globs("SDKIMAGE_FEATURES", d)}'
26SDKIMAGE_INSTALL_COMPLEMENTARY[vardeps] += "SDKIMAGE_FEATURES"
27
28PACKAGE_ARCHS:append:task-populate-sdk = " sdk-provides-dummy-target"
29SDK_PACKAGE_ARCHS += "sdk-provides-dummy-${SDKPKGSUFFIX}"
30
31# List of locales to install, or "all" for all of them, or unset for none.
32SDKIMAGE_LINGUAS ?= "all"
33
34inherit rootfs_${IMAGE_PKGTYPE}
35
36SDK_DIR = "${WORKDIR}/sdk"
37SDK_OUTPUT = "${SDK_DIR}/image"
38SDK_DEPLOY = "${DEPLOY_DIR}/sdk"
39
40SDKDEPLOYDIR = "${WORKDIR}/${SDKMACHINE}-deploy-${PN}-populate-sdk"
41
42B:task-populate-sdk = "${SDK_DIR}"
43
44SDKTARGETSYSROOT = "${SDKPATH}/sysroots/${REAL_MULTIMACH_TARGET_SYS}"
45
46TOOLCHAIN_HOST_TASK ?= "nativesdk-packagegroup-sdk-host packagegroup-cross-canadian-${MACHINE}"
47TOOLCHAIN_HOST_TASK_ATTEMPTONLY ?= ""
48TOOLCHAIN_TARGET_TASK ?= "${@multilib_pkg_extend(d, 'packagegroup-core-standalone-sdk-target')} target-sdk-provides-dummy"
49TOOLCHAIN_TARGET_TASK_ATTEMPTONLY ?= ""
50TOOLCHAIN_OUTPUTNAME ?= "${SDK_NAME}-toolchain-${SDK_VERSION}"
51
52# Default archived SDK's suffix
53SDK_ARCHIVE_TYPE ?= "tar.xz"
54SDK_XZ_COMPRESSION_LEVEL ?= "-9"
55SDK_XZ_OPTIONS ?= "${XZ_DEFAULTS} ${SDK_XZ_COMPRESSION_LEVEL}"
56
57# To support different sdk type according to SDK_ARCHIVE_TYPE, now support zip and tar.xz
58python () {
59    if d.getVar('SDK_ARCHIVE_TYPE') == 'zip':
60       d.setVar('SDK_ARCHIVE_DEPENDS', 'zip-native')
61       # SDK_ARCHIVE_CMD used to generate archived sdk ${TOOLCHAIN_OUTPUTNAME}.${SDK_ARCHIVE_TYPE} from input dir ${SDK_OUTPUT}/${SDKPATH} to output dir ${SDKDEPLOYDIR}
62       # recommand to cd into input dir first to avoid archive with buildpath
63       d.setVar('SDK_ARCHIVE_CMD', 'cd ${SDK_OUTPUT}/${SDKPATH}; zip -r -y ${SDKDEPLOYDIR}/${TOOLCHAIN_OUTPUTNAME}.${SDK_ARCHIVE_TYPE} .')
64    else:
65       d.setVar('SDK_ARCHIVE_DEPENDS', 'xz-native')
66       d.setVar('SDK_ARCHIVE_CMD', 'cd ${SDK_OUTPUT}/${SDKPATH}; tar ${SDKTAROPTS} -cf - . | xz ${SDK_XZ_OPTIONS} > ${SDKDEPLOYDIR}/${TOOLCHAIN_OUTPUTNAME}.${SDK_ARCHIVE_TYPE}')
67}
68
69SDK_RDEPENDS = "${TOOLCHAIN_TARGET_TASK} ${TOOLCHAIN_HOST_TASK}"
70SDK_DEPENDS = "virtual/fakeroot-native ${SDK_ARCHIVE_DEPENDS} cross-localedef-native nativesdk-qemuwrapper-cross ${@' '.join(["%s-qemuwrapper-cross" % m for m in d.getVar("MULTILIB_VARIANTS").split()])} qemuwrapper-cross"
71PATH:prepend = "${WORKDIR}/recipe-sysroot/${SDKPATHNATIVE}${bindir}/crossscripts:${@":".join(all_multilib_tune_values(d, 'STAGING_BINDIR_CROSS').split())}:"
72SDK_DEPENDS += "nativesdk-glibc-locale"
73
74# We want the MULTIARCH_TARGET_SYS to point to the TUNE_PKGARCH, not PACKAGE_ARCH as it
75# could be set to the MACHINE_ARCH
76REAL_MULTIMACH_TARGET_SYS = "${TUNE_PKGARCH}${TARGET_VENDOR}-${TARGET_OS}"
77
78PID = "${@os.getpid()}"
79
80EXCLUDE_FROM_WORLD = "1"
81
82SDK_PACKAGING_FUNC ?= "create_shar"
83SDK_PRE_INSTALL_COMMAND ?= ""
84SDK_POST_INSTALL_COMMAND ?= ""
85SDK_RELOCATE_AFTER_INSTALL ?= "1"
86
87SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk"
88SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK"
89
90SDK_TARGET_MANIFEST = "${SDKDEPLOYDIR}/${TOOLCHAIN_OUTPUTNAME}.target.manifest"
91SDK_HOST_MANIFEST = "${SDKDEPLOYDIR}/${TOOLCHAIN_OUTPUTNAME}.host.manifest"
92SDK_EXT_TARGET_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAINEXT_OUTPUTNAME}.target.manifest"
93SDK_EXT_HOST_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAINEXT_OUTPUTNAME}.host.manifest"
94
95SDK_PRUNE_SYSROOT_DIRS ?= "/dev"
96
97python write_target_sdk_manifest () {
98    from oe.sdk import sdk_list_installed_packages
99    from oe.utils import format_pkg_list
100    sdkmanifestdir = os.path.dirname(d.getVar("SDK_TARGET_MANIFEST"))
101    pkgs = sdk_list_installed_packages(d, True)
102    if not os.path.exists(sdkmanifestdir):
103        bb.utils.mkdirhier(sdkmanifestdir)
104    with open(d.getVar('SDK_TARGET_MANIFEST'), 'w') as output:
105        output.write(format_pkg_list(pkgs, 'ver'))
106}
107
108sdk_prune_dirs () {
109    for d in ${SDK_PRUNE_SYSROOT_DIRS}; do
110        rm -rf ${SDK_OUTPUT}${SDKTARGETSYSROOT}$d
111    done
112}
113
114python write_sdk_test_data() {
115    from oe.data import export2json
116    testdata = "%s/%s.testdata.json" % (d.getVar('SDKDEPLOYDIR'), d.getVar('TOOLCHAIN_OUTPUTNAME'))
117    bb.utils.mkdirhier(os.path.dirname(testdata))
118    export2json(d, testdata)
119}
120
121python write_host_sdk_manifest () {
122    from oe.sdk import sdk_list_installed_packages
123    from oe.utils import format_pkg_list
124    sdkmanifestdir = os.path.dirname(d.getVar("SDK_HOST_MANIFEST"))
125    pkgs = sdk_list_installed_packages(d, False)
126    if not os.path.exists(sdkmanifestdir):
127        bb.utils.mkdirhier(sdkmanifestdir)
128    with open(d.getVar('SDK_HOST_MANIFEST'), 'w') as output:
129        output.write(format_pkg_list(pkgs, 'ver'))
130}
131
132POPULATE_SDK_POST_TARGET_COMMAND:append = " write_sdk_test_data ; "
133POPULATE_SDK_POST_TARGET_COMMAND:append:task-populate-sdk  = " write_target_sdk_manifest; sdk_prune_dirs; "
134POPULATE_SDK_POST_HOST_COMMAND:append:task-populate-sdk = " write_host_sdk_manifest; "
135
136SDK_PACKAGING_COMMAND = "${@'${SDK_PACKAGING_FUNC};' if '${SDK_PACKAGING_FUNC}' else ''}"
137SDK_POSTPROCESS_COMMAND = " create_sdk_files; check_sdk_sysroots; archive_sdk; ${SDK_PACKAGING_COMMAND} "
138
139def populate_sdk_common(d):
140    from oe.sdk import populate_sdk
141    from oe.manifest import create_manifest, Manifest
142
143    # Handle package exclusions
144    excl_pkgs = (d.getVar("PACKAGE_EXCLUDE") or "").split()
145    inst_pkgs = (d.getVar("PACKAGE_INSTALL") or "").split()
146    inst_attempt_pkgs = (d.getVar("PACKAGE_INSTALL_ATTEMPTONLY") or "").split()
147
148    d.setVar('PACKAGE_INSTALL_ORIG', ' '.join(inst_pkgs))
149    d.setVar('PACKAGE_INSTALL_ATTEMPTONLY', ' '.join(inst_attempt_pkgs))
150
151    for pkg in excl_pkgs:
152        if pkg in inst_pkgs:
153            bb.warn("Package %s, set to be excluded, is in %s PACKAGE_INSTALL (%s).  It will be removed from the list." % (pkg, d.getVar('PN'), inst_pkgs))
154            inst_pkgs.remove(pkg)
155
156        if pkg in inst_attempt_pkgs:
157            bb.warn("Package %s, set to be excluded, is in %s PACKAGE_INSTALL_ATTEMPTONLY (%s).  It will be removed from the list." % (pkg, d.getVar('PN'), inst_pkgs))
158            inst_attempt_pkgs.remove(pkg)
159
160    d.setVar("PACKAGE_INSTALL", ' '.join(inst_pkgs))
161    d.setVar("PACKAGE_INSTALL_ATTEMPTONLY", ' '.join(inst_attempt_pkgs))
162
163    pn = d.getVar('PN')
164    runtime_mapping_rename("TOOLCHAIN_TARGET_TASK", pn, d)
165    runtime_mapping_rename("TOOLCHAIN_TARGET_TASK_ATTEMPTONLY", pn, d)
166
167    ld = bb.data.createCopy(d)
168    ld.setVar("PKGDATA_DIR", "${STAGING_DIR}/${SDK_ARCH}-${SDKPKGSUFFIX}${SDK_VENDOR}-${SDK_OS}/pkgdata")
169    runtime_mapping_rename("TOOLCHAIN_HOST_TASK", pn, ld)
170    runtime_mapping_rename("TOOLCHAIN_HOST_TASK_ATTEMPTONLY", pn, ld)
171    d.setVar("TOOLCHAIN_HOST_TASK", ld.getVar("TOOLCHAIN_HOST_TASK"))
172    d.setVar("TOOLCHAIN_HOST_TASK_ATTEMPTONLY", ld.getVar("TOOLCHAIN_HOST_TASK_ATTEMPTONLY"))
173
174    # create target/host SDK manifests
175    create_manifest(d, manifest_dir=d.getVar('SDK_DIR'),
176                    manifest_type=Manifest.MANIFEST_TYPE_SDK_HOST)
177    create_manifest(d, manifest_dir=d.getVar('SDK_DIR'),
178                    manifest_type=Manifest.MANIFEST_TYPE_SDK_TARGET)
179
180    populate_sdk(d)
181
182fakeroot python do_populate_sdk() {
183    populate_sdk_common(d)
184}
185SSTATETASKS += "do_populate_sdk"
186SSTATE_SKIP_CREATION:task-populate-sdk = '1'
187do_populate_sdk[cleandirs] = "${SDKDEPLOYDIR}"
188do_populate_sdk[sstate-inputdirs] = "${SDKDEPLOYDIR}"
189do_populate_sdk[sstate-outputdirs] = "${SDK_DEPLOY}"
190do_populate_sdk[stamp-extra-info] = "${MACHINE_ARCH}${SDKMACHINE}"
191python do_populate_sdk_setscene () {
192    sstate_setscene(d)
193}
194addtask do_populate_sdk_setscene
195
196PSEUDO_IGNORE_PATHS .= ",${SDKDEPLOYDIR},${WORKDIR}/oe-sdk-repo,${WORKDIR}/sstate-build-populate_sdk"
197
198fakeroot create_sdk_files() {
199	cp ${COREBASE}/scripts/relocate_sdk.py ${SDK_OUTPUT}/${SDKPATH}/
200
201	# Replace the ##DEFAULT_INSTALL_DIR## with the correct pattern.
202	# Escape special characters like '+' and '.' in the SDKPATH
203	escaped_sdkpath=$(echo ${SDKPATH} |sed -e "s:[\+\.]:\\\\\\\\\0:g")
204	sed -i -e "s:##DEFAULT_INSTALL_DIR##:$escaped_sdkpath:" ${SDK_OUTPUT}/${SDKPATH}/relocate_sdk.py
205
206       mkdir -p ${SDK_OUTPUT}/${SDKPATHNATIVE}${sysconfdir}/
207       echo '${SDKPATHNATIVE}${libdir_nativesdk}
208${SDKPATHNATIVE}${base_libdir_nativesdk}
209include /etc/ld.so.conf' > ${SDK_OUTPUT}/${SDKPATHNATIVE}${sysconfdir}/ld.so.conf
210}
211
212python check_sdk_sysroots() {
213    # Fails build if there are broken or dangling symlinks in SDK sysroots
214
215    if d.getVar('CHECK_SDK_SYSROOTS') != '1':
216        # disabled, bail out
217        return
218
219    def norm_path(path):
220        return os.path.abspath(path)
221
222    # Get scan root
223    SCAN_ROOT = norm_path("%s/%s/sysroots/" % (d.getVar('SDK_OUTPUT'),
224                                               d.getVar('SDKPATH')))
225
226    bb.note('Checking SDK sysroots at ' + SCAN_ROOT)
227
228    def check_symlink(linkPath):
229        if not os.path.islink(linkPath):
230            return
231
232        linkDirPath = os.path.dirname(linkPath)
233
234        targetPath = os.readlink(linkPath)
235        if not os.path.isabs(targetPath):
236            targetPath = os.path.join(linkDirPath, targetPath)
237        targetPath = norm_path(targetPath)
238
239        if SCAN_ROOT != os.path.commonprefix( [SCAN_ROOT, targetPath] ):
240            bb.error("Escaping symlink {0!s} --> {1!s}".format(linkPath, targetPath))
241            return
242
243        if not os.path.exists(targetPath):
244            bb.error("Broken symlink {0!s} --> {1!s}".format(linkPath, targetPath))
245            return
246
247        if os.path.isdir(targetPath):
248            dir_walk(targetPath)
249
250    def walk_error_handler(e):
251        bb.error(str(e))
252
253    def dir_walk(rootDir):
254        for dirPath,subDirEntries,fileEntries in os.walk(rootDir, followlinks=False, onerror=walk_error_handler):
255            entries = subDirEntries + fileEntries
256            for e in entries:
257                ePath = os.path.join(dirPath, e)
258                check_symlink(ePath)
259
260    # start
261    dir_walk(SCAN_ROOT)
262}
263
264SDKTAROPTS = "--owner=root --group=root"
265
266fakeroot archive_sdk() {
267	# Package it up
268	mkdir -p ${SDKDEPLOYDIR}
269	${SDK_ARCHIVE_CMD}
270}
271
272TOOLCHAIN_SHAR_EXT_TMPL ?= "${COREBASE}/meta/files/toolchain-shar-extract.sh"
273TOOLCHAIN_SHAR_REL_TMPL ?= "${COREBASE}/meta/files/toolchain-shar-relocate.sh"
274
275fakeroot create_shar() {
276	# copy in the template shar extractor script
277	cp ${TOOLCHAIN_SHAR_EXT_TMPL} ${SDKDEPLOYDIR}/${TOOLCHAIN_OUTPUTNAME}.sh
278
279	rm -f ${T}/pre_install_command ${T}/post_install_command
280
281	if [ "${SDK_RELOCATE_AFTER_INSTALL}" = "1" ] ; then
282		cp ${TOOLCHAIN_SHAR_REL_TMPL} ${T}/post_install_command
283	fi
284	cat << "EOF" >> ${T}/pre_install_command
285${SDK_PRE_INSTALL_COMMAND}
286EOF
287
288	cat << "EOF" >> ${T}/post_install_command
289${SDK_POST_INSTALL_COMMAND}
290EOF
291	sed -i -e '/@SDK_PRE_INSTALL_COMMAND@/r ${T}/pre_install_command' \
292		-e '/@SDK_POST_INSTALL_COMMAND@/r ${T}/post_install_command' \
293		${SDKDEPLOYDIR}/${TOOLCHAIN_OUTPUTNAME}.sh
294
295	# substitute variables
296	sed -i -e 's#@SDK_ARCH@#${SDK_ARCH}#g' \
297		-e 's#@SDKPATH@#${SDKPATH}#g' \
298		-e 's#@SDKPATHINSTALL@#${SDKPATHINSTALL}#g' \
299		-e 's#@SDKEXTPATH@#${SDKEXTPATH}#g' \
300		-e 's#@OLDEST_KERNEL@#${SDK_OLDEST_KERNEL}#g' \
301		-e 's#@REAL_MULTIMACH_TARGET_SYS@#${REAL_MULTIMACH_TARGET_SYS}#g' \
302		-e 's#@SDK_TITLE@#${@d.getVar("SDK_TITLE").replace('&', '\\&')}#g' \
303		-e 's#@SDK_VERSION@#${SDK_VERSION}#g' \
304		-e '/@SDK_PRE_INSTALL_COMMAND@/d' \
305		-e '/@SDK_POST_INSTALL_COMMAND@/d' \
306		-e 's#@SDK_GCC_VER@#${@oe.utils.host_gcc_version(d, taskcontextonly=True)}#g' \
307		-e 's#@SDK_ARCHIVE_TYPE@#${SDK_ARCHIVE_TYPE}#g' \
308		${SDKDEPLOYDIR}/${TOOLCHAIN_OUTPUTNAME}.sh
309
310	# add execution permission
311	chmod +x ${SDKDEPLOYDIR}/${TOOLCHAIN_OUTPUTNAME}.sh
312
313	# append the SDK tarball
314	cat ${SDKDEPLOYDIR}/${TOOLCHAIN_OUTPUTNAME}.${SDK_ARCHIVE_TYPE} >> ${SDKDEPLOYDIR}/${TOOLCHAIN_OUTPUTNAME}.sh
315
316	# delete the old tarball, we don't need it anymore
317	rm ${SDKDEPLOYDIR}/${TOOLCHAIN_OUTPUTNAME}.${SDK_ARCHIVE_TYPE}
318}
319
320populate_sdk_log_check() {
321	for target in $*
322	do
323		lf_path="`dirname ${BB_LOGFILE}`/log.do_$target.${PID}"
324
325		echo "log_check: Using $lf_path as logfile"
326
327		if [ -e "$lf_path" ]; then
328			${IMAGE_PKGTYPE}_log_check $target $lf_path
329		else
330			echo "Cannot find logfile [$lf_path]"
331		fi
332		echo "Logfile is clean"
333	done
334}
335
336def sdk_command_variables(d):
337    return ['OPKG_PREPROCESS_COMMANDS','OPKG_POSTPROCESS_COMMANDS','POPULATE_SDK_POST_HOST_COMMAND','POPULATE_SDK_PRE_TARGET_COMMAND','POPULATE_SDK_POST_TARGET_COMMAND','SDK_POSTPROCESS_COMMAND','RPM_PREPROCESS_COMMANDS','RPM_POSTPROCESS_COMMANDS']
338
339def sdk_variables(d):
340    variables = ['BUILD_IMAGES_FROM_FEEDS','SDK_OS','SDK_OUTPUT','SDKPATHNATIVE','SDKTARGETSYSROOT','SDK_DIR','SDK_VENDOR','SDKIMAGE_INSTALL_COMPLEMENTARY','SDK_PACKAGE_ARCHS','SDK_OUTPUT',
341                 'SDKTARGETSYSROOT','MULTILIB_VARIANTS','MULTILIBS','ALL_MULTILIB_PACKAGE_ARCHS','MULTILIB_GLOBAL_VARIANTS','BAD_RECOMMENDATIONS','NO_RECOMMENDATIONS','PACKAGE_ARCHS',
342                 'PACKAGE_CLASSES','TARGET_VENDOR','TARGET_VENDOR','TARGET_ARCH','TARGET_OS','BBEXTENDVARIANT','FEED_DEPLOYDIR_BASE_URI', 'PACKAGE_EXCLUDE_COMPLEMENTARY', 'IMAGE_INSTALL_DEBUGFS']
343    variables.extend(sdk_command_variables(d))
344    return " ".join(variables)
345
346do_populate_sdk[vardeps] += "${@sdk_variables(d)}"
347
348python () {
349    variables = sdk_command_variables(d)
350    for var in variables:
351        if d.getVar(var, False):
352            d.setVarFlag(var, 'func', '1')
353}
354
355do_populate_sdk[file-checksums] += "${TOOLCHAIN_SHAR_REL_TMPL}:True \
356                                    ${TOOLCHAIN_SHAR_EXT_TMPL}:True"
357
358do_populate_sdk[dirs] = "${PKGDATA_DIR} ${TOPDIR}"
359do_populate_sdk[depends] += "${@' '.join([x + ':do_populate_sysroot' for x in d.getVar('SDK_DEPENDS').split()])}  ${@d.getVarFlag('do_rootfs', 'depends', False)}"
360do_populate_sdk[rdepends] = "${@' '.join([x + ':do_package_write_${IMAGE_PKGTYPE} ' + x + ':do_packagedata' for x in d.getVar('SDK_RDEPENDS').split()])}"
361do_populate_sdk[recrdeptask] += "do_packagedata do_package_write_rpm do_package_write_ipk do_package_write_deb"
362do_populate_sdk[file-checksums] += "${POSTINST_INTERCEPT_CHECKSUMS}"
363addtask populate_sdk
364