feat: Copy firmware when container starts not when it's created (#18)

Signed-off-by: Yejin Seo <yejseo01@arm.com>

Author: yejseo01

internal/oci/annotations.go

@@ -9,8 +9,10 @@ import (
 const (
 	SpecName = "remoteproc.name"
 
-	StateResolvedPath = "remoteproc.resolved-path"
-	StateFirmware     = "remoteproc.firmware"
+	StateDriverPath   = "remoteproc.driver-path"
+	StateFirmwarePath = "remoteproc.firmware-path"
+
+	OptionalStateStoredFirmwareName = "remoteproc.stored-firmware-name"
 )
 
 func validateSpecAnnotations(spec *specs.Spec) error {
@@ -22,7 +24,7 @@ func validateSpecAnnotations(spec *specs.Spec) error {
 }
 
 func validateStateAnnotations(state *specs.State) error {
-	return validateAnnotationsExist(state.Annotations, StateResolvedPath, StateFirmware)
+	return validateAnnotationsExist(state.Annotations, StateDriverPath, StateFirmwarePath)
 }
 
 func validateAnnotationsExist(annotations map[string]string, keys ...string) error {

internal/runtime/create.go

@@ -35,21 +35,12 @@ func Create(containerID string, bundlePath string, pidFile string) error {
 	if err := validateFirmwareExists(firmwarePath); err != nil {
 		return err
 	}
-	storedFirmwareName, err := remoteproc.StoreFirmware(firmwarePath)
-	if err != nil {
-		return fmt.Errorf("failed to store firmware file %s: %w", firmwarePath, err)
-	}
-	needCleanup := true
-	defer func() {
-		if needCleanup {
-			_ = remoteproc.RemoveFirmware(storedFirmwareName)
-		}
-	}()
 
 	pid, err := proxy.NewProcess(devicePath)
 	if err != nil {
 		return fmt.Errorf("failed to start proxy process: %w", err)
 	}
+	needCleanup := true
 	defer func() {
 		if needCleanup {
 			_ = proxy.StopFirmware(pid)
@@ -58,8 +49,8 @@ func Create(containerID string, bundlePath string, pidFile string) error {
 
 	state := oci.NewState(containerID, bundlePath)
 	state.Pid = pid
-	state.Annotations[oci.StateResolvedPath] = devicePath
-	state.Annotations[oci.StateFirmware] = storedFirmwareName
+	state.Annotations[oci.StateDriverPath] = devicePath
+	state.Annotations[oci.StateFirmwarePath] = firmwarePath
 	if err := oci.WriteState(state); err != nil {
 		return err
 	}

internal/runtime/delete.go

@@ -29,7 +29,12 @@ func delete(containerID string) error {
 		return fmt.Errorf("cannot delete running container %s", containerID)
 	}
 
-	_ = remoteproc.RemoveFirmware(state.Annotations[oci.StateFirmware])
+	firmwareName, ok := state.Annotations[oci.OptionalStateStoredFirmwareName]
+	if ok {
+		if err := remoteproc.RemoveFirmware(firmwareName); err != nil {
+			return fmt.Errorf("failed to remove firmware: %w", err)
+		}
+	}
 
 	if err := oci.RemoveState(containerID); err != nil {
 		return fmt.Errorf("failed to remove state: %w", err)
@@ -51,8 +56,11 @@ func forceDelete(logger *slog.Logger, containerID string) {
 		}
 	}
 
-	if err := remoteproc.RemoveFirmware(state.Annotations[oci.StateFirmware]); err != nil {
-		logger.Error("failed to remove firmware", "error", err)
+	firmwareName, ok := state.Annotations[oci.OptionalStateStoredFirmwareName]
+	if ok {
+		if err := remoteproc.RemoveFirmware(firmwareName); err != nil {
+			logger.Error("failed to remove firmware", "error", err)
+		}
 	}
 
 	if err := oci.RemoveState(containerID); err != nil {

internal/runtime/start.go

@@ -14,10 +14,22 @@ func Start(containerID string) error {
 	if err != nil {
 		return fmt.Errorf("failed to read state: %w", err)
 	}
+	firmwarePath := state.Annotations[oci.StateFirmwarePath]
+	storedFirmwareName, err := remoteproc.StoreFirmware(firmwarePath)
+	if err != nil {
+		return fmt.Errorf("failed to store firmware file %s: %w", firmwarePath, err)
+	}
+	state.Annotations[oci.OptionalStateStoredFirmwareName] = storedFirmwareName
+	needCleanup := true
+	defer func() {
+		if needCleanup {
+			_ = remoteproc.RemoveFirmware(storedFirmwareName)
+		}
+	}()
 
 	if err := remoteproc.SetFirmware(
-		state.Annotations[oci.StateResolvedPath],
-		state.Annotations[oci.StateFirmware],
+		state.Annotations[oci.StateDriverPath],
+		storedFirmwareName,
 	); err != nil {
 		return fmt.Errorf("failed to set firmware: %w", err)
 	}
@@ -31,5 +43,6 @@ func Start(containerID string) error {
 		return fmt.Errorf("failed to write state: %w", err)
 	}
 
+	needCleanup = false
 	return nil
 }