Changeset 65478 in vbox for trunk/src/VBox/Frontends/VBoxBugReport

Timestamp:

Jan 27, 2017 10:00:44 AM (8 years ago)

Author:

vboxsync

Message:

BugReportTool: rudimentary filtering support for Windows registry files, memory leak fixes (bugref:8169)

Location:

trunk/src/VBox/Frontends/VBoxBugReport

Files:

• VBoxBugReport.cpp (modified) (6 diffs)
• VBoxBugReport.h (modified) (3 diffs)
• VBoxBugReportWin.cpp (modified) (3 diffs)

trunk/src/VBox/Frontends/VBoxBugReport/VBoxBugReport.cpp

@@ -146 +146 @@
 };
 
+
+BugReportFilter::BugReportFilter() : m_pvBuffer(0), m_cbBuffer(0)
+{
+}
+
+BugReportFilter::~BugReportFilter()
+{
+    if (m_pvBuffer)
+        RTMemFree(m_pvBuffer);
+}
+
+void *BugReportFilter::allocateBuffer(size_t cbNeeded)
+{
+    if (m_pvBuffer)
+    {
+        if (cbNeeded > m_cbBuffer)
+            RTMemFree(m_pvBuffer);
+        else
+            return m_pvBuffer;
+    }
+    m_pvBuffer = RTMemAlloc(cbNeeded);
+    if (!m_pvBuffer)
+        throw RTCError(com::Utf8StrFmt("Failed to allocate %ld bytes\n", cbNeeded));
+    m_cbBuffer = cbNeeded;
+    return m_pvBuffer;
+}
+
+
 /*
  * An abstract class serving as the root of the bug report item tree.
@@ -152 +180 @@
 {
     m_pszTitle = RTStrDup(pszTitle);
+    m_filter = 0;
 }
 
 BugReportItem::~BugReportItem()
 {
+    if (m_filter)
+        delete m_filter;
     RTStrFree(m_pszTitle);
 }
 
+void BugReportItem::addFilter(BugReportFilter *filter)
+{
+    m_filter = filter;
+}
+
+void *BugReportItem::applyFilter(void *pvSource, size_t *pcbInOut)
+{
+    if (m_filter)
+        return m_filter->apply(pvSource, pcbInOut);
+    return pvSource;
+}
+
 const char * BugReportItem::getTitle(void)
 {
@@ -184 +227 @@
 }
 
-void BugReport::addItem(BugReportItem* item)
-{
+void BugReport::addItem(BugReportItem* item, BugReportFilter *filter)
+{
+    if (filter)
+        item->addFilter(filter);
     if (item)
         m_Items.append(item);
@@ -199 +244 @@
     }
     RTPrintf("100%% - compressing...\n\n");
+}
+
+void *BugReport::applyFilters(BugReportItem* item, void *pvSource, size_t *pcbInOut)
+{
+    return item->applyFilter(pvSource, pcbInOut);
 }
 
@@ -447 +497 @@
         while (RT_SUCCESS(rc = RTStrmReadEx(strmIn, buf, sizeof(buf), &cbRead)) && cbRead)
         {
-            rc = RTStrmWriteEx(m_StrmTxt, buf, cbRead, &cbWritten);
+            rc = RTStrmWriteEx(m_StrmTxt, applyFilters(item, buf, &cbRead), cbRead, &cbWritten);
             if (RT_FAILURE(rc) || cbRead != cbWritten)
                 throw RTCError(com::Utf8StrFmt("Write failure (rc=%d, cbRead=%lu, cbWritten=%lu)\n",
@@ -522 +572 @@
              offset += cbRead)
         {
-            handleRtError(RTTarFileWriteAt(m_hTarFile, offset, buf, cbRead, NULL),
+            handleRtError(RTTarFileWriteAt(m_hTarFile, offset, applyFilters(item, buf, &cbRead), cbRead, NULL),
                           "Failed to write %u bytes to TAR", cbRead);
         }

trunk/src/VBox/Frontends/VBoxBugReport/VBoxBugReport.h

@@ -86 +86 @@
 
 /*
+ * An abstract class serving as the root of the bug report filter tree.
+ * A child provides an implementation of the 'apply' method. A child
+ * should modify the input buffer (provided via pvSource) in place, or
+ * allocate a new buffer via 'allocateBuffer'. Allocated buffers are
+ * released automatically when another buffer is allocated, which means
+ * that NEXT CALL TO 'APPLY' INVALIDATES BUFFERS RETURNED IN PREVIOUS
+ * CALLS!
+ */
+class BugReportFilter
+{
+public:
+    BugReportFilter();
+    virtual ~BugReportFilter();
+    virtual void *apply(void *pvSource, size_t *pcbInOut) = 0;
+protected:
+    void *allocateBuffer(size_t cbNeeded);
+private:
+    void *m_pvBuffer;
+    size_t m_cbBuffer;
+};
+
+
+/*
  * An abstract class serving as the root of the bug report item tree.
  */
