Changeset 105064 in vbox for trunk/src/VBox/Devices/Network/DrvNATlibslirp.cpp

Timestamp:

Jun 27, 2024 2:46:31 PM (5 months ago)

Author:

vboxsync

Message:

Devices/Network: clean up code and comments. bugref:10268

File:

• trunk/src/VBox/Devices/Network/DrvNATlibslirp.cpp (modified) (30 diffs)

trunk/src/VBox/Devices/Network/DrvNATlibslirp.cpp

@@ -185 +185 @@
         Assert(!pSgBuf->pvUser);
         RTMemFree(pSgBuf->aSegs[0].pvSeg);
-        pSgBuf->pvAllocator = NULL;
     }
     else if (pSgBuf->pvUser)
@@ -202 +201 @@
  * @param   pThis               Pointer to the NAT instance.
  * @param   pSgBuf              The scatter/gather buffer.
- *
  * @thread  NAT
  */
 static DECLCALLBACK(void) drvNATSendWorker(PDRVNAT pThis, PPDMSCATTERGATHER pSgBuf)
 {
+    LogFlowFunc(("pThis=%p pSgBuf=%p\n", pThis, pSgBuf));
+
     if (pThis->enmLinkState == PDMNETWORKLINKSTATE_UP)
     {
@@ -215 +215 @@
              * A normal frame.
              */
+            LogFlowFunc(("m=%p\n", m));
             slirp_input(pThis->pNATState->pSlirp, (uint8_t const *)pSgBuf->pvAllocator, (int)pSgBuf->cbUsed);
         }
@@ -220 +221 @@
         {
             /*
-             * Large/GSO frame.
+             * M_EXT buf, need to segment it.
              */
 
@@ -249 +250 @@
     }
 
+    LogFlowFunc(("leave\n"));
     drvNATFreeSgBuf(pThis, pSgBuf);
 }
@@ -254 +256 @@
 /**
  * @interface_method_impl{PDMINETWORKUP,pfnBeginXmit}
- *
- * @param   pInterface      Pointer to UP network interface.
- * @param   fOnWorkerThread Unused.
- *
- * @returns VBox status code.
- *
- * @thread ?
  */
 static DECLCALLBACK(int) drvNATNetworkUp_BeginXmit(PPDMINETWORKUP pInterface, bool fOnWorkerThread)
@@ -278 +273 @@
 /**
  * @interface_method_impl{PDMINETWORKUP,pfnAllocBuf}
- *
- * Allocates a scatter/gather buffer for packet/frame handling.
- *
- * @param   pInterface  Pointer to UP network interface.
- * @param   cbMin       Minimum size of buffer to hold packet/frame.
- * @param   pGso        The GSO context.
- * @param   ppSgBuf     Pointer to the resulting scatter/gather buffer.
- *
- * @returns VBox status code
- *
- * @thread ?
  */
 static DECLCALLBACK(int) drvNATNetworkUp_AllocBuf(PPDMINETWORKUP pInterface, size_t cbMin,
@@ -295 +279 @@
     PDRVNAT pThis = RT_FROM_MEMBER(pInterface, DRVNAT, INetworkUp);
     Assert(RTCritSectIsOwner(&pThis->XmitLock));
+
+    LogFlowFunc(("enter\n"));
 
     /*
@@ -377 +363 @@
 /**
  * @interface_method_impl{PDMINETWORKUP,pfnFreeBuf}
- *
- * Wrapper function for drvNATFreeSgBuff.
- *
- * @param   pInterface  Pointer to UP network interface.
- * @param   pSgBuf      Pointer to scatter/gather buffer to be freed.
- *
- * @thread  ?
  */
 static DECLCALLBACK(int) drvNATNetworkUp_FreeBuf(PPDMINETWORKUP pInterface, PPDMSCATTERGATHER pSgBuf)
@@ -395 +374 @@
 /**
  * @interface_method_impl{PDMINETWORKUP,pfnSendBuf}
- *
- * Sends packet/frame out to network (up from guest).
- *
- * @param   pInterface      Pointer to UP network interface.
- * @param   pSgBuf          Pointer to scatter/gather packet/frame buffer.
- * @param   fOnWorkerThread Unused.
- *
- * @thread  ?
  */
 static DECLCALLBACK(int) drvNATNetworkUp_SendBuf(PPDMINETWORKUP pInterface, PPDMSCATTERGATHER pSgBuf, bool fOnWorkerThread)
@@ -411 +382 @@
     Assert(RTCritSectIsOwner(&pThis->XmitLock));
 
+    LogFlowFunc(("enter\n"));
+
     int rc;
     if (pThis->pSlirpThread->enmState == PDMTHREADSTATE_RUNNING)
@@ -420 +393 @@
         {
             drvNATNotifyNATThread(pThis, "drvNATNetworkUp_SendBuf");
+            LogFlowFunc(("leave success\n"));
             return VINF_SUCCESS;
         }
@@ -427 +401 @@
     else
         rc = VERR_NET_DOWN;
-
     drvNATFreeSgBuf(pThis, pSgBuf);
+    LogFlowFunc(("leave rc=%Rrc\n", rc));
     return rc;
 }
