Changeset 48538 in vbox for trunk/src/VBox/Main

Timestamp:

Sep 19, 2013 3:17:43 PM (12 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

89083

Message:

Main/NetworkAdapter+Machine+Appliance+SystemProperties+Medium+Console+Settings+IDL: make NAT networking a separate network attachment type which improves the user experience, store the necessary settings, plus changing the design of the methods which will move images and entire VMs, they lacked a progress object
Frontends/VirtualBox: adapted fully, can configure NAT networks with proper drop down list support
Frontends/VBoxManage: also supports NAT networks completely, and adds the long missing code to list intnets

Location:

trunk/src/VBox/Main

Files:

• idl/VirtualBox.xidl (modified) (11 diffs)
• include/MachineImpl.h (modified) (2 diffs)
• include/MediumImpl.h (modified) (2 diffs)
• src-client/ConsoleImpl2.cpp (modified) (2 diffs)
• src-server/ApplianceImpl.cpp (modified) (3 diffs)
• src-server/ApplianceImplImport.cpp (modified) (4 diffs)
• src-server/MachineImpl.cpp (modified) (2 diffs)
• src-server/MediumImpl.cpp (modified) (3 diffs)
• src-server/NetworkAdapterImpl.cpp (modified) (8 diffs)
• src-server/SystemPropertiesImpl.cpp (modified) (1 diff)
• xml/Settings.cpp (modified) (5 diffs)

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -1383 +1383 @@
   /////////////////////////////////////////////////////////////////////////
   -->
-  <!-- This is experimental interface to LWIP based NAT server -->
+
   <interface name="INATNetwork" extends="$unknown"
     uuid="a63c75da-4c99-4e9d-8351-eb73651c18cc"
@@ -2586 +2586 @@
       <!-- Here we create a record in NAT network array with name
            and gateway/network parameters this information should
-           be enough for VBoxNet[Lwip]NAT and VBoxNetDHCP for
+           be enough for VBoxNetNAT and VBoxNetDHCP for
            servicing the guests.
       -->
@@ -4122 +4122 @@
   <interface
     name="IMachine" extends="$unknown"
-    uuid="8c931034-83f6-46b8-97f0-31e70d30402e"
+    uuid="7108c7c7-2c0a-47ee-9c69-022fe2a466bf"
     wsmap="managed"
     >
@@ -4548 +4548 @@
     </attribute>
 
-    <attribute name="settingsFilePath" type="wstring">
+    <attribute name="settingsFilePath" type="wstring" readonly="yes">
       <desc>
         Full name of the file containing machine settings data.
-
-        Currently, it is an error to change this property on any machine.
-        Later this will allow setting a new path for the settings file, with
-        automatic relocation of all files (including snapshots and disk images)
-        which are inside the base directory.
-
-        <note>
-          Setting this property to @c null or to an empty string is forbidden. 
-        </note>
-        <note>
-          When setting this property, the specified path must be absolute. When
-          reading this property, an absolute (full) path is always returned.
-        </note>
-        <note>
-          The specified path may not exist, it will be created when necessary.
-        </note>
       </desc>
     </attribute>
@@ -6313 +6297 @@
           New property value.
         </desc>
+      </param>
+    </method>
+
+    <method name="setSettingsFilePath">
+      <desc>
+        Currently, it is an error to change this property on any machine.
+        Later this will allow setting a new path for the settings file, with
+        automatic relocation of all files (including snapshots and disk images)
+        which are inside the base directory. This operation is only allowed
+        when there are no pending unsaved settings.
+
+        <note>
+          Setting this property to @c null or to an empty string is forbidden. 
+          When setting this property, the specified path must be absolute.
+          The specified path may not exist, it will be created when necessary.
+        </note>
+
+        <result name="E_NOTIMPL">
+          The operation is not implemented yet.
+        </result>
+      </desc>
+
+      <param name="settingsFilePath" type="wstring" dir="in">
+        <desc>New settings file path, will be used to determine the new
+        location for the attached media if it is in the same directory or
+        below as the original settings file.</desc>
+      </param>
+      <param name="progress" type="IProgress" dir="return">
+        <desc>Progress object to track the operation completion.</desc>
       </param>
     </method>
@@ -13045 +13058 @@
   <interface
     name="IMedium" extends="$unknown"
-    uuid="8df5fc17-503a-4171-85bc-039b6f24d86b"
+    uuid="05f2bbb6-a3a6-4fb9-9b49-6d0dda7142ac"
     wsmap="managed"
     >
@@ -13259 +13272 @@
     </attribute>
 
-    <attribute name="location" type="wstring">
+    <attribute name="location" type="wstring" readonly="yes">
       <desc>
         Location of the storage unit holding medium data.
@@ -13266 +13279 @@
         types using regular files in a host's file system, the location
         string is the full file name.
-
-        Some medium types may support changing the storage unit location by
-        simply changing the value of this property. If this operation is not
-        supported, the implementation will return E_NOTIMPL in attempt to set
-        this attribute's value.
-
-        When setting a value of the location attribute which is a regular file
-        in the host's file system, the given file name may be either relative to
-        the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
-        absolute. Note that if the given location specification does not contain
-        the file extension part then a proper default extension will be
-        automatically appended by the implementation depending on the medium type.
       </desc>
     </attribute>
@@ -14186 +14187 @@
     <!-- other methods -->
 
+    <method name="setLocation">
+      <desc>
+        Changes the location of this medium. Some medium types may support
+        changing the storage unit location by simply changing the value of the
+        associated property. In this case the operation is performed
+        immediately, and @a progress is returning a @c null reference.
+        Otherwise on success there is a progress object returned, which
+        signals progress and completion of the operation. This distinction is
+        necessary because for some formats the operation is very fast, while
+        for others it can be very slow (moving the image file by copying all
+        data), and in the former case it'd be a waste of resources to create
+        a progress object which will immediately signal completion.
+
+        When setting a location for a medium which corresponds to a/several
+        regular file(s) in the host's file system, the given file name may be
+        either relative to the <link to="IVirtualBox::homeFolder">VirtualBox
+        home folder</link> or absolute. Note that if the given location
+        specification does not contain the file extension part then a proper
+        default extension will be automatically appended by the implementation
+        depending on the medium type.
+
+        <result name="E_NOTIMPL">
+          The operation is not implemented yet.
+        </result>
+        <result name="VBOX_E_NOT_SUPPORTED">
+          Medium format does not support changing the location.
+        </result>
+      </desc>
+      <param name="location" type="wstring" dir="in">
+        <desc>New location.</desc>
+      </param>
+      <param name="progress" type="IProgress" dir="return">
+        <desc>Progress object to track the operation completion.</desc>
+      </param>
+    </method>
+
     <method name="compact">
       <desc>
@@ -15651 +15688 @@
   <enum
     name="NetworkAttachmentType"
-    uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
+    uuid="524a8f9d-4b86-4b51-877d-1aa27c4ebeac"
     >
     <desc>
@@ -15665 +15702 @@
     <const name="HostOnly"              value="4"/>
     <const name="Generic"               value="5"/>
+    <const name="NATNetwork"            value="6"/>
   </enum>
 

trunk/src/VBox/Main/include/MachineImpl.h

@@ -457 +457 @@
     STDMETHOD(COMGETTER(USBDeviceFilters))(IUSBDeviceFilters * *aUSBDeviceFilters);
     STDMETHOD(COMGETTER(SettingsFilePath))(BSTR *aFilePath);
-    STDMETHOD(COMSETTER(SettingsFilePath))(IN_BSTR aFilePath);
     STDMETHOD(COMGETTER(SettingsModified))(BOOL *aModified);
     STDMETHOD(COMGETTER(SessionState))(SessionState_T *aSessionState);
@@ -568 +567 @@
     STDMETHOD(GetHWVirtExProperty)(HWVirtExPropertyType_T property, BOOL *aVal);
     STDMETHOD(SetHWVirtExProperty)(HWVirtExPropertyType_T property, BOOL aVal);
+    STDMETHOD(SetSettingsFilePath)(IN_BSTR aFilePath, IProgress **aProgress);
     STDMETHOD(SaveSettings)();
     STDMETHOD(DiscardSettings)();

trunk/src/VBox/Main/include/MediumImpl.h

@@ -106 +106 @@
     STDMETHOD(COMGETTER(Variant))(ComSafeArrayOut(MediumVariant_T, aVariant));
     STDMETHOD(COMGETTER(Location))(BSTR *aLocation);
-    STDMETHOD(COMSETTER(Location))(IN_BSTR aLocation);
     STDMETHOD(COMGETTER(Name))(BSTR *aName);
     STDMETHOD(COMGETTER(DeviceType))(DeviceType_T *aDeviceType);
@@ -154 +153 @@
     STDMETHOD(CloneToBase)(IMedium *aTarget, ComSafeArrayIn(MediumVariant_T, aVariant),
                            IProgress **aProgress);
+    STDMETHOD(SetLocation)(IN_BSTR aLocation, IProgress **aProgress);
     STDMETHOD(Compact)(IProgress **aProgress);
     STDMETHOD(Resize)(LONG64 aLogicalSize, IProgress **aProgress);

trunk/src/VBox/Main/src-client/ConsoleImpl2.cpp

@@ -4857 +4857 @@
             }
 
