feat: Save the whole firmware path in annotation rather than just the firmware name (#21)

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

Author: yejseo01

internal/oci/annotations.go

@@ -12,7 +12,7 @@ const (
 	StateDriverPath   = "remoteproc.driver-path"
 	StateFirmwarePath = "remoteproc.firmware-path"
 
-	OptionalStateStoredFirmwareName = "remoteproc.stored-firmware-name"
+	OptionalStateStoredFirmwarePath = "remoteproc.stored-firmware-path"
 )
 
 func validateSpecAnnotations(spec *specs.Spec) error {

internal/remoteproc/remoteproc.go

@@ -107,21 +107,19 @@ func StoreFirmware(sourcePath string) (string, error) {
 	if err := os.WriteFile(destPath, data, 0o644); err != nil {
 		return "", fmt.Errorf("failed to write firmware file %s: %w", destPath, err)
 	}
-	return targetFileName, nil
+	return destPath, nil
 }
 
-func RemoveFirmware(firmwareFileName string) error {
-	return os.Remove(filepath.Join(rprocFirmwareStorePath, firmwareFileName))
-}
-
-func SetFirmware(devicePath string, firmwareFileName string) error {
+func SetFirmware(devicePath string, firmwareFilePath string) error {
 	state, err := GetState(devicePath)
 	if err != nil {
 		return fmt.Errorf("pre-flight state check failed: %w", err)
 	}
 	if state == StateRunning {
 		return fmt.Errorf("remote processor is already running")
 	}
+
+	firmwareFileName := filepath.Base(firmwareFilePath)
 	if err := os.WriteFile(buildFirmwareFilePath(devicePath), []byte(firmwareFileName), 0o644); err != nil {
 		return fmt.Errorf("failed to set firmware %s: %w", firmwareFileName, err)
 	}

internal/runtime/delete.go

@@ -3,10 +3,10 @@ package runtime
 import (
 	"fmt"
 	"log/slog"
+	"os"
 	"syscall"
 
 	"github.com/arm/remoteproc-runtime/internal/oci"
-	"github.com/arm/remoteproc-runtime/internal/remoteproc"
 	"github.com/opencontainers/runtime-spec/specs-go"
 )
 
@@ -29,9 +29,9 @@ func delete(containerID string) error {
 		return fmt.Errorf("cannot delete running container %s", containerID)
 	}
 
-	firmwareName, ok := state.Annotations[oci.OptionalStateStoredFirmwareName]
+	firmwarePath, ok := state.Annotations[oci.OptionalStateStoredFirmwarePath]
 	if ok {
-		if err := remoteproc.RemoveFirmware(firmwareName); err != nil {
+		if err := os.Remove(firmwarePath); err != nil {
 			return fmt.Errorf("failed to remove firmware: %w", err)
 		}
 	}
@@ -56,9 +56,9 @@ func forceDelete(logger *slog.Logger, containerID string) {
 		}
 	}
 
-	firmwareName, ok := state.Annotations[oci.OptionalStateStoredFirmwareName]
+	firmwarePath, ok := state.Annotations[oci.OptionalStateStoredFirmwarePath]
 	if ok {
-		if err := remoteproc.RemoveFirmware(firmwareName); err != nil {
+		if err := os.Remove(firmwarePath); err != nil {
 			logger.Error("failed to remove firmware", "error", err)
 		}
 	}

internal/runtime/start.go

@@ -2,6 +2,7 @@ package runtime
 
 import (
 	"fmt"
+	"os"
 
 	"github.com/arm/remoteproc-runtime/internal/oci"
 	"github.com/arm/remoteproc-runtime/internal/proxy"
@@ -15,21 +16,21 @@ func Start(containerID string) error {
 		return fmt.Errorf("failed to read state: %w", err)
 	}
 	firmwarePath := state.Annotations[oci.StateFirmwarePath]
-	storedFirmwareName, err := remoteproc.StoreFirmware(firmwarePath)
+	storedFirmwarePath, err := remoteproc.StoreFirmware(firmwarePath)
 	if err != nil {
 		return fmt.Errorf("failed to store firmware file %s: %w", firmwarePath, err)
 	}
-	state.Annotations[oci.OptionalStateStoredFirmwareName] = storedFirmwareName
+	state.Annotations[oci.OptionalStateStoredFirmwarePath] = storedFirmwarePath
 	needCleanup := true
 	defer func() {
 		if needCleanup {
-			_ = remoteproc.RemoveFirmware(storedFirmwareName)
+			_ = os.Remove(storedFirmwarePath)
 		}
 	}()
 
 	if err := remoteproc.SetFirmware(
 		state.Annotations[oci.StateDriverPath],
-		storedFirmwareName,
+		storedFirmwarePath,
 	); err != nil {
 		return fmt.Errorf("failed to set firmware: %w", err)
 	}