From patchwork Thu Jul 31 10:23:00 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Yoann Congal X-Patchwork-Id: 67821 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 ABAEAC87FD3 for ; Thu, 31 Jul 2025 10:23:19 +0000 (UTC) Received: from mail-wm1-f65.google.com (mail-wm1-f65.google.com [209.85.128.65]) by mx.groups.io with SMTP id smtpd.web11.58639.1753957393360511647 for ; Thu, 31 Jul 2025 03:23:13 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@smile.fr header.s=google header.b=ZF2j7tNt; spf=pass (domain: smile.fr, ip: 209.85.128.65, mailfrom: yoann.congal@smile.fr) Received: by mail-wm1-f65.google.com with SMTP id 5b1f17b1804b1-45555e3317aso3302635e9.3 for ; Thu, 31 Jul 2025 03:23:13 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=smile.fr; s=google; t=1753957391; x=1754562191; darn=lists.openembedded.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=ocBHOlOu/xMMMJiOpYeIMVLPGLzAfwmp0e76wraa93w=; b=ZF2j7tNtcKQJX+Fuvnbtdn8mCA7h4fy3ACin2AL3v9y6pbbT/yRL8wEWhK6TwcU1Xn XB5soI0ttzhCVLwdz1TujYBcd9R/5DiKwZQrPCnT0xnVz97W/JBANbx+WO0F5ClIamvn kwKwbTMm3owYnOpSbbOpmXdtJPDJZwvj2gIGI= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1753957391; x=1754562191; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=ocBHOlOu/xMMMJiOpYeIMVLPGLzAfwmp0e76wraa93w=; b=jf3qNEOa2iQ8l0CbwX4EIWnOlWO9+glQBIIlR4gNe7Xk81MLqAddr5c/RcSUUeBdvF 96atPawfl/ldXNDguXfgFb5qJ9vM1zLKTNoYEFJ2cZg5kQT9XRTQY9XXuLOJJVbW1a5z k6+oqHCMztSCrgqf9XawPmzMPIeNmtrAFk5qTIIhlzn+sptBgjJTNIGiyFXc8MAfP8aV eCRjDYL3mZZyrSFtv0Gmg1pr2Ut9Ry02tCb5XdMolRb5ApHiXvJcOW/0Q6hEtPGFj0zg NFqH0OeSqjewnbl3yJFDt5pT4OEBaLFtjm21B4Xv30yBcXgV57aQ4fxnW6VKyv4BGsMM gWng== X-Gm-Message-State: AOJu0YwuaDUwaicKhrf2Wtymq+1WuNIWKGEBQjzgLDJkQwPqWWQbOPS8 kJ6oj1nune+Wlnue9QrK+KGFIQ/u4aXv5mtFFxbf/Deau9zSygQ2+PjIG3SSG8WnJutDt+ygwHr SN9a3oGCUBGLt X-Gm-Gg: ASbGncvFDICsGyhqoCn4yJzT5P7ltw+VlIa0xlcIBmvo0kJqnT5RVtkA5/fe460kGcm yMphfTlJOUZhR1rlSOUkK2ZzdXrOOH+trXQwedyWtVO0Rbt3mDALDopTmdAjIvSO+VUenjSWo7H M6kgKkwqZk978vX8VOs0xSZvGNr6rkgCDUXIPmsROZEf23ZIPQxidi5CstTh/EWrVlAmJ3GHmZ9 eJuoTjhERzeuwLYKiWW+RYZWHFOEGW/Oh6q/oOWnTIOCyQQenM4R5vZaIDZIGDsTDxh9fmwV6YS mdPoPcp3Hrr3ohLB6E7KVtJcQhycZjjDon+sCRorkg1ddjGKtP+cVZ1SlIQ/f3np8O3DerJOjZk 0GBcqI1qS9Low5M3KuOKcF7KQf3jUN0S1/TEB8UzvZwUyQ7vabqOUlDEP0lpebUlkARtPFfDijh NuZfvsb/LIHpkWkDdkb5n+TInLKpVZVuIMnBRnmUaYB+MQoA== X-Google-Smtp-Source: AGHT+IGy6YPGN0KL0eZwh1w8DqTplXwncRZlUEFbHXgiRl9p8bWNvyde58EiRNJt4uvrAAlM1q6gRw== X-Received: by 2002:a05:600c:8b6e:b0:456:27a4:50ad with SMTP id 5b1f17b1804b1-45892be4bf9mr51174785e9.33.1753957391376; Thu, 31 Jul 2025 03:23:11 -0700 (PDT) Received: from P-ASN-ECS-830T8C3.idf.intranet (static-css-ccs-204145.business.bouyguestelecom.com. [176.157.204.145]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-4589536abb1sm65169445e9.4.2025.07.31.03.23.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 31 Jul 2025 03:23:11 -0700 (PDT) From: Yoann Congal To: openembedded-core@lists.openembedded.org Cc: Yoann Congal , Lamine REHAHLIA Subject: [PATCH v4 1/4] runqemu: Add support for running compressed .zst rootfs images Date: Thu, 31 Jul 2025 12:23:00 +0200 Message-Id: <20250731102303.3513121-1-yoann.congal@smile.fr> X-Mailer: git-send-email 2.39.5 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 ; Thu, 31 Jul 2025 10:23:19 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/221185 From: Lamine REHAHLIA Enhance runqemu to detect and decompress .zst-compressed rootfs images (e.g. ext4.zst, wic.zst) automatically. If a decompressed image already exists in the original directory, it will be reused to avoid overwriting build artifacts. Otherwise, the image is decompressed and removed after the QEMU session ends. This allows runqemu to be used seamlessly with compressed image formats generated by the build system or during releases. Note: support for .zst images is only available when snapshot mode is enabled IMPORTANT: This patch assumes that the original directory of the .zst-compressed image is writable. If, for some reason, the path passed from CI or another system to the script is read-only, the decompression step will fail when trying to write the uncompressed image to the same directory. Signed-off-by: Lamine REHAHLIA Signed-off-by: Yoann Congal --- v4: moved the feature to support calling "runqemu " and support usign snapshot after the image. Also improved the error message when a compressed image is used without snapshot mode. --- scripts/runqemu | 45 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) diff --git a/scripts/runqemu b/scripts/runqemu index 3d77046972..c668906bdd 100755 --- a/scripts/runqemu +++ b/scripts/runqemu @@ -197,7 +197,7 @@ class BaseConfig(object): self.portlocks = {} self.bitbake_e = '' self.snapshot = False - self.wictypes = ('wic', 'wic.vmdk', 'wic.qcow2', 'wic.vdi', "wic.vhd", "wic.vhdx") + self.wictypes = ('wic.zst', 'wic', 'wic.vmdk', 'wic.qcow2', 'wic.vdi', "wic.vhd", "wic.vhdx") self.fstypes = ('ext2', 'ext3', 'ext4', 'jffs2', 'nfs', 'btrfs', 'cpio.gz', 'cpio', 'ramfs', 'tar.bz2', 'tar.gz', 'squashfs', 'squashfs-xz', 'squashfs-lzo', @@ -418,6 +418,48 @@ class BaseConfig(object): else: raise RunQemuError("Unknown path arg %s" % p) + def uncompress_rootfs(self): + """Decompress ZST rootfs image if needed""" + if not self.rootfs or not self.fstype.endswith('.zst'): + return + + # Ensure snapshot mode is active before allowing decompression. + if not self.snapshot: + raise RunQemuError(".zst images are only supported with snapshot mode. " \ + "You can either use the \"snapshot\" option or use an uncompressed image.") + + # Get the real path to the image to avoid issues when a symbolic link is passed. + # This ensures we always operate on the actual file. + image_path = os.path.realpath(self.rootfs) + # Extract target filename by removing .zst + image_dir = os.path.dirname(image_path) + uncompressed_name = os.path.basename(image_path).replace(".zst", "") + uncompressed_path = os.path.join(image_dir, uncompressed_name) + + # If the decompressed image already exists (e.g., in the deploy directory), + # we use it directly to avoid overwriting artifacts generated by the build system. + # This prevents redundant decompression and preserves build outputs. + if os.path.exists(uncompressed_path): + logger.warning(f"Found existing decompressed image: {uncompressed_path}, Using it directly.") + else: + logger.info(f"Decompressing {self.rootfs} to {uncompressed_path}") + # Ensure the 'zstd' tool is installed before attempting to decompress. + if not shutil.which('zstd'): + raise RunQemuError(f"'zstd' is required to decompress {self.rootfs} but was not found in PATH") + try: + with open(uncompressed_path, 'wb') as out_file: + subprocess.check_call(['zstd', '-d', '-c', image_path], stdout=out_file) + except subprocess.CalledProcessError as e: + self.cleanup_files.append(uncompressed_path) + raise RunQemuError(f"Failed to decompress {self.rootfs}: {e}") + + # Mark for deletion at the end + self.cleanup_files.append(uncompressed_path) + + # Use the decompressed image as the rootfs + self.rootfs = uncompressed_path + self.fstype = self.fstype.removesuffix(".zst") + def check_arg_machine(self, arg): """Check whether it is a machine""" if self.get('MACHINE') == arg: @@ -1762,6 +1804,7 @@ def main(): config.check_args() config.read_qemuboot() config.check_and_set() + config.uncompress_rootfs() # Check whether the combos is valid or not config.validate_combos() config.print_config()