+            case NetworkAttachmentType_NATNetwork:
+            {
+                hrc = aNetworkAdapter->COMGETTER(NATNetwork)(bstr.asOutParam());            H();
+                if (!bstr.isEmpty())
+                {
+                    /** @todo add intnet prefix to separate namespaces, and add trunk if dealing with vboxnatX */
+                    InsertConfigString(pLunL0, "Driver", "IntNet");
+                    InsertConfigNode(pLunL0, "Config", &pCfg);
+                    InsertConfigString(pCfg, "Network", bstr);
+                    InsertConfigInteger(pCfg, "TrunkType", kIntNetTrunkType_WhateverNone);
+                    InsertConfigString(pCfg, "IfPolicyPromisc", pszPromiscuousGuestPolicy);
+                    networkName = bstr;
+                    trunkType = Bstr(TRUNKTYPE_WHATEVER);
+                }
+                break;
+            }
+
             default:
                 AssertMsgFailed(("should not get here!\n"));
@@ -4875 +4892 @@
             case NetworkAttachmentType_NAT:
             case NetworkAttachmentType_Generic:
+            case NetworkAttachmentType_NATNetwork:
             {
                 if (SUCCEEDED(hrc) && SUCCEEDED(rc))

trunk/src/VBox/Main/src-server/ApplianceImpl.cpp

@@ -6 +6 @@
 
 /*
- * Copyright (C) 2008-2012 Oracle Corporation
+ * Copyright (C) 2008-2013 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -305 +305 @@
         case NetworkAttachmentType_HostOnly: strType = "HostOnly"; break;
         case NetworkAttachmentType_Generic: strType = "Generic"; break;
+        case NetworkAttachmentType_NATNetwork: strType = "NATNetwork"; break;
         case NetworkAttachmentType_Null: strType = "Null"; break;
     }
@@ -775 +776 @@
     /** @todo: Maybe too cost-intensive; try to find a lighter way */
     while (    RTPathExists(tmpName)
-            || mVirtualBox->OpenMedium(Bstr(tmpName).raw(), DeviceType_HardDisk, AccessMode_ReadWrite, FALSE /* fForceNewUuid */,  &harddisk) != VBOX_E_OBJECT_NOT_FOUND 
+            || mVirtualBox->OpenMedium(Bstr(tmpName).raw(), DeviceType_HardDisk, AccessMode_ReadWrite, FALSE /* fForceNewUuid */,  &harddisk) != VBOX_E_OBJECT_NOT_FOUND
           )
     {

trunk/src/VBox/Main/src-server/ApplianceImplImport.cpp

@@ -2714 +2714 @@
                         if (FAILED(rc)) throw rc;
                         /* Set the interface name to attach to */
-                        pNetworkAdapter->COMSETTER(BridgedInterface)(name.raw());
+                        rc = pNetworkAdapter->COMSETTER(BridgedInterface)(name.raw());
                         if (FAILED(rc)) throw rc;
                         break;
@@ -2747 +2747 @@
                         if (FAILED(rc)) throw rc;
                         /* Set the interface name to attach to */
-                        pNetworkAdapter->COMSETTER(HostOnlyInterface)(name.raw());
+                        rc = pNetworkAdapter->COMSETTER(HostOnlyInterface)(name.raw());
                         if (FAILED(rc)) throw rc;
                         break;
@@ -2766 +2766 @@
                 rc = pNetworkAdapter->COMSETTER(AttachmentType)(NetworkAttachmentType_Generic);
                 if (FAILED(rc)) throw rc;
+            }
+            /* Next test for NAT network interfaces */
+            else if (pvsys->strExtraConfigCurrent.endsWith("type=NATNetwork", Utf8Str::CaseInsensitive))
+            {
+                /* Attach to the right interface */
+                rc = pNetworkAdapter->COMSETTER(AttachmentType)(NetworkAttachmentType_NATNetwork);
+                if (FAILED(rc)) throw rc;
+                com::SafeIfaceArray<INATNetwork> nwNATNetworks;
+                rc = mVirtualBox->COMGETTER(NATNetworks)(ComSafeArrayAsOutParam(nwNATNetworks));
+                if (FAILED(rc)) throw rc;
+                // Pick the first NAT network (if there is any)
+                if (nwNATNetworks.size())
+                {
+                    Bstr name;
+                    rc = nwNATNetworks[0]->COMGETTER(NetworkName)(name.asOutParam());
+                    if (FAILED(rc)) throw rc;
+                    /* Set the NAT network name to attach to */
+                    rc = pNetworkAdapter->COMSETTER(NATNetwork)(name.raw());
+                    if (FAILED(rc)) throw rc;
+                    break;
+                }
             }
         }