@@ -434 +408 @@
 /**
  * @interface_method_impl{PDMINETWORKUP,pfnEndXmit}
- *
- * End transmission.
- *
- * @param   pInterface  Pointer to UP network interface.
- *
- * @thread  ?
  */
 static DECLCALLBACK(void) drvNATNetworkUp_EndXmit(PPDMINETWORKUP pInterface)
@@ -449 +417 @@
 /**
  * Get the NAT thread out of poll/WSAWaitForMultipleEvents
- *
- * @param   pThis   Pointer to DRVNAT state for current context.
- * @param   pszWho  String identifying caller.
- *
- * @thread  ?
  */
 static void drvNATNotifyNATThread(PDRVNAT pThis, const char *pszWho)
@@ -463 +426 @@
     size_t cbIgnored;
     rc = RTPipeWrite(pThis->hPipeWrite, "", 1, &cbIgnored);
+#else
+    /* kick WSAWaitForMultipleEvents */
+    rc = WSASetEvent(pThis->hWakeupEvent);
 #endif
     AssertRC(rc);
@@ -480 +446 @@
  * Worker function for drvNATNetworkUp_NotifyLinkChanged().
  * @thread "NAT" thread.
+ *
+ * @param   pThis           Pointer to DRVNAT state for current context.
+ * @param   enmLinkState    Enum value of link state.
+ *
+ * @thread  NAT
  */
 static DECLCALLBACK(void) drvNATNotifyLinkChangedWorker(PDRVNAT pThis, PDMNETWORKLINKSTATE enmLinkState)
@@ -488 +459 @@
         case PDMNETWORKLINKSTATE_UP:
             LogRel(("NAT: Link up\n"));
-            // slirp_link_up(pThis->pNATState);
             break;
 
@@ -494 +464 @@
         case PDMNETWORKLINKSTATE_DOWN_RESUME:
             LogRel(("NAT: Link down\n"));
-            // slirp_link_down(pThis->pNATState);
             break;
 
@@ -507 +476 @@
  * @param   pInterface      Pointer to the interface structure containing the called function pointer.
  * @param   enmLinkState    The new link state.
+ *
  * @thread  EMT
  */
@@ -537 +507 @@
 }
 
