CLOUDSTACK-8854: Apple Mac OS/X VM get created without USB controller in ESXi hypervisors

Author: Suresh Kumar Anaparti

plugins/hypervisors/vmware/src/com/cloud/hypervisor/vmware/resource/VmwareResource.java

@@ -80,6 +80,7 @@
 import com.vmware.vim25.VirtualDeviceBackingInfo;
 import com.vmware.vim25.VirtualDeviceConfigSpec;
 import com.vmware.vim25.VirtualDeviceConfigSpecOperation;
+import com.vmware.vim25.VirtualUSBController;
 import com.vmware.vim25.VirtualDisk;
 import com.vmware.vim25.VirtualDiskFlatVer2BackingInfo;
 import com.vmware.vim25.VirtualEthernetCard;
@@ -1872,6 +1873,29 @@ protected StartAnswer execute(StartCommand cmd) {
                 }
             }
 
+            //
+            // Setup USB devices
+            //
+            if (guestOsId.startsWith("darwin")) { //Mac OS
+                VirtualDevice[] devices = vmMo.getMatchedDevices(new Class<?>[] {VirtualUSBController.class});
+                if (devices.length == 0) {
+                    s_logger.debug("No USB Controller device on VM Start. Add USB Controller device for Mac OS VM " + vmInternalCSName);
+
+                    //For Mac OS X systems, the EHCI+UHCI controller is enabled by default and is required for USB mouse and keyboard access.
+                    VirtualDevice usbControllerDevice = VmwareHelper.prepareUSBControllerDevice();
+                    deviceConfigSpecArray[i] = new VirtualDeviceConfigSpec();
+                    deviceConfigSpecArray[i].setDevice(usbControllerDevice);
+                    deviceConfigSpecArray[i].setOperation(VirtualDeviceConfigSpecOperation.ADD);
+
+                    if (s_logger.isDebugEnabled())
+                        s_logger.debug("Prepare USB controller at new device " + _gson.toJson(deviceConfigSpecArray[i]));
+
+                    i++;
+                } else {
+                    s_logger.debug("USB Controller device exists on VM Start for Mac OS VM " + vmInternalCSName);
+                }
+            }
+
             //
             // Setup NIC devices
             //

vmware-base/src/com/cloud/hypervisor/vmware/mo/HypervisorHostHelper.java

@@ -77,6 +77,7 @@
 import com.vmware.vim25.VMwareDVSPvlanMapEntry;
 import com.vmware.vim25.VirtualBusLogicController;
 import com.vmware.vim25.VirtualController;
+import com.vmware.vim25.VirtualDevice;
 import com.vmware.vim25.VirtualDeviceConfigSpec;
 import com.vmware.vim25.VirtualDeviceConfigSpecOperation;
 import com.vmware.vim25.VirtualIDEController;
@@ -1291,6 +1292,18 @@ public static boolean createBlankVm(VmwareHypervisorHost host, String vmName, St
             }
         }
 
+        if (guestOsIdentifier.startsWith("darwin")) { //Mac OS
+            s_logger.debug("Add USB Controller device for blank Mac OS VM " + vmName);
+
+            //For Mac OS X systems, the EHCI+UHCI controller is enabled by default and is required for USB mouse and keyboard access.
+            VirtualDevice usbControllerDevice = VmwareHelper.prepareUSBControllerDevice();
+            VirtualDeviceConfigSpec usbControllerSpec = new VirtualDeviceConfigSpec();
+            usbControllerSpec.setDevice(usbControllerDevice);
+            usbControllerSpec.setOperation(VirtualDeviceConfigSpecOperation.ADD);
+
+            vmConfig.getDeviceChange().add(usbControllerSpec);
+        }
+
         VirtualMachineFileInfo fileInfo = new VirtualMachineFileInfo();
         DatastoreMO dsMo = new DatastoreMO(host.getContext(), morDs);
         fileInfo.setVmPathName(String.format("[%s]", dsMo.getName()));

vmware-base/src/com/cloud/hypervisor/vmware/util/VmwareHelper.java

@@ -46,6 +46,7 @@
 import com.vmware.vim25.VirtualDevice;
 import com.vmware.vim25.VirtualDeviceBackingInfo;
 import com.vmware.vim25.VirtualDeviceConnectInfo;
+import com.vmware.vim25.VirtualUSBController;
 import com.vmware.vim25.VirtualDisk;
 import com.vmware.vim25.VirtualDiskFlatVer1BackingInfo;
 import com.vmware.vim25.VirtualDiskFlatVer2BackingInfo;
@@ -651,6 +652,15 @@ public static void setBasicVmConfig(VirtualMachineConfigSpec vmConfig, int cpuCo
         vmConfig.setGuestId(guestOsIdentifier);
     }
 
+    public static VirtualDevice prepareUSBControllerDevice() {
+        s_logger.debug("Preparing USB controller(EHCI+UHCI) device");
+        VirtualUSBController usbController = new VirtualUSBController(); //EHCI+UHCI
+        usbController.setEhciEnabled(true);
+        usbController.setAutoConnectDevices(true);
+
+        return usbController;
+    }
+
     public static ManagedObjectReference getDiskDeviceDatastore(VirtualDisk diskDevice) throws Exception {
         VirtualDeviceBackingInfo backingInfo = diskDevice.getBacking();
         assert (backingInfo instanceof VirtualDiskFlatVer2BackingInfo);