@@ -3325 +3346 @@
         it1->fEnabled = false;
         if (!(   fKeepAllMACs
-              || (fKeepNATMACs && it1->mode == NetworkAttachmentType_NAT)))
+              || (fKeepNATMACs && it1->mode == NetworkAttachmentType_NAT)
+              || (fKeepNATMACs && it1->mode == NetworkAttachmentType_NATNetwork)))
             Host::generateMACAddress(it1->strMACAddress);
     }

trunk/src/VBox/Main/src-server/MachineImpl.cpp

@@ -2752 +2752 @@
     mData->m_strConfigFileFull.cloneTo(aFilePath);
     return S_OK;
-}
-
-STDMETHODIMP Machine::COMSETTER(SettingsFilePath)(IN_BSTR aFilePath)
-{
-    CheckComArgStrNotEmptyOrNull(aFilePath);
-
-    AutoCaller autoCaller(this);
-    if (FAILED(autoCaller.rc())) return autoCaller.rc();
-
-    ReturnComNotImplemented();
 }
 
@@ -5287 +5277 @@
 
     return S_OK;
+}
+
+STDMETHODIMP Machine::SetSettingsFilePath(IN_BSTR aFilePath, IProgress **aProgress)
+{
+    CheckComArgStrNotEmptyOrNull(aFilePath);
+    CheckComArgOutPointerValid(aProgress);
+
+    AutoCaller autoCaller(this);
+    if (FAILED(autoCaller.rc())) return autoCaller.rc();
+
+    *aProgress = NULL;
+    ReturnComNotImplemented();
 }
 

