From e06640f8f1170ad868db3ecb1af9ff1d2f60c1a2 Mon Sep 17 00:00:00 2001
From: Patrick Vacek <patrickvacek@gmail.com>
Date: Fri, 6 Sep 2019 16:42:37 +0200
Subject: Copy the image and U-Boot rom when using overlays.

Since bitbake can remove old images that an overlay was non-obviously
dependent on, the safest thing to do is make a copy of the image and
keep it alongside the overlay. When using the overlay later,
automatically use that image. Also do the same thing with the U-Boot
rom. This should also make moving the overlay file to another machine
much easier.

Signed-off-by: Patrick Vacek <patrickvacek@gmail.com>
---
 scripts/qemucommand.py | 50 ++++++++++++++++++++++++++++++++++++++++++--------
 scripts/run-qemu-ota   |  2 +-
 2 files changed, 43 insertions(+), 9 deletions(-)

diff --git a/scripts/qemucommand.py b/scripts/qemucommand.py
index a869d4d..9b23c54 100644
--- a/scripts/qemucommand.py
+++ b/scripts/qemucommand.py
@@ -2,6 +2,7 @@ from os.path import exists, isdir, join, realpath, abspath
 from os import listdir
 import random
 import socket
+from shutil import copyfile
 from subprocess import check_output
 
 EXTENSIONS = {
@@ -39,6 +40,8 @@ def random_mac():
 
 class QemuCommand(object):
     def __init__(self, args):
+        self.dry_run = args.dry_run
+        self.overlay = args.overlay
         if args.machine:
             self.machine = args.machine
         else:
@@ -49,21 +52,53 @@ class QemuCommand(object):
                 self.machine = machines[0]
             else:
                 raise ValueError("Could not autodetect machine type. More than one entry in %s. Maybe --machine qemux86-64?" % args.dir)
+
+        # If using an overlay with U-Boot, copy the rom when we create the
+        # overlay so that we can keep it around just in case.
         if args.efi:
             self.bios = 'OVMF.fd'
         else:
-            uboot = abspath(join(args.dir, self.machine, 'u-boot-qemux86-64.rom'))
-            if not exists(uboot):
-                raise ValueError("U-Boot image %s does not exist" % uboot)
-            self.bios = uboot
+            uboot_path = abspath(join(args.dir, self.machine, 'u-boot-qemux86-64.rom'))
+            if self.overlay:
+                new_uboot_path = self.overlay + '.u-boot.rom'
+                if not exists(self.overlay):
+                    if not exists(uboot_path):
+                        raise ValueError("U-Boot image %s does not exist" % uboot_path)
+                    if not exists(new_uboot_path):
+                        if self.dry_run:
+                            print("cp %s %s" % (uboot_path, new_uboot_path))
+                        else:
+                            copyfile(uboot_path, new_uboot_path)
+                uboot_path = new_uboot_path
+            if not exists(uboot_path) and not (self.dry_run and not exists(self.overlay)):
+                raise ValueError("U-Boot image %s does not exist" % uboot_path)
+            self.bios = uboot_path
+
+        # If using an overlay, we need to keep the "backing" image around, as
+        # bitbake will often clean it up, and the overlay silently depends on
+        # the hardcoded path. The easiest solution is to keep the file and use
+        # a relative path to it.
         if exists(args.imagename):
-            image = args.imagename
+            image = realpath(args.imagename)
         else:
             ext = EXTENSIONS.get(self.machine, 'wic')
             image = join(args.dir, self.machine, '%s-%s.%s' % (args.imagename, self.machine, ext))
-        self.image = realpath(image)
-        if not exists(self.image):
+        if self.overlay:
+            new_image_path = self.overlay + '.img'
+            if not exists(self.overlay):
+                if not exists(image):
+                    raise ValueError("OS image %s does not exist" % image)
+                if not exists(new_image_path):
+                    if self.dry_run:
+                        print("cp %s %s" % (image, new_image_path))
+                    else:
+                        copyfile(image, new_image_path)
+            self.image = new_image_path
+        else:
+            self.image = realpath(image)
+        if not exists(self.image) and not (self.dry_run and not exists(self.overlay)):
             raise ValueError("OS image %s does not exist" % self.image)
+
         if args.mac:
             self.mac_address = args.mac
         else:
@@ -86,7 +121,6 @@ class QemuCommand(object):
         self.gui = not args.no_gui
         self.gdb = args.gdb
         self.pcap = args.pcap
-        self.overlay = args.overlay
         self.secondary_network = args.secondary_network
 
     def command_line(self):
diff --git a/scripts/run-qemu-ota b/scripts/run-qemu-ota
index de63297..e9f44d6 100755
--- a/scripts/run-qemu-ota
+++ b/scripts/run-qemu-ota
@@ -53,7 +53,7 @@ def main():
 
     cmdline = qemu_command.command_line()
     if args.overlay and not exists(args.overlay):
-        print("Image file %s does not yet exist, creating." % args.overlay)
+        print("Overlay file %s does not yet exist, creating." % args.overlay)
         img_cmdline = qemu_command.img_command_line()
         if args.dry_run:
             print(" ".join(img_cmdline))
-- 
cgit v1.2.3-54-g00ecf