@@ -95 +118 @@
     virtual const char *getTitle(void);
     virtual PRTSTREAM getStream(void) = 0;
+    void addFilter(BugReportFilter *filter);
+    void *applyFilter(void *pvSource, size_t *pcbInOut);
 private:
     char *m_pszTitle;
+    BugReportFilter *m_filter;
 };
 
@@ -108 +134 @@
     virtual ~BugReport();
 
-    void addItem(BugReportItem* item);
+    void addItem(BugReportItem* item, BugReportFilter *filter = 0);
     int  getItemCount(void);
     void process();
+    void *applyFilters(BugReportItem* item, void *pvSource, size_t *pcbInOut);
 
     virtual void processItem(BugReportItem* item) = 0;

trunk/src/VBox/Frontends/VBoxBugReport/VBoxBugReportWin.cpp

@@ -534 +534 @@
     for (int i = 0; SetupDiEnumDeviceInfo(m_hDevInfo, i, &deviceInfoData); ++i)
     {
+        if (m_hHostCtrlDev != INVALID_HANDLE_VALUE)
+            CloseHandle(m_hHostCtrlDev);
+        if (m_pDetailData)
+            RTMemFree(m_pDetailData);
+
         SP_DEVICE_INTERFACE_DATA deviceInterfaceData;
         deviceInterfaceData.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
@@ -694 +699 @@
 
 
+class BugReportFilterRegistryWin : public BugReportFilter
+{
+public:
+    BugReportFilterRegistryWin() {};
+    virtual ~BugReportFilterRegistryWin() {};
+    virtual void *apply(void *pvSource, size_t *pcbInOut);
+};
+
+void *BugReportFilterRegistryWin::apply(void *pvSource, size_t *pcbInOut)
+{
+    /*
+     * The following implementation is not optimal by any means. It serves to
+     * illustrate and test the case when filter's output is longer than its
+     * input.
+     */
+    RT_NOREF(pcbInOut);
+    /* Registry export files are encoded in UTF-16 (little endian on Intel x86). */
+    void *pvDest = pvSource;
+    uint16_t *pwsSource = (uint16_t *)pvSource;
+    if (*pwsSource++ == 0xFEFF && *pcbInOut > 48)
+    {
+        if (!memcmp(pwsSource, L"Windows Registry Editor", 46))
+        {
+            *pcbInOut += 2;
+            pvDest = allocateBuffer(*pcbInOut);
+            uint16_t *pwsDest = (uint16_t *)pvDest;
+            *pwsDest++ = 0xFEFF;
+            *pwsDest++ = '#';
+            /* Leave space for 0xFEFF and '#' */
+            memcpy(pwsDest, pwsSource, *pcbInOut - 4);
+        }
+    }
+    return pvDest;
+}
+
 
 void createBugReportOsSpecific(BugReport* report, const char *pszHome)
@@ -721 +761 @@
     report->addItem(new BugReportCommand("DriverStore", PathJoin(WinSysDir.c_str(), "pnputil.exe"), "-e", NULL));
     report->addItem(new BugReportCommandTemp("RegDevKeys", PathJoin(WinSysDir.c_str(), "reg.exe"), "export",
-        "HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Enum\\Root\\NET", NULL));
+                                             "HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Enum\\Root\\NET", NULL),
+                    new BugReportFilterRegistryWin());
     report->addItem(new BugReportCommandTemp("RegDrvKeys", PathJoin(WinSysDir.c_str(), "reg.exe"), "export",
-        "HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Control\\Class\\{4D36E972-E325-11CE-BFC1-08002BE10318}", NULL));
+        "HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Control\\Class\\{4D36E972-E325-11CE-BFC1-08002BE10318}", NULL),
+                    new BugReportFilterRegistryWin());
     report->addItem(new BugReportCommandTemp("RegNetwork", PathJoin(WinSysDir.c_str(), "reg.exe"), "export",
-        "HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Control\\Network\\{4D36E972-E325-11CE-BFC1-08002BE10318}", NULL));
+        "HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Control\\Network\\{4D36E972-E325-11CE-BFC1-08002BE10318}", NULL),
+                    new BugReportFilterRegistryWin());
     report->addItem(new BugReportUsbTreeWin);
     report->addItem(new BugReportDriversWin);