Changeset 95903 in vbox for trunk/src/VBox/Runtime/r3

Timestamp:

Jul 28, 2022 11:56:03 AM (2 years ago)

Author:

vboxsync

Message:

IPRT/stream: Flush & cleanup of non-standard streams on exit/unload like regular crt does (IIRC). bugref:10261

File:

• trunk/src/VBox/Runtime/r3/stream.cpp (modified) (12 diffs)

trunk/src/VBox/Runtime/r3/stream.cpp

@@ -68 +68 @@
 #ifdef RTSTREAM_STANDALONE
 # include <iprt/file.h>
+# include <iprt/list.h>
 #endif
 #include <iprt/mem.h>
+#ifdef RTSTREAM_STANDALONE
+# include <iprt/once.h>
+#endif
 #include <iprt/param.h>
 #include <iprt/string.h>
@@ -175 +179 @@
     PRTCRITSECT         pCritSect;
 #endif
+#ifdef RTSTREAM_STANDALONE
+    /** Entry in g_StreamList (for automatic flushing and closing at
+     * exit/unload). */
+    RTLISTNODE          ListEntry;
+#endif
 } RTSTREAM;
 
@@ -221 +230 @@
     /* .fRecheckMode = */       true,
 #ifndef HAVE_FWRITE_UNLOCKED
-    /* .pCritSect = */          NULL
+    /* .pCritSect = */          NULL,
+#endif
+#ifdef RTSTREAM_STANDALONE
+    /* .ListEntry = */          { NULL, NULL },
 #endif
 };
@@ -249 +261 @@
     /* .fRecheckMode = */       true,
 #ifndef HAVE_FWRITE_UNLOCKED
-    /* .pCritSect = */          NULL
+    /* .pCritSect = */          NULL,
+#endif
+#ifdef RTSTREAM_STANDALONE
+    /* .ListEntry = */          { NULL, NULL },
 #endif
 };
@@ -277 +292 @@
     /* .fRecheckMode = */       true,
 #ifndef HAVE_FWRITE_UNLOCKED
-    /* .pCritSect = */          NULL
+    /* .pCritSect = */          NULL,
+#endif
+#ifdef RTSTREAM_STANDALONE
+    /* .ListEntry = */          { NULL, NULL },
 #endif
 };
@@ -289 +307 @@
 /** Pointer to the standard output stream. */
 RTDATADECL(PRTSTREAM)   g_pStdOut = &g_StdOut;
+
+#ifdef RTSTREAM_STANDALONE
+/** Run-once initializer for the stream list (g_StreamList + g_StreamListCritSect). */
+static RTONCE           g_StreamListOnce = RTONCE_INITIALIZER;
+/** List of user created streams (excludes the standard streams). */
+static RTLISTANCHOR     g_StreamList;
+/** Critical section protecting the stream list. */
+static RTCRITSECT       g_StreamListCritSect;
+
+
+/** @callback_method_impl{FNRTONCE}   */
+static DECLCALLBACK(int32_t) rtStrmListInitOnce(void *pvUser)
+{
+    RT_NOREF(pvUser);
+    RTListInit(&g_StreamList);
+    return RTCritSectInit(&g_StreamListCritSect);
+}
+
+#endif
 
 
@@ -442 +479 @@
         return VINF_SUCCESS;
     }
+
+#ifdef RTSTREAM_STANDALONE
+    /*
+     * Make the the stream list is initialized before we allocate anything.
+     */
+    int rc2 = RTOnce(&g_StreamListOnce, rtStrmListInitOnce, NULL);
+    AssertRCReturn(rc2, rc2);
+#endif
 
     /*
@@ -480 +525 @@
         if (RT_SUCCESS(rc))
         {
+#ifdef RTSTREAM_STANDALONE
+            /* We keep a list of these for cleanup purposes. */
+            RTCritSectEnter(&g_StreamListCritSect);
+            RTListAppend(&g_StreamList, &pStream->ListEntry);
+            RTCritSectLeave(&g_StreamListCritSect);
+#endif
             *ppStream = pStream;
             return VINF_SUCCESS;
@@ -559 +610 @@
      * Invalidate the stream and destroy the critical section first.
      */
+#ifdef RTSTREAM_STANDALONE
+    RTCritSectEnter(&g_StreamListCritSect);
+    RTListNodeRemove(&pStream->ListEntry);
+    RTCritSectLeave(&g_StreamListCritSect);
+#endif
     pStream->u32Magic = 0xdeaddead;
 #ifndef HAVE_FWRITE_UNLOCKED
@@ -1295 +1351 @@
 
 /**
- * Worker for rtStrmFlushAndCloseAll.
- */
-static void rtStrmFlushAndClose(PRTSTREAM pStream, bool fStaticStream)
-{
-    if (!fStaticStream)
-        pStream->u32Magic = ~RTSTREAM_MAGIC;
-
+ * Worker for rtStrmFlushAndCloseAll and rtStrmFlushAndClose.
+ */
+static RTFILE rtStrmFlushAndCleanup(PRTSTREAM pStream)
+{
     if (pStream->pchBuf)
     {
@@ -1315 +1368 @@
 
     PRTCRITSECT pCritSect = pStream->pCritSect;
-    pStream->pCritSect = NULL;
     if (pCritSect)
     {
+        pStream->pCritSect = NULL;
         RTCritSectDelete(pCritSect);
         RTMemFree(pCritSect);
     }
 
-    if (pStream->hFile != NIL_RTFILE)
-    {
-        if (!fStaticStream)
-            RTFileClose(pStream->hFile);
-        /* else: no structure or memory behind RTFILE yet, so okay to just drop it. */
-        pStream->hFile = NIL_RTFILE;
-    }
-
-    if (!fStaticStream)
-        RTMemFree(pStream);
+    RTFILE hFile = pStream->hFile;
+    pStream->hFile = NIL_RTFILE;
+    return hFile;
+}
+
+
+/**
+ * Worker for rtStrmFlushAndCloseAll.
+ */
+static void rtStrmFlushAndClose(PRTSTREAM pStream)
+{
+    pStream->u32Magic = ~RTSTREAM_MAGIC;
+    RTFILE hFile = rtStrmFlushAndCleanup(pStream);
+    if (hFile != NIL_RTFILE)
+        RTFileClose(hFile);
+    RTMemFree(pStream);
 }
 
@@ -1344 +1403 @@
      * Flush the standard handles.
      */
-    rtStrmFlushAndClose(&g_StdOut, true);
-    rtStrmFlushAndClose(&g_StdErr, true);
-    rtStrmFlushAndClose(&g_StdIn,  true);
+    rtStrmFlushAndCleanup(&g_StdOut);
+    rtStrmFlushAndCleanup(&g_StdErr);
+    rtStrmFlushAndCleanup(&g_StdIn);
 
     /*
      * Make a list of the rest and flush+close those too.
      */
-    /** @todo */
+    if (RTOnceWasInitialized(&g_StreamListOnce))
+    {
+        RTCritSectDelete(&g_StreamListCritSect);
+
+        PRTSTREAM pStream;
+        while ((pStream = RTListRemoveFirst(&g_StreamList, RTSTREAM, ListEntry)) != NULL)
+            rtStrmFlushAndClose(pStream);
+
+        RTOnceReset(&g_StreamListOnce);
+    }
 }