From patchwork Tue Jun 11 14:15:22 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Kanavin X-Patchwork-Id: 44914 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2DFE2C25B76 for ; Tue, 11 Jun 2024 14:16:57 +0000 (UTC) Received: from mail-ed1-f46.google.com (mail-ed1-f46.google.com [209.85.208.46]) by mx.groups.io with SMTP id smtpd.web10.10773.1718115412552159482 for ; Tue, 11 Jun 2024 07:16:52 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20230601 header.b=XlPualZ1; spf=pass (domain: gmail.com, ip: 209.85.208.46, mailfrom: alex.kanavin@gmail.com) Received: by mail-ed1-f46.google.com with SMTP id 4fb4d7f45d1cf-57a44c2ce80so1494539a12.0 for ; Tue, 11 Jun 2024 07:16:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1718115411; x=1718720211; darn=lists.openembedded.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=Z995T05ISb47KgmgTzr39IsqnmtZshO0nWV5RJ2oPB4=; b=XlPualZ1PESyhOEcNC7S33VmZTgfx1M9lP2+j2kf9hVS1mZX+1pOox0nyY0BFb2g5j OK+AOeoMymb6jOK9A1XGxc7q0mI8lyJzmvv6AbMdQzc+NwO0RYx9FYUBbFsyF6dlJ1mV aeh99vB97q/sucEuR6lbzAqJy+7oEy3jwWrK3ASkoAcijFLvOaqSbWvnR+KNUTyZTNhh 8mZDTHoz0nMNoCS7zDftT+UMGydS/PdGekVcHSRq7xpcGdg8zIEx1I885yGeuRhhkIN1 Y2X42hWfiOvwGA0C8ILuho/sket5YG/0gAt6b0DDx1xKk6ptgcpUL6/qRz3pK1hazsmh qPWA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1718115411; x=1718720211; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Z995T05ISb47KgmgTzr39IsqnmtZshO0nWV5RJ2oPB4=; b=fkzxan8fPFCeZ77wv9R3hb0GBrFEerfOMOtNlIuPg5zCOGlCuMdfNuBv1z1MN45bMI q/l6zqRpmD4hznMjwihgAUylifRtpkRaT/lFAwi+V5nQ9IjPNBcEuD2XlRou80N2J3lL 0scFIm7tPvm+K0TZN7rNp1HZdeVXtsLY8QdgfjSPBcyxBjUmWrFGJYv8lakYU6RYGHJ+ lmtKeJ7wtG3hmSiqZvKY1FCNnVBBWNyx9z+BBzxTzN0iC+rbw9TiXInJMBqd+6JtQw0C LdnvMG6P6yB0xV5hh3w81NWAPmzSeofRivqXb77qg2LXJ6cyjaHZPC7gLyQdNec8AMn1 6yiA== X-Gm-Message-State: AOJu0YyfqPWBilXTGQOeX78REmxZKdMz2WnIpXp/WBUivBWdnYoJCQ4n Enmd1UNRX/vC8iUg2XEqlgq79zYQPV6iiN6JdSHjTkOAIakc1C/5oEgrjQ== X-Google-Smtp-Source: AGHT+IGoBjx9PdW7XwIJdtPf3xpTGImlzCalx4nSlkEVFi0T73zY2+5FIwEmba94ppKMoPkAVwPAtw== X-Received: by 2002:a50:d5c8:0:b0:578:67db:7529 with SMTP id 4fb4d7f45d1cf-57c50878c53mr8046783a12.4.1718115410767; Tue, 11 Jun 2024 07:16:50 -0700 (PDT) Received: from Zen2.lab.linutronix.de. (drugstore.linutronix.de. [80.153.143.164]) by smtp.gmail.com with ESMTPSA id 4fb4d7f45d1cf-57c7fcfc67fsm4311033a12.31.2024.06.11.07.16.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 11 Jun 2024 07:16:50 -0700 (PDT) From: Alexander Kanavin To: openembedded-core@lists.openembedded.org Cc: Alexander Kanavin Subject: [PATCH 3/3] scripts/oe-replicate-build: add a script that packages and replicates a yocto build elsewhere Date: Tue, 11 Jun 2024 16:15:22 +0200 Message-Id: <20240611141522.3075000-3-alex.kanavin@gmail.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240611141522.3075000-1-alex.kanavin@gmail.com> References: <20240611141522.3075000-1-alex.kanavin@gmail.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Tue, 11 Jun 2024 14:16:57 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/200528 From: Alexander Kanavin This scripts takes an existing, active yocto build, and puts pieces of it into a bundle directory, which is then placed in a tarball, and that goes into a self-extracting shell archive. This allows moving the bundle to another machine, or placing it on a network server for downloads. It's like esdk bundles, except inside there is a regular, plain, direct yocto build. The bundle includes: - copies of all layers used in a build, with their git histories - build configuration as a template in a special layer private to the bundle - (this is the best bit) all the sstate needed for the specified target, but *only* that sstate and not a complete copy of the local cache. When someone runs the self-extracting shell archive, everything should 'just work': the layers are restored, and the build set up to use them, the bundled sstate cache, and the template configuration. Alternatively, it's possible to not include the cache, and presumably it will come from a configured sstate mirror. This enables at least two*scratch*three interesting use cases: - moving builds around in single-step fashion: run the script, and give the artifact to someone else via file sharing or usb sticks. - publishing builds on the network, perhaps right next to the sstate cache that can fulfil them. This allows an alternative, much smoother entry point into 'doing yocto', as this guarantees availability of needed cache items, and so builds will be a lot faster than the typical 'compile everything from scratch' yocto experience. Sstate is guaranteed to be available, as there's a record of needed items in each bundle, and that record can be used to prevent pruning of still-needed cache items. - this, in turn, can enable 'binary Yocto distro' implemented with sstate, if there's a higher level tool that creates bundles in a systematic, structured fashion, and another tool that iterates over available bundles, and lets users pick them for building locally. Signed-off-by: Alexander Kanavin --- meta/files/bundle-shar-extract.sh | 55 ++++++++++++++ meta/lib/oeqa/selftest/cases/sstatetests.py | 13 ++++ scripts/oe-replicate-build | 79 +++++++++++++++++++++ 3 files changed, 147 insertions(+) create mode 100644 meta/files/bundle-shar-extract.sh create mode 100755 scripts/oe-replicate-build diff --git a/meta/files/bundle-shar-extract.sh b/meta/files/bundle-shar-extract.sh new file mode 100644 index 00000000000..ae10dbaf065 --- /dev/null +++ b/meta/files/bundle-shar-extract.sh @@ -0,0 +1,55 @@ +#!/bin/bash + +verbose=0 +listcontents=0 +prepare_buildsystem="yes" +while getopts "Dln" OPT; do + case $OPT in + D) + verbose=1 + ;; + l) + listcontents=1 + ;; + n) + prepare_buildsystem="no" + ;; + *) + echo "Usage: $(basename "$0") [-D] [-l] [-n]" + echo " -D Use set -x to see what is going on" + echo " -l list files that will be extracted" + echo " -n Extract files but do not prepare the build system" + exit 1 + ;; + esac +done + +if [ $verbose = 1 ] ; then + set -x +fi + +payload_offset=$(($(grep -na -m1 "^MARKER:$" "$0"|cut -d':' -f1) + 1)) + +if [ "$listcontents" = "1" ] ; then + tail -n +$payload_offset "$0"| tar tv || exit 1 + exit +fi + + +tail -n +$payload_offset "$0"| tar mx --zstd --checkpoint=.2500 || exit 1 + +if [ $prepare_buildsystem = "no" ] ; then + exit +fi + +target_dir=$(basename "$0" .sh) +pushd $target_dir +layers/setup-build setup -c build-config-default -b build --no-shell > setup-build.log +popd + +echo "Each time you wish to use this build in a new shell session, you need to source the environment setup script:" +echo " \$ . $target_dir/build/init-build-env" + +exit 0 + +MARKER: diff --git a/meta/lib/oeqa/selftest/cases/sstatetests.py b/meta/lib/oeqa/selftest/cases/sstatetests.py index 94ad6e38b68..b59d0d2d1e8 100644 --- a/meta/lib/oeqa/selftest/cases/sstatetests.py +++ b/meta/lib/oeqa/selftest/cases/sstatetests.py @@ -1007,3 +1007,16 @@ MACHINE = "{}" def test_local_cache_qemuarm64(self): exceptions = [] self.run_test("qemuarm64", "core-image-minimal core-image-full-cmdline core-image-sato-sdk", exceptions, check_cdn = False) + +class SStateBundles(SStateCheckObjectPresence): + def test_minimal_bundle(self): + targets = "core-image-minimal" + machine = get_bb_var('MACHINE') + bitbake("--runall build {}".format(targets)) + runCmd("oe-replicate-build --targets {}".format(targets)) + extractedbundledir = tempfile.mkdtemp(prefix='bundle-extracted-', dir=self.topdir) + runCmd("../build-bundle.sh", cwd=extractedbundledir) + result = runCmd(". build-bundle/build/init-build-env && MACHINE={} bitbake -DD -n {}".format(machine,targets), cwd=extractedbundledir, shell=True, executable='/bin/bash') + + exceptions = [] + self.check_bb_output(result.output, targets, exceptions, check_cdn=False) diff --git a/scripts/oe-replicate-build b/scripts/oe-replicate-build new file mode 100755 index 00000000000..e13710f1d97 --- /dev/null +++ b/scripts/oe-replicate-build @@ -0,0 +1,79 @@ +#!/usr/bin/env python3 +# +# Copyright OpenEmbedded Contributors +# +# SPDX-License-Identifier: MIT +# + +import argparse +import json +import os +import subprocess +import shutil + +def _do_bundle(args): + bundledir = args.output_prefix or "build-bundle" + print("Making a self-extracting bundle archive in {}.sh ...".format(bundledir)) + os.mkdir(bundledir) + + builddir = os.path.join(bundledir, "build") + buildconfdir = os.path.join(builddir, "conf") + os.makedirs(buildconfdir) + + subprocess.check_output("bitbake -S outdir={} -S lockedsigs {}".format(os.path.abspath(buildconfdir),args.targets), shell=True) + sstate_dir = subprocess.check_output("bitbake-getvar --value SSTATE_DIR", shell=True).decode().strip() + nativelsbstring = subprocess.check_output("bitbake-getvar --value NATIVELSBSTRING", shell=True).decode().strip() + if not args.no_sstate: + subprocess.check_output("gen-lockedsig-cache {} {} {} {}".format("conf/locked-sigs.inc", sstate_dir, "sstate-cache", nativelsbstring), shell=True, cwd=builddir) + + with open(os.path.join(buildconfdir, "bblock.conf"), 'w') as f: + f.write('require conf/locked-sigs.inc\n') + + layerdir = "meta-build-config" + subprocess.check_output("bitbake-layers create-layer --add-layer {}".format(layerdir), shell=True, cwd=bundledir) + subprocess.check_output("bitbake-layers save-build-conf {} default".format(layerdir), shell=True, cwd=bundledir) + shutil.copy(os.path.join(os.environ["BUILDDIR"],'conf',"conf-summary.txt"), os.path.join(bundledir,layerdir,'conf/templates/default')) + shutil.copy(os.path.join(os.environ["BUILDDIR"],'conf',"conf-notes.txt"), os.path.join(bundledir,layerdir,'conf/templates/default')) + subprocess.check_output("bitbake-layers remove-layer {}".format(layerdir), shell=True, cwd=bundledir) + + # meta-build-config is then in bblayers.conf.sample, and should be removed from it as it wasn't in the actual build + bblayers = os.path.join(bundledir, layerdir, 'conf/templates/default/bblayers.conf.sample') + with open(bblayers) as f: + lines = f.readlines() + lines = [l for l in lines if os.path.join(bundledir, layerdir) not in l] + with open(bblayers,'w') as f: + f.write(''.join(lines)) + + subprocess.check_output("bitbake-layers create-layers-setup --writer oe-local-copy {}".format(bundledir), shell=True) + + # meta-build-config should however be present in .oe-layers.json, as otherwise oe-setup-build won't be able to discover + # the config template in it + oelayers = os.path.join(bundledir, 'layers', '.oe-layers.json') + with open(oelayers) as f: + json_f = json.load(f) + json_f["layers"].append("../meta-build-config") + with open(oelayers,'w') as f: + json.dump(json_f, f, sort_keys=True, indent=4) + + subprocess.check_output("tar caf {}.tar.zst {}".format(bundledir, bundledir), shell=True) + + corebase = subprocess.check_output("bitbake-getvar --value COREBASE", shell=True).decode().strip() + subprocess.check_output("cp {}/meta/files/bundle-shar-extract.sh {}.sh".format(corebase, bundledir), shell=True) + subprocess.check_output("cat {}.tar.zst >> {}.sh".format(bundledir, bundledir), shell=True) + subprocess.check_output("chmod +x {}.sh".format(bundledir), shell=True) + + if not args.keep_tmp: + shutil.rmtree(bundledir) + os.remove("{}.tar.zst".format(bundledir)) + +parser = argparse.ArgumentParser(description="A script that bundles up everything needed to replicate a yocto build elsewhere (including appropriate portions of sstate cache) into a self-contained shell archive.") + +parser.add_argument('--targets', required=True, help="Bitbake targets that the bundle should be made for.") +parser.add_argument('--output-prefix', help='File name prefix for the output files, if the default (build-bundle) is undesirable.') +parser.add_argument('--no-sstate', action='store_true', help='Do not include sstate cache into the bundle.') +parser.add_argument('--keep-tmp', action='store_true', help='Keep intermediate output: unpacked bundle directory, and compressed tarball (in addition to the final self-extracting shell archuve.') + +args = parser.parse_args() + +_do_bundle(args) +