trunk/src/VBox/Main/src-server/MediumImpl.cpp

@@ -1543 +1543 @@
 }
 
-STDMETHODIMP Medium::COMSETTER(Location)(IN_BSTR aLocation)
-{
-    CheckComArgStrNotEmptyOrNull(aLocation);
-
-    AutoCaller autoCaller(this);
-    if (FAILED(autoCaller.rc())) return autoCaller.rc();
-
-    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
-
-    /// @todo NEWMEDIA for file names, add the default extension if no extension
-    /// is present (using the information from the VD backend which also implies
-    /// that one more parameter should be passed to setLocation() requesting
-    /// that functionality since it is only allowed when called from this method
-
-    /// @todo NEWMEDIA rename the file and set m->location on success, then save
-    /// the global registry (and local registries of portable VMs referring to
-    /// this medium), this will also require to add the mRegistered flag to data
-
-    ReturnComNotImplemented();
-}
-
 STDMETHODIMP Medium::COMGETTER(Name)(BSTR *aName)
 {
@@ -2892 +2871 @@
 
     return rc;
+}
+
+STDMETHODIMP Medium::SetLocation(IN_BSTR aLocation, IProgress **aProgress)
+{
+    CheckComArgStrNotEmptyOrNull(aLocation);
+    CheckComArgOutPointerValid(aProgress);
+
+    AutoCaller autoCaller(this);
+    if (FAILED(autoCaller.rc())) return autoCaller.rc();
+
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    /// @todo NEWMEDIA for file names, add the default extension if no extension
+    /// is present (using the information from the VD backend which also implies
+    /// that one more parameter should be passed to setLocation() requesting
+    /// that functionality since it is only allowed when called from this method
+
+    /// @todo NEWMEDIA rename the file and set m->location on success, then save
+    /// the global registry (and local registries of portable VMs referring to
+    /// this medium), this will also require to add the mRegistered flag to data
+
+    *aProgress = NULL;
+    ReturnComNotImplemented();
 }
 