-/** @todo r=jack: move this to the right spot. temp for dev. */
-static void register_poll_fd(int fd, void *opaque) {
+/**
+ * Registers poll. Unused function (other than logging).
+ */
+static void drvNAT_RegisterPoll(int fd, void *opaque) {
     RT_NOREF(fd, opaque);
-}
-
-static void unregister_poll_fd(int fd, void *opaque) {
+    Log4(("Poll registered\n"));
+}
+
+/**
+ * Unregisters poll. Unused function (other than logging).
+ */
+static void drvNAT_UnregisterPoll(int fd, void *opaque) {
     RT_NOREF(fd, opaque);
-}
-
-static int slirp_to_poll(int events) {
-    int ret = 0;
+    Log4(("Poll unregistered\n"));
+}
+
+/**
+ * Converts slirp representation of poll events to host representation.
+ *
+ * @param   iEvents     Integer representing slirp type poll events.
+ *
+ * @returns Integer representing host type poll events.
+ *
+ * @thread  ?
+ */
+static int drvNAT_PollEventSlirpToHost(int iEvents) {
+    int iRet = 0;
 #ifndef RT_OS_WINDOWS
-    if (events & SLIRP_POLL_IN)  ret |= POLLIN;
-    if (events & SLIRP_POLL_OUT) ret |= POLLOUT;
-    if (events & SLIRP_POLL_PRI) ret |= POLLPRI;
-    if (events & SLIRP_POLL_ERR) ret |= POLLERR;
-    if (events & SLIRP_POLL_HUP) ret |= POLLHUP;
+    if (iEvents & SLIRP_POLL_IN)  iRet |= POLLIN;
+    if (iEvents & SLIRP_POLL_OUT) iRet |= POLLOUT;
+    if (iEvents & SLIRP_POLL_PRI) iRet |= POLLPRI;
+    if (iEvents & SLIRP_POLL_ERR) iRet |= POLLERR;
+    if (iEvents & SLIRP_POLL_HUP) iRet |= POLLHUP;
 #else
-    if (events & SLIRP_POLL_IN)  ret |= (POLLRDNORM | POLLRDBAND);
-    if (events & SLIRP_POLL_OUT) ret |= POLLWRNORM;
-    if (events & SLIRP_POLL_PRI) ret |= (POLLIN);
-    if (events & SLIRP_POLL_ERR) ret |= 0;
-    if (events & SLIRP_POLL_HUP) ret |= 0;
+    if (iEvents & SLIRP_POLL_IN)  iRet |= (POLLRDNORM | POLLRDBAND);
+    if (iEvents & SLIRP_POLL_OUT) iRet |= POLLWRNORM;
+    if (iEvents & SLIRP_POLL_PRI) iRet |= (POLLIN);
+    if (iEvents & SLIRP_POLL_ERR) iRet |= 0;
+    if (iEvents & SLIRP_POLL_HUP) iRet |= 0;
 #endif
-    return ret;
-}
-
-static int poll_to_slirp(int events) {
-    int ret = 0;
+    return iRet;
+}
+
+/**
+ * Converts host representation of poll events to slirp representation.
+ *
+ * @param   iEvents     Integer representing host type poll events.
+ *
+ * @returns Integer representing slirp type poll events.
+ *
+ * @thread  ?
+ */
+static int drvNAT_PollEventHostToSlirp(int iEvents) {
+    int iRet = 0;
 #ifndef RT_OS_WINDOWS
-    if (events & POLLIN)  ret |= SLIRP_POLL_IN;
-    if (events & POLLOUT) ret |= SLIRP_POLL_OUT;
-    if (events & POLLPRI) ret |= SLIRP_POLL_PRI;
-    if (events & POLLERR) ret |= SLIRP_POLL_ERR;
-    if (events & POLLHUP) ret |= SLIRP_POLL_HUP;
+    if (iEvents & POLLIN)  iRet |= SLIRP_POLL_IN;
+    if (iEvents & POLLOUT) iRet |= SLIRP_POLL_OUT;
+    if (iEvents & POLLPRI) iRet |= SLIRP_POLL_PRI;
+    if (iEvents & POLLERR) iRet |= SLIRP_POLL_ERR;
+    if (iEvents & POLLHUP) iRet |= SLIRP_POLL_HUP;
 #else
-    if (events & (POLLRDNORM | POLLRDBAND))  ret |= SLIRP_POLL_IN;
-    if (events & POLLWRNORM) ret |= SLIRP_POLL_OUT;
-    if (events & (POLLPRI)) ret |= SLIRP_POLL_PRI;
-    if (events & POLLERR) ret |= SLIRP_POLL_ERR;
-    if (events & POLLHUP) ret |= SLIRP_POLL_HUP;
+    if (iEvents & (POLLRDNORM | POLLRDBAND))  iRet |= SLIRP_POLL_IN;
+    if (iEvents & POLLWRNORM) iRet |= SLIRP_POLL_OUT;
+    if (iEvents & (POLLPRI)) iRet |= SLIRP_POLL_PRI;
+    if (iEvents & POLLERR) iRet |= SLIRP_POLL_ERR;
+    if (iEvents & POLLHUP) iRet |= SLIRP_POLL_HUP;
 #endif
-    return ret;
-}
-
-static int add_poll_cb(int fd, int events, void *opaque)
-{
-    // LogFlow(("add_poll_cb: fd=%d, events=%d\n", fd, events));
+    return iRet;
+}
+
+/**
+ * Callback function to add entry to pollfd array.
+ *
+ * @param   iFd     Integer of system file descriptor of socket.
+ *                  (on windows, this is a VBox internal, not system, value).
+ * @param   iEvents Integer of slirp type poll events.
+ * @param   opaque  Pointer to NAT State context.
+ *
+ * @returns Index of latest pollfd entry.
+ *
+ * @thread  ?
+ */
+static int drvNAT_addPollCb(int iFd, int iEvents, void *opaque)
+{
     PDRVNAT pThis = (PDRVNAT)opaque;
 
@@ -596 +602 @@
             pThis->pNATState->uPollCap *= 2;
         }
-        else {
-            LogFlow(("add_poll_cb return -1"));
+        else
             return -1;
-        }
     }
 
     int idx = pThis->pNATState->nsock;
 #ifdef RT_OS_WINDOWS
