2 # Populate builds using prebuilt packages where possible to speed up builds
3 # and allow staging to be reconstructed.
5 # To use it add that line to conf/local.conf:
7 # INHERIT += "packaged-staging"
12 # bitbake.conf set PSTAGING_ACTIVE = "0", this class sets to "1" if we're active
14 PSTAGE_PKGVERSION = "${PV}-${PR}"
15 PSTAGE_PKGARCH = "${BUILD_SYS}"
16 PSTAGE_EXTRAPATH ?= "/${OELAYOUT_ABI}/${DISTRO_PR}/"
17 PSTAGE_PKGPATH = "${DISTRO}${PSTAGE_EXTRAPATH}"
18 PSTAGE_PKGPN = "${@bb.data.expand('staging-${PN}-${MULTIMACH_ARCH}${TARGET_VENDOR}-${TARGET_OS}', d).replace('_', '-')}"
19 PSTAGE_PKGNAME = "${PSTAGE_PKGPN}_${PSTAGE_PKGVERSION}_${PSTAGE_PKGARCH}.ipk"
20 PSTAGE_PKG ?= "${DEPLOY_DIR_PSTAGE}/${PSTAGE_PKGPATH}/${PSTAGE_PKGNAME}"
22 PSTAGE_NATIVEDEPENDS = "\
27 BB_STAMP_WHITELIST = "${PSTAGE_NATIVEDEPENDS}"
33 # These classes encode staging paths into the binary data so can only be
34 # reused if the path doesn't change/
35 if bb.data.inherits_class('native', d) or bb.data.inherits_class('cross', d) or bb.data.inherits_class('sdk', d):
36 path = bb.data.getVar('PSTAGE_PKGPATH', d, 1)
37 path = path + bb.data.getVar('TMPDIR', d, 1).replace('/', '-')
38 bb.data.setVar('PSTAGE_PKGPATH', path, d)
40 # PSTAGE_NATIVEDEPENDS lists the packages we need before we can use packaged
41 # staging. There will always be some packages we depend on.
42 if bb.data.inherits_class('native', d):
43 pn = bb.data.getVar('PN', d, True)
44 nativedeps = bb.data.getVar('PSTAGE_NATIVEDEPENDS', d, True).split()
46 pstage_allowed = False
48 # Images aren't of interest to us
49 if bb.data.inherits_class('image', d):
50 pstage_allowed = False
52 # Add task dependencies if we're active, otherwise mark packaged staging
55 deps = bb.data.getVarFlag('do_setscene', 'depends', d) or ""
56 deps += " stagemanager-native:do_populate_staging"
57 bb.data.setVarFlag('do_setscene', 'depends', deps, d)
59 policy = bb.data.getVar("BB_STAMP_POLICY", d, True)
60 if policy == "whitelist" or policy == "full":
61 deps = bb.data.getVarFlag('do_setscene', 'recrdeptask', d) or ""
62 deps += " do_setscene"
63 bb.data.setVarFlag('do_setscene', 'recrdeptask', deps, d)
65 bb.data.setVar("PSTAGING_ACTIVE", "1", d)
67 bb.data.setVar("PSTAGING_ACTIVE", "0", d)
70 DEPLOY_DIR_PSTAGE ?= "${DEPLOY_DIR}/pstage"
71 PSTAGE_MACHCONFIG = "${DEPLOY_DIR_PSTAGE}/opkg.conf"
73 PSTAGE_PKGMANAGER = "stage-manager-ipkg"
75 PSTAGE_BUILD_CMD = "stage-manager-ipkg-build -o 0 -g 0"
76 PSTAGE_INSTALL_CMD = "${PSTAGE_PKGMANAGER} -f ${PSTAGE_MACHCONFIG} -force-depends -o ${TMPDIR} install"
77 PSTAGE_UPDATE_CMD = "${PSTAGE_PKGMANAGER} -f ${PSTAGE_MACHCONFIG} -o ${TMPDIR} update"
78 PSTAGE_REMOVE_CMD = "${PSTAGE_PKGMANAGER} -f ${PSTAGE_MACHCONFIG} -force-depends -o ${TMPDIR} remove"
79 PSTAGE_LIST_CMD = "${PSTAGE_PKGMANAGER} -f ${PSTAGE_MACHCONFIG} -o ${TMPDIR} list_installed"
81 PSTAGE_TMPDIR_STAGE = "${WORKDIR}/staging-pkg"
83 def pstage_manualclean(srcname, destvarname, d):
86 src = os.path.join(bb.data.getVar('PSTAGE_TMPDIR_STAGE', d, True), srcname)
87 dest = bb.data.getVar(destvarname, d, True)
89 for walkroot, dirs, files in os.walk(src):
91 filepath = os.path.join(walkroot, file).replace(src, dest)
92 bb.note("rm %s" % filepath)
93 os.system("rm %s" % filepath)
95 def pstage_set_pkgmanager(d):
97 path = bb.data.getVar("PATH", d, 1)
98 pkgmanager = bb.which(path, 'opkg-cl')
100 pkgmanager = bb.which(path, 'ipkg-cl')
102 bb.data.setVar("PSTAGE_PKGMANAGER", pkgmanager, d)
105 def pstage_cleanpackage(pkgname, d):
108 path = bb.data.getVar("PATH", d, 1)
109 pstage_set_pkgmanager(d)
110 list_cmd = bb.data.getVar("PSTAGE_LIST_CMD", d, True)
112 bb.debug(2, "Checking if staging package installed")
113 lf = bb.utils.lockfile(bb.data.expand("${STAGING_DIR}/staging.lock", d))
114 ret = os.system("PATH=\"%s\" %s | grep %s" % (path, list_cmd, pkgname))
116 bb.debug(1, "Uninstalling package from staging...")
117 removecmd = bb.data.getVar("PSTAGE_REMOVE_CMD", d, 1)
118 ret = os.system("PATH=\"%s\" %s %s" % (path, removecmd, pkgname))
120 bb.note("Failure removing staging package")
122 bb.debug(1, "Manually removing any installed files from staging...")
123 pstage_manualclean("staging", "STAGING_DIR", d)
124 pstage_manualclean("cross", "CROSS_DIR", d)
125 pstage_manualclean("deploy", "DEPLOY_DIR", d)
127 bb.utils.unlockfile(lf)
131 Clear the build and temp directories
134 removepkg = bb.data.expand("${PSTAGE_PKGPN}", d)
135 pstage_cleanpackage(removepkg, d)
137 stagepkg = bb.data.expand("${PSTAGE_PKG}", d)
138 bb.note("Removing staging package %s" % base_path_out(stagepkg, d))
139 os.system('rm -rf ' + stagepkg)
143 # Assemble appropriate opkg.conf
144 conffile=${PSTAGE_MACHCONFIG}
145 mkdir -p ${DEPLOY_DIR_PSTAGE}/pstaging_lists
146 if [ ! -e $conffile ]; then
147 ipkgarchs="${BUILD_SYS}"
149 for arch in $ipkgarchs; do
150 echo "arch $arch $priority" >> $conffile
151 priority=$(expr $priority + 5)
153 echo "dest root /" >> $conffile
155 if [ ! -e ${TMPDIR}${layout_libdir}/opkg/info/ ]; then
156 mkdir -p ${TMPDIR}${layout_libdir}/opkg/info/
158 if [ ! -e ${TMPDIR}${layout_libdir}/ipkg/ ]; then
159 cd ${TMPDIR}${layout_libdir}/
164 PSTAGE_TASKS_COVERED = "fetch unpack munge patch configure qa_configure rig_locales compile sizecheck install deploy package populate_staging package_write_deb package_write_ipk package_write package_stage qa_staging"
166 SCENEFUNCS += "packagestage_scenefunc"
168 python packagestage_scenefunc () {
171 if bb.data.getVar("PSTAGING_ACTIVE", d, 1) == "0":
174 bb.build.exec_func("staging_helper", d)
176 removepkg = bb.data.expand("${PSTAGE_PKGPN}", d)
177 pstage_cleanpackage(removepkg, d)
179 stagepkg = bb.data.expand("${PSTAGE_PKG}", d)
181 if os.path.exists(stagepkg):
182 path = bb.data.getVar("PATH", d, 1)
183 pstage_set_pkgmanager(d)
184 file = bb.data.getVar("FILE", d, True)
185 bb.debug(2, "Packaged staging active for %s\n" % file)
188 # Install the staging package somewhere temporarily so we can extract the stamp files
190 bb.mkdirhier(bb.data.expand("${WORKDIR}/tstage/${layout_libdir}/opkg/info/ ", d))
191 cmd = bb.data.expand("${PSTAGE_PKGMANAGER} -f ${PSTAGE_MACHCONFIG} -force-depends -o ${WORKDIR}/tstage install", d)
192 ret = os.system("PATH=\"%s\" %s %s" % (path, cmd, stagepkg))
194 bb.fatal("Couldn't install the staging package to a temp directory")
197 # Copy the stamp files into the main stamps directoy
199 cmd = bb.data.expand("cp -dpR ${WORKDIR}/tstage/stamps/* ${TMPDIR}/stamps/", d)
202 bb.fatal("Couldn't copy the staging package stamp files")
205 # Iterate over the stamps seeing if they're valid. If we find any that
206 # are invalid or the task wasn't in the taskgraph, assume caution and
209 # FIXME - some tasks are safe to ignore in the task graph. e.g. package_write_*
211 taskscovered = bb.data.getVar("PSTAGE_TASKS_COVERED", d, True).split()
212 stamp = bb.data.getVar("STAMP", d, True)
213 for task in taskscovered:
215 stampfn = "%s.%s" % (stamp, task)
216 bb.debug(1, "Checking %s" % (stampfn))
217 if os.path.exists(stampfn):
218 stageok = bb.runqueue.check_stamp_fn(file, task, d)
219 bb.debug(1, "Result %s" % (stageok))
223 # Remove the stamps and files we added above
224 # FIXME - we should really only remove the stamps we added
225 os.system('rm -f ' + stamp + '.*')
226 os.system(bb.data.expand("rm -rf ${WORKDIR}/tstage", d))
229 bb.note("Staging package found, using it for %s." % file)
230 installcmd = bb.data.getVar("PSTAGE_INSTALL_CMD", d, 1)
231 lf = bb.utils.lockfile(bb.data.expand("${STAGING_DIR}/staging.lock", d))
232 ret = os.system("PATH=\"%s\" %s %s" % (path, installcmd, stagepkg))
233 bb.utils.unlockfile(lf)
235 bb.note("Failure installing prestage package")
237 bb.build.make_stamp("do_stage_package_populated", d)
239 bb.note("Staging package found but invalid for %s" % file)
242 packagestage_scenefunc[cleandirs] = "${PSTAGE_TMPDIR_STAGE}"
243 packagestage_scenefunc[dirs] = "${STAGING_DIR}"
245 addhandler packagedstage_stampfixing_eventhandler
246 python packagedstage_stampfixing_eventhandler() {
247 from bb.event import getName
250 if getName(e) == "StampUpdate":
251 taskscovered = bb.data.getVar("PSTAGE_TASKS_COVERED", e.data, 1).split()
252 for (fn, task) in e.targets:
255 if task in taskscovered:
256 stamp = "%s.do_stage_package_populated" % e.stampPrefix[fn]
257 if os.path.exists(stamp):
258 # We're targetting a task which was skipped with packaged staging
259 # so we need to remove the autogenerated stamps.
260 for task in taskscovered:
261 dir = "%s.do_%s" % (e.stampPrefix[fn], task)
262 os.system('rm -f ' + dir)
263 os.system('rm -f ' + stamp)
268 populate_staging_preamble () {
269 if [ "$PSTAGING_ACTIVE" = "1" ]; then
270 stage-manager -p ${STAGING_DIR} -c ${DEPLOY_DIR_PSTAGE}/stamp-cache-staging -u || true
271 stage-manager -p ${CROSS_DIR} -c ${DEPLOY_DIR_PSTAGE}/stamp-cache-cross -u || true
275 populate_staging_postamble () {
276 if [ "$PSTAGING_ACTIVE" = "1" ]; then
277 # list the packages currently installed in staging
278 # ${PSTAGE_LIST_CMD} | awk '{print $1}' > ${DEPLOY_DIR_PSTAGE}/installed-list
280 # exitcode == 5 is ok, it means the files change
282 stage-manager -p ${STAGING_DIR} -c ${DEPLOY_DIR_PSTAGE}/stamp-cache-staging -u -d ${PSTAGE_TMPDIR_STAGE}/staging
284 if [ "$exitcode" != "5" -a "$exitcode" != "0" ]; then
287 stage-manager -p ${CROSS_DIR} -c ${DEPLOY_DIR_PSTAGE}/stamp-cache-cross -u -d ${PSTAGE_TMPDIR_STAGE}/cross/${BASE_PACKAGE_ARCH}
288 if [ "$exitcode" != "5" -a "$exitcode" != "0" ]; then
295 do_populate_staging[lockfiles] = "${STAGING_DIR}/staging.lock"
296 do_populate_staging[dirs] =+ "${DEPLOY_DIR_PSTAGE}"
297 python do_populate_staging_prepend() {
298 bb.build.exec_func("populate_staging_preamble", d)
301 python do_populate_staging_append() {
302 bb.build.exec_func("populate_staging_postamble", d)
306 staging_packager () {
308 mkdir -p ${PSTAGE_TMPDIR_STAGE}/CONTROL
309 mkdir -p ${DEPLOY_DIR_PSTAGE}/${PSTAGE_PKGPATH}
311 echo "Package: ${PSTAGE_PKGPN}" > ${PSTAGE_TMPDIR_STAGE}/CONTROL/control
312 echo "Version: ${PSTAGE_PKGVERSION}" >> ${PSTAGE_TMPDIR_STAGE}/CONTROL/control
313 echo "Description: ${DESCRIPTION}" >> ${PSTAGE_TMPDIR_STAGE}/CONTROL/control
314 echo "Section: ${SECTION}" >> ${PSTAGE_TMPDIR_STAGE}/CONTROL/control
315 echo "Priority: Optional" >> ${PSTAGE_TMPDIR_STAGE}/CONTROL/control
316 echo "Maintainer: ${MAINTAINER}" >> ${PSTAGE_TMPDIR_STAGE}/CONTROL/control
317 echo "Architecture: ${PSTAGE_PKGARCH}" >> ${PSTAGE_TMPDIR_STAGE}/CONTROL/control
319 # Protect against empty SRC_URI
320 if [ "${SRC_URI}" != "" ] ; then
321 echo "Source: ${SRC_URI}" >> ${PSTAGE_TMPDIR_STAGE}/CONTROL/control
323 echo "Source: OpenEmbedded" >> ${PSTAGE_TMPDIR_STAGE}/CONTROL/control
326 ${PSTAGE_BUILD_CMD} ${PSTAGE_TMPDIR_STAGE} ${DEPLOY_DIR_PSTAGE}/${PSTAGE_PKGPATH}
329 staging_package_installer () {
330 #${PSTAGE_INSTALL_CMD} ${PSTAGE_PKG}
332 STATUSFILE=${TMPDIR}${layout_libdir}/opkg/status
333 echo "Package: ${PSTAGE_PKGPN}" >> $STATUSFILE
334 echo "Version: ${PSTAGE_PKGVERSION}" >> $STATUSFILE
335 echo "Status: install user installed" >> $STATUSFILE
336 echo "Architecture: ${PSTAGE_PKGARCH}" >> $STATUSFILE
337 echo "" >> $STATUSFILE
339 CTRLFILE=${TMPDIR}${layout_libdir}/opkg/info/${PSTAGE_PKGPN}.control
340 echo "Package: ${PSTAGE_PKGPN}" > $CTRLFILE
341 echo "Version: ${PSTAGE_PKGVERSION}" >> $CTRLFILE
342 echo "Architecture: ${PSTAGE_PKGARCH}" >> $CTRLFILE
344 cd ${PSTAGE_TMPDIR_STAGE}
345 find -type f | grep -v ./CONTROL | sed -e 's/^\.//' > ${TMPDIR}${layout_libdir}/opkg/info/${PSTAGE_PKGPN}.list
348 python do_package_stage () {
349 if bb.data.getVar("PSTAGING_ACTIVE", d, 1) != "1":
353 # Handle deploy/ packages
355 bb.build.exec_func("read_subpackage_metadata", d)
356 stagepath = bb.data.getVar("PSTAGE_TMPDIR_STAGE", d, 1)
357 tmpdir = bb.data.getVar("TMPDIR", d, True)
358 packages = (bb.data.getVar('PACKAGES', d, 1) or "").split()
359 if len(packages) > 0:
360 if bb.data.inherits_class('package_ipk', d):
361 ipkpath = bb.data.getVar('DEPLOY_DIR_IPK', d, True).replace(tmpdir, stagepath)
362 if bb.data.inherits_class('package_deb', d):
363 debpath = bb.data.getVar('DEPLOY_DIR_DEB', d, True).replace(tmpdir, stagepath)
364 if bb.data.inherits_class('package_rpm', d):
365 rpmpath = bb.data.getVar('DEPLOY_DIR_RPM', d, True).replace(tmpdir, stagepath)
368 pkgname = bb.data.getVar('PKG_%s' % pkg, d, 1)
371 arch = bb.data.getVar('PACKAGE_ARCH_%s' % pkg, d, 1)
373 arch = bb.data.getVar('PACKAGE_ARCH', d, 1)
374 pr = bb.data.getVar('PR_%s' % pkg, d, 1)
376 pr = bb.data.getVar('PR', d, 1)
377 if not packaged(pkg, d):
379 if bb.data.inherits_class('package_ipk', d):
380 srcname = bb.data.expand(pkgname + "_${PV}-" + pr + "_" + arch + ".ipk", d)
381 srcfile = bb.data.expand("${DEPLOY_DIR_IPK}/" + arch + "/" + srcname, d)
382 if os.path.exists(srcfile):
383 destpath = ipkpath + "/" + arch + "/"
384 bb.mkdirhier(destpath)
385 bb.copyfile(srcfile, destpath + srcname)
387 if bb.data.inherits_class('package_deb', d):
389 srcname = bb.data.expand(pkgname + "_${PV}-" + pr + "_all.deb", d)
391 srcname = bb.data.expand(pkgname + "_${PV}-" + pr + "_${DPKG_ARCH}.deb", d)
392 srcfile = bb.data.expand("${DEPLOY_DIR_DEB}/" + arch + "/" + srcname, d)
393 if os.path.exists(srcfile):
394 destpath = debpath + "/" + arch + "/"
395 bb.mkdirhier(destpath)
396 bb.copyfile(srcfile, destpath + srcname)
398 if bb.data.inherits_class('package_rpm', d):
399 version = bb.data.getVar('PV', d, 1)
400 version = version.replace('-', '+')
401 bb.data.setVar('RPMPV', version, d)
402 srcname = bb.data.expand(pkgname + "-${RPMPV}-" + pr + ".${TARGET_ARCH}.rpm", d)
403 srcfile = bb.data.expand("${DEPLOY_DIR_RPM}/" + arch + "/" + srcname, d)
404 if os.path.exists(srcfile):
405 destpath = rpmpath + "/" + arch + "/"
406 bb.mkdirhier(destpath)
407 bb.copyfile(srcfile, destpath + srcname)
411 # Handle stamps/ files
413 stampfn = bb.data.getVar("STAMP", d, True)
414 destdir = os.path.dirname(stampfn.replace(tmpdir, stagepath))
415 bb.mkdirhier(destdir)
416 # We need to include the package_stage stamp in the staging package so create one
417 bb.build.make_stamp("do_package_stage", d)
418 os.system("cp -dpR %s.do_* %s/" % (stampfn, destdir))
420 pstage_set_pkgmanager(d)
421 bb.build.exec_func("staging_helper", d)
422 bb.build.exec_func("staging_packager", d)
423 lf = bb.utils.lockfile(bb.data.expand("${STAGING_DIR}/staging.lock", d))
424 bb.build.exec_func("staging_package_installer", d)
425 bb.utils.unlockfile(lf)
429 # Note an assumption here is that do_deploy runs before do_package_write/do_populate_staging
431 addtask package_stage after do_package_write do_populate_staging before do_build
433 do_package_stage_all () {
436 do_package_stage_all[recrdeptask] = "do_package_stage"
437 addtask package_stage_all after do_package_stage before do_build