Changeset 71349 in vbox

Timestamp:

Mar 15, 2018 11:23:39 AM (7 years ago)

Author:

vboxsync

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

121300

Message:

Guest Control/Main: Added (COM) error codes VERR_GSTCTL_MAX_OBJECTS_REACHED, VBOX_E_MAXIMUM_REACHED and VBOX_E_GSTCTL_GUEST_ERROR; make use of those when creating guest control objects, such as guest sessions, files and directories.

Location:

trunk

Files:

• include/VBox/err.h (modified) (1 diff)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (6 diffs)
• src/VBox/Main/src-all/Global.cpp (modified) (3 diffs)
• src/VBox/Main/src-client/GuestCtrlImpl.cpp (modified) (1 diff)
• src/VBox/Main/src-client/GuestProcessImpl.cpp (modified) (1 diff)
• src/VBox/Main/src-client/GuestSessionImpl.cpp (modified) (5 diffs)

trunk/include/VBox/err.h

@@ -2709 +2709 @@
 /** Started guest process terminated with an exit code <> 0. */
 #define VWRN_GSTCTL_PROCESS_EXIT_CODE               6221
+/** Maximum objects has been reached. */
+#define VERR_GSTCTL_MAX_OBJECTS_REACHED             (-6222)
 /** @} */
 

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

@@ -432 +432 @@
     <desc>
       A provided password was incorrect.
+    </desc>
+  </result>
+
+  <result name="VBOX_E_MAXIMUM_REACHED" value="0x80BB000E">
+    <desc>
+      A maximum has been reached.
+    </desc>
+  </result>
+
+  <result name="VBOX_E_GSTCTL_GUEST_ERROR" value="0x80BB000F">
+    <desc>
+      Guest Control reported an error from the guest side.
     </desc>
   </result>
@@ -11882 +11894 @@
 
       There can be up to 2048 objects (guest processes, files and directories)
-      a time per guest session.  Exceeding the limit will result in an error.
-<!-- @todo r=bird: Add specific VBOX_E_XXX error for this and document it here! -->
+      a time per guest session.  Exceeding the limit will result in an error (see
+      the corresponding functions for more).
 
       When done with either of these objects, including the guest session itself,
@@ -12206 +12218 @@
           Error while opening the directory.
         </result>
+        <result name="VBOX_E_MAXIMUM_REACHED">
+          The maximum of concurrent guest directories has been reached.
+        </result>
       </desc>
       <param name="path" type="wstring" dir="in">
@@ -12513 +12528 @@
           Error while opening the file.
         </result>
+        <result name="VBOX_E_MAXIMUM_REACHED">
+          The maximum of concurrent guest files has been reached.
+        </result>
       </desc>
       <param name="path" type="wstring" dir="in">
@@ -12795 +12813 @@
         <result name="VBOX_E_IPRT_ERROR">
           Error creating guest process.
+        </result>
+
+        <result name="VBOX_E_MAXIMUM_REACHED">
+          The maximum of concurrent guest processes has been reached.
         </result>
       </desc>
@@ -13921 +13943 @@
 
         There can be a maximum of 32 sessions at once per VM.  An error will
-        be returned if this has been reached. <!-- This should actually read:
-        VBOX_E_IPRT_ERROR will be return if this limit has been reached.
-        However, keep in mind that VBOX_E_IPRT_ERROR can be returned for about
-        88 unrelated reasons, so you don't know what happend unless you parse
-        the error text. (bird) -->
-<!-- @todo r=bird: Seriously, add an dedicated VBOX_E_MAX_GUEST_SESSIONS status
-for this condition.  Do the same for all other maximums and things that could be
-useful to the API client. -->
+        be returned if this has been reached.
 
         For more information please consult <link to="IGuestSession"/>
+
+        <result name="VBOX_E_IPRT_ERROR">
+          Error creating guest session.
+        </result>
+
+        <result name="VBOX_E_MAXIMUM_REACHED">
+          The maximum of concurrent guest sessions has been reached.
+        </result>
       </desc>
       <param name="user" type="wstring" dir="in">

trunk/src/VBox/Main/src-all/Global.cpp

@@ -7 +7 @@
 
 /*
- * Copyright (C) 2008-2017 Oracle Corporation
+ * Copyright (C) 2008-2018 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -744 +744 @@
         case VERR_ACCESS_DENIED:                return E_ACCESSDENIED;
 
-        /* VirtualBox COM status codes */
+        /* VirtualBox COM status codes. */
         case VERR_COM_OBJECT_NOT_FOUND:         return VBOX_E_OBJECT_NOT_FOUND;
         case VERR_COM_INVALID_VM_STATE:         return VBOX_E_INVALID_VM_STATE;
@@ -763 +763 @@
         case VERR_FILE_NOT_FOUND:               return VBOX_E_OBJECT_NOT_FOUND;
 
+        /* Guest Control errors. */
+        case VERR_GSTCTL_MAX_OBJECTS_REACHED:   return VBOX_E_MAXIMUM_REACHED;
+        case VERR_GSTCTL_GUEST_ERROR:           return VBOX_E_GSTCTL_GUEST_ERROR;
+
         default:
             AssertMsgFailed(("%Rrc\n", aVBoxStatus));

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

@@ -420 +420 @@
         {
             case VERR_MAX_PROCS_REACHED:
-                hr = setError(VBOX_E_IPRT_ERROR, tr("Maximum number of concurrent guest sessions (%ld) reached"),
+                hr = setError(VBOX_E_MAXIMUM_REACHED, tr("Maximum number of concurrent guest sessions (%ld) reached"),
                               VBOX_GUESTCTRL_MAX_SESSIONS);
                 break;

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

@@ -540 +540 @@
             break;
 
-        case VERR_MAX_PROCS_REACHED:
+        case VERR_GSTCTL_MAX_OBJECTS_REACHED:
             strError += Utf8StrFmt(tr("Maximum number of concurrent guest processes has been reached"));
             break;

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

@@ -971 +971 @@
     AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
 
-    int rc = VERR_MAX_PROCS_REACHED;
+    int rc = VERR_GSTCTL_MAX_OBJECTS_REACHED;
     if (mData.mNumObjects >= VBOX_GUESTCTRL_MAX_OBJECTS)
         return rc;
@@ -1349 +1349 @@
     }
 
-    int rc = VERR_MAX_PROCS_REACHED;
+    int rc = VERR_GSTCTL_MAX_OBJECTS_REACHED;
     if (mData.mNumObjects >= VBOX_GUESTCTRL_MAX_OBJECTS)
         return rc;
@@ -1568 +1568 @@
             break;
 
-        case VERR_MAX_PROCS_REACHED:
+        case VERR_GSTCTL_MAX_OBJECTS_REACHED:
             strError += Utf8StrFmt(tr("Maximum number of concurrent guest processes has been reached"));
             break;
@@ -2129 +2129 @@
     AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
 
-    int rc = VERR_MAX_PROCS_REACHED;
+    int rc = VERR_GSTCTL_MAX_OBJECTS_REACHED;
     if (mData.mNumObjects >= VBOX_GUESTCTRL_MAX_OBJECTS)
         return rc;
@@ -3796 +3796 @@
             }
         }
-        else if (vrc == VERR_MAX_PROCS_REACHED)
+        else if (vrc == VERR_GSTCTL_MAX_OBJECTS_REACHED)
             hr = setErrorVrc(vrc, tr("Maximum number of concurrent guest processes per session (%u) reached"),
                              VBOX_GUESTCTRL_MAX_OBJECTS);