@@ -5986 +5988 @@
     pToken->Abandon();
     pToken.setNull();
-    
+
     if (FAILED(rc)) return rc;
 

trunk/src/VBox/Main/src-server/NetworkAdapterImpl.cpp

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2012 Oracle Corporation
+ * Copyright (C) 2006-2013 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -478 +478 @@
         }
 
+        /* there must a NAT network name */
+        if (mData->mNATNetwork.isEmpty())
+        {
+            Log(("NAT network name not defined, setting to default \"NatNetwork\"\n"));
+            mData->mNATNetwork = "NatNetwork";
+        }
+
         mData->mAttachmentType = aAttachmentType;
 
@@ -526 +533 @@
     if (mData->mBridgedInterface != aBridgedInterface)
     {
+        /* if an empty/null string is to be set, bridged interface must be
+         * turned off */
+        if (   (aBridgedInterface == NULL || *aBridgedInterface == '\0')
+            && mData->mAttachmentType == NetworkAttachmentType_Bridged)
+        {
+            return setError(E_FAIL,
+                            tr("Empty or null bridged interface name is not valid"));
+        }
+
         mData.backup();
         mData->mBridgedInterface = aBridgedInterface;
@@ -577 +593 @@
     if (mData->mHostOnlyInterface != aHostOnlyInterface)
     {
+        /* if an empty/null string is to be set, host only interface must be
+         * turned off */
+        if (   (aHostOnlyInterface == NULL || *aHostOnlyInterface == '\0')
+            && mData->mAttachmentType == NetworkAttachmentType_HostOnly)
+        {
+            return setError(E_FAIL,
+                            tr("Empty or null host only interface name is not valid"));
+        }
+
         mData.backup();
         mData->mHostOnlyInterface = aHostOnlyInterface;
@@ -684 +709 @@
     if (mData->mNATNetwork != aNATNetwork)
     {
+        /* if an empty/null string is to be set, host only interface must be
+         * turned off */
+        if (   (aNATNetwork == NULL || *aNATNetwork == '\0')
+            && mData->mAttachmentType == NetworkAttachmentType_NATNetwork)
+        {
+            return setError(E_FAIL,
+                            tr("Empty or null NAT network name is not valid"));
+        }
+
         mData.backup();
         mData->mNATNetwork = aNATNetwork;
@@ -695 +729 @@
         mlock.release();
 
-        /* Changing the NAT network isn't allowed during runtime, therefore
-         * no immediate replug in CFGM logic => changeAdapter=FALSE */
-        mParent->onNetworkAdapterChange(this, FALSE);
+        /* When changing the host adapter, adapt the CFGM logic to make this
+         * change immediately effect and to notify the guest that the network
+         * might have changed, therefore changeAdapter=TRUE. */
+        mParent->onNetworkAdapterChange(this, TRUE);
     }
 
@@ -1209 +1244 @@
     mData->mGenericDriver = data.strGenericDriver;
     mData->mGenericProperties = data.genericProperties;
+    mData->mNATNetwork = data.strNATNetworkName;
 
     // leave the lock before setting attachment type
@@ -1269 +1305 @@
     data.genericProperties = mData->mGenericProperties;
 
+    data.strNATNetworkName = mData->mNATNetwork;
+
     // after saving settings, we are no longer different from the XML on disk
     m_fModified = false;

trunk/src/VBox/Main/src-server/SystemPropertiesImpl.cpp

@@ -390 +390 @@
         case NetworkAttachmentType_NAT:
         case NetworkAttachmentType_Internal:
+        case NetworkAttachmentType_NATNetwork:
             /* chipset default is OK */
             break;

trunk/src/VBox/Main/xml/Settings.cpp

@@ -2422 +2422 @@
         }
     }