-    pThis->pNATState->polls[idx].fd = libslirp_wrap_RTHandleTableLookup(fd);
+    pThis->pNATState->polls[idx].fd = libslirp_wrap_RTHandleTableLookup(iFd);
 #else
-    pThis->pNATState->polls[idx].fd = fd;
+    pThis->pNATState->polls[idx].fd = iFd;
 #endif
-    pThis->pNATState->polls[idx].events = slirp_to_poll(events);
+    pThis->pNATState->polls[idx].events = drvNAT_PollEventSlirpToHost(iEvents);
     pThis->pNATState->polls[idx].revents = 0;
     pThis->pNATState->nsock += 1;
@@ -614 +618 @@
 }
 
+/**
+ * Get translated revents from a poll at a given index.
+ *
+ * @param   idx     Integer index of poll.
+ * @param   opaque  Pointer to NAT State context.
+ *
+ * @returns Integer representing transalted revents.
+ *
+ * @thread  ?
+ */
 static int get_revents_cb(int idx, void *opaque)
 {
     PDRVNAT pThis = (PDRVNAT)opaque;
     struct pollfd* polls = pThis->pNATState->polls;
-    return poll_to_slirp(polls[idx].revents);
+    return drvNAT_PollEventHostToSlirp(polls[idx].revents);
 }
 
@@ -630 +644 @@
  * wants to deliver packets to the guest, it enqueues a request into
  * hRecvReqQueue which is later handled by the Recv thread.
+ *
+ * @param   pDrvIns     Pointer to PDM driver context.
+ * @param   pThread     Pointer to calling thread context.
+ *
+ * @returns VBox status code
+ *
+ * @thread  NAT
  */
 static DECLCALLBACK(int) drvNATAsyncIoThread(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
@@ -638 +659 @@
 #else /* RT_OS_WINDOWS */
     unsigned int cPollNegRet = 0;
-    add_poll_cb(RTPipeToNative(pThis->hPipeRead), SLIRP_POLL_IN | SLIRP_POLL_HUP, pThis);
+    drvNAT_addPollCb(RTPipeToNative(pThis->hPipeRead), SLIRP_POLL_IN | SLIRP_POLL_HUP, pThis);
     pThis->pNATState->polls[0].fd = RTPipeToNative(pThis->hPipeRead);
     pThis->pNATState->polls[0].events = POLLRDNORM | POLLPRI | POLLRDBAND;
@@ -664 +685 @@
         pThis->pNATState->nsock = 1;
 
-        slirp_pollfds_fill(pThis->pNATState->pSlirp, &uTimeout, add_poll_cb /* SlirpAddPollCb */, pThis /* opaque */);
+        slirp_pollfds_fill(pThis->pNATState->pSlirp, &uTimeout, drvNAT_addPollCb /* SlirpAddPollCb */, pThis /* opaque */);
         slirpUpdateTimeout(&uTimeout, pThis);
 
@@ -712 +733 @@
         uint32_t uTimeout = 0;
         pThis->pNATState->nsock = 0;
-        slirp_pollfds_fill(pThis->pNATState->pSlirp, &uTimeout, add_poll_cb /* SlirpAddPollCb */, pThis /* opaque */);
+        slirp_pollfds_fill(pThis->pNATState->pSlirp, &uTimeout, drvNAT_addPollCb /* SlirpAddPollCb */, pThis /* opaque */);
         slirpUpdateTimeout(&uTimeout, pThis);
 
@@ -760 +781 @@
  * @param   pDevIns     The pcnet device instance.
  * @param   pThread     The send thread.
+ *
+ * @thread  ?
  */
 static DECLCALLBACK(int) drvNATAsyncIoWakeup(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
@@ -770 +793 @@
 }
 
+/** @todo r=jack: do we need? */
 static DECLCALLBACK(int) drvNATHostResThread(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
 {
@@ -1397 +1421 @@
     slirpCallbacks->timer_free = &slirpTimerFreeCb;
     slirpCallbacks->timer_mod = &slirpTimerModCb;
-    slirpCallbacks->register_poll_fd = &register_poll_fd;
-    slirpCallbacks->unregister_poll_fd = &unregister_poll_fd;
+    slirpCallbacks->register_poll_fd = &drvNAT_RegisterPoll;
+    slirpCallbacks->unregister_poll_fd = &drvNAT_UnregisterPoll;
     slirpCallbacks->notify = &slirpNotifyCb;
     slirpCallbacks->init_completed = NULL;