refactor(usb-reset): use UsbResetMode enum instead of bool

Author: ym

internal/usbgadget/config.go

@@ -24,6 +24,14 @@ type gadgetConfigItemWithKey struct {
 
 type orderedGadgetConfigItems []gadgetConfigItemWithKey
 
+type UsbResetMode uint8
+
+const (
+	UsbResetNever    UsbResetMode = 0 // never reset the usb gadget
+	UsbResetAlways   UsbResetMode = 1 // always reset the usb gadget
+	UsbResetOnDemand UsbResetMode = 2 // reset the usb gadget when needed
+)
+
 var defaultGadgetConfig = map[string]gadgetConfigItem{
 	"base": {
 		order: 0,
@@ -177,34 +185,31 @@ func (u *UsbGadget) Init() error {
 
 	u.udc = udcs[0]
 
-	err := u.configureUsbGadget(false, true)
+	err := u.configureUsbGadget(UsbResetAlways)
 	if err != nil {
 		return u.logError("unable to initialize USB stack", err)
 	}
 
 	return nil
 }
 
-func (u *UsbGadget) UpdateGadgetConfig(resetUsbIfNeeded bool) error {
+func (u *UsbGadget) UpdateGadgetConfig(resetUsbMode UsbResetMode) error {
 	u.configLock.Lock()
 	defer u.configLock.Unlock()
 
 	u.loadGadgetConfig()
 
-	err := u.configureUsbGadget(true, resetUsbIfNeeded)
+	err := u.configureUsbGadget(resetUsbMode)
 	if err != nil {
 		return u.logError("unable to update gadget config", err)
 	}
 
 	return nil
 }
 
-func (u *UsbGadget) configureUsbGadget(resetUsb bool, resetUsbIfNeeded bool) error {
-	f := func(resetUsbBefore bool, resetUsbAfter bool) func() error {
+func (u *UsbGadget) configureUsbGadget(resetUsbMode UsbResetMode) error {
+	f := func(resetUsbAfter bool) func() error {
 		return func() error {
-			if resetUsbBefore {
-				u.tx.RebindUsb(true)
-			}
 			u.tx.MountConfigFS()
 			u.tx.CreateConfigPath()
 			u.tx.WriteGadgetConfig()
@@ -216,11 +221,21 @@ func (u *UsbGadget) configureUsbGadget(resetUsb bool, resetUsbIfNeeded bool) err
 	}
 
 	// initial attempt to configure the gadget
-	err := u.WithTransaction(f(false, resetUsb))
-	if err != nil && !resetUsbIfNeeded {
-		return err
+	err := u.WithTransaction(f(resetUsbMode == UsbResetAlways))
+	if err == nil {
+		return nil
 	}
 
 	// if the initial attempt failed, try to configure the gadget again with the resetUsb flag
-	return u.WithTransaction(f(true, resetUsb))
+	if resetUsbMode == UsbResetOnDemand {
+		u.log.Warn().Err(err).Msg("initial attempt to configure the gadget failed, resetting USB gadget then trying again")
+		// NOTES: do not use the RebindUsb method here because it will block the transaction
+		if err := u.rebindUsb(true); err != nil {
+			u.log.Warn().Err(err).Msg("failed to reset USB gadget, skipping second attempt")
+			return err
+		}
+		return u.WithTransaction(f(true))
+	}
+
+	return err
 }

jsonrpc.go

@@ -678,7 +678,7 @@ func rpcSetUsbConfig(usbConfig usbgadget.Config) error {
 	LoadConfig()
 	config.UsbConfig = &usbConfig
 	gadget.SetGadgetConfig(config.UsbConfig)
-	return updateUsbRelatedConfig(false)
+	return updateUsbRelatedConfig(usbgadget.UsbResetAlways)
 }
 
 func rpcGetWakeOnLanDevices() ([]WakeOnLanDevice, error) {
@@ -890,8 +890,8 @@ func rpcGetUsbDevices() (usbgadget.Devices, error) {
 	return *config.UsbDevices, nil
 }
 
-func updateUsbRelatedConfig(resetUsbIfNeeded bool) error {
-	if err := gadget.UpdateGadgetConfig(resetUsbIfNeeded); err != nil {
+func updateUsbRelatedConfig(resetUsbMode usbgadget.UsbResetMode) error {
+	if err := gadget.UpdateGadgetConfig(resetUsbMode); err != nil {
 		return fmt.Errorf("failed to write gadget config: %w", err)
 	}
 	if err := SaveConfig(); err != nil {
@@ -903,7 +903,7 @@ func updateUsbRelatedConfig(resetUsbIfNeeded bool) error {
 func rpcSetUsbDevices(usbDevices usbgadget.Devices) error {
 	config.UsbDevices = &usbDevices
 	gadget.SetGadgetDevices(config.UsbDevices)
-	return updateUsbRelatedConfig(false)
+	return updateUsbRelatedConfig(usbgadget.UsbResetOnDemand)
 }
 
 func rpcSetUsbDeviceState(device string, enabled bool) error {
@@ -920,7 +920,7 @@ func rpcSetUsbDeviceState(device string, enabled bool) error {
 		return fmt.Errorf("invalid device: %s", device)
 	}
 	gadget.SetGadgetDevices(config.UsbDevices)
-	return updateUsbRelatedConfig(false)
+	return updateUsbRelatedConfig(usbgadget.UsbResetAlways)
 }
 
 func rpcSetCloudUrl(apiUrl string, appUrl string) error {

usb_mass_storage.go

@@ -19,6 +19,7 @@ import (
 	"github.com/pion/webrtc/v4"
 	"github.com/psanford/httpreadat"
 
+	"github.com/jetkvm/kvm/internal/usbgadget"
 	"github.com/jetkvm/kvm/resource"
 )
 
@@ -40,7 +41,7 @@ func setMassStorageImage(imagePath string) error {
 		return fmt.Errorf("failed to set mass storage path: %w", err)
 	}
 
-	if err := gadget.UpdateGadgetConfig(true); err != nil {
+	if err := gadget.UpdateGadgetConfig(usbgadget.UsbResetOnDemand); err != nil {
 		return fmt.Errorf("failed to update gadget config: %w", err)
 	}
 
@@ -62,7 +63,7 @@ func setMassStorageMode(cdrom bool) error {
 		return nil
 	}
 
-	return gadget.UpdateGadgetConfig(true)
+	return gadget.UpdateGadgetConfig(usbgadget.UsbResetOnDemand)
 }
 
 func mountImage(imagePath string) error {