+    else if (elmMode.nameEquals("NATNetwork"))
+    {
+        enmAttachmentType = NetworkAttachmentType_NATNetwork;
+
+        if (!elmMode.getAttributeValue("name", nic.strNATNetworkName))    // required network name
+            throw ConfigFileError(this, &elmMode, N_("Required NATNetwork/@name element is missing"));
+    }
     else if (elmMode.nameEquals("VDE"))
     {
@@ -4460 +4467 @@
             if (nic.mode != NetworkAttachmentType_Generic)
                 buildNetworkXML(NetworkAttachmentType_Generic, *pelmDisabledNode, false, nic);
+            if (nic.mode != NetworkAttachmentType_NATNetwork)
+                buildNetworkXML(NetworkAttachmentType_NATNetwork, *pelmDisabledNode, false, nic);
             buildNetworkXML(nic.mode, *pelmAdapter, true, nic);
         }
@@ -4772 +4781 @@
                 }
             }
+            break;
+
+        case NetworkAttachmentType_NATNetwork:
+            if (fEnabled || !nic.strNATNetworkName.isEmpty())
+                elmParent.createChild("NATNetwork")->setAttribute("name", nic.strNATNetworkName);
             break;
 
@@ -5319 +5333 @@
     {
         // VirtualBox 4.3 adds default frontend setting, graphics controller
-        // setting, explicit long mode setting and video capturing.
+        // setting, explicit long mode setting, video capturing and NAT networking.
         if (   !hardwareMachine.strDefaultFrontend.isEmpty()
             || hardwareMachine.graphicsControllerType != GraphicsControllerType_VBoxVGA
@@ -5325 +5339 @@
             || machineUserData.ovIcon.length() > 0
             || hardwareMachine.fVideoCaptureEnabled)
+        {
             m->sv = SettingsVersion_v1_14;
+            return;
+        }
+        NetworkAdaptersList::const_iterator netit;
+        for (netit = hardwareMachine.llNetworkAdapters.begin();
+             netit != hardwareMachine.llNetworkAdapters.end();
+             ++netit)
+        {
+            if (netit->mode == NetworkAttachmentType_NATNetwork)
+            {
+                m->sv = SettingsVersion_v1_14;
+                break;
+            }
+        }
     }