Changeset 88956 in vbox

Timestamp:

May 9, 2021 1:09:47 PM (4 years ago)

Author:

vboxsync

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

144292

Message:

VBoxTpG,VBoxDD.d: Better warning diagnostic messages. Fixed warnings in VBoxDD.d

Location:

trunk/src

Files:

• VBox/Devices/build/VBoxDD.d (modified) (1 diff)
• bldprogs/VBoxTpG.cpp (modified) (14 diffs)

trunk/src/VBox/Devices/build/VBoxDD.d

@@ -18 +18 @@
 provider vboxdd
 {
-    probe hgcmcall__enter(void *pvCmd, unsigned int idFunction, unsigned int idClient, unsigned int cbCmd);
+    probe hgcmcall__enter(void *pvCmd, uint32_t idFunction, uint32_t idClient, uint32_t cbCmd);
     probe hgcmcall__completed__req(void *pvCmd, int rc);
     probe hgcmcall__completed__emt(void *pvCmd, int rc);
-    probe hgcmcall__completed__done(void *pvCmd, unsigned int idFunction, unsigned int idClient, int rc);
+    probe hgcmcall__completed__done(void *pvCmd, uint32_t idFunction, uint32_t idClient, int rc);
 
     probe ahci__req__submit(void *pvReq, int iTxDir, uint64_t offStart, uint64_t cbXfer);

trunk/src/bldprogs/VBoxTpG.cpp

@@ -45 +45 @@
 *   Structures and Typedefs                                                                                                      *
 *********************************************************************************************************************************/
+typedef struct VTGPROBE *PVTGPROBE;
 
 typedef struct VTGATTRS
@@ -69 +70 @@
     /** The type flags. */
     uint32_t        fType;
+    /** The argument number (0-based) for complaining/whatever. */
+    uint16_t        iArgNo;
+    /** The probe the argument belongs to (for complaining/whatever). */
+    PVTGPROBE       pProbe;
+    /** The absolute source position. */
+    size_t          offSrc;
 } VTGARG;
 typedef VTGARG *PVTGARG;
@@ -82 +89 @@
     uint32_t        offArgList;
     uint32_t        iProbe;
+    size_t          iLine;
 } VTGPROBE;
-typedef VTGPROBE *PVTGPROBE;
 
 typedef struct VTGPROVIDER
@@ -1294 +1301 @@
  *
  * @returns RTEXITCODE_FAILURE.
- * @param   pStrm               The stream.
- * @param   cb                  The offset from the current position to the
- *                              point of failure.
- * @param   pszMsg              The message to display.
- */
-static RTEXITCODE parseError(PSCMSTREAM pStrm, size_t cb, const char *pszMsg)
-{
-    if (cb)
-        ScmStreamSeekRelative(pStrm, -(ssize_t)cb);
+ * @param   pStrm       The stream.
+ * @param   fAbs        Absolute or relative offset.
+ * @param   offSeek     When @a fAbs is @c false, the offset from the current
+ *                      position to the point of failure.  When @a fAbs is @c
+ *                      true, it's the absolute position.
+ * @param   pszFormat   The message format string.
+ * @param   va          Format arguments.
+ */
+static RTEXITCODE parseErrorExV(PSCMSTREAM pStrm, bool fAbs, size_t offSeek, const char *pszFormat, va_list va)
+{
+    if (fAbs)
+        ScmStreamSeekAbsolute(pStrm, offSeek);
+    else if (offSeek != 0)
+        ScmStreamSeekRelative(pStrm, -(ssize_t)offSeek);
     size_t const off     = ScmStreamTell(pStrm);
     size_t const iLine   = ScmStreamTellLine(pStrm);
@@ -1308 +1320 @@
     size_t const offLine = ScmStreamTell(pStrm);
 
-    RTPrintf("%s:%d:%zd: error: %s.\n", g_pszScript, iLine + 1, off - offLine + 1, pszMsg);
+    va_list va2;
+    va_copy(va2, va);
+    RTPrintf("%s:%d:%zd: error: %N.\n", g_pszScript, iLine + 1, off - offLine + 1, pszFormat, &va2);
+    va_end(va2);
 
     size_t cchLine;
@@ -1325 +1340 @@
  *
  * @returns RTEXITCODE_FAILURE.
- * @param   pStrm               The stream.
- * @param   cb                  The offset from the current position to the
- *                              point of failure.
- * @param   pszMsg              The message to display.
- */
-static RTEXITCODE parseErrorAbs(PSCMSTREAM pStrm, size_t off, const char *pszMsg)
-{
-    ScmStreamSeekAbsolute(pStrm, off);
-    return parseError(pStrm, 0, pszMsg);
+ * @param   pStrm       The stream.
+ * @param   off         The offset from the current position to the point of
+ *                      failure.
+ * @param   pszFormat   The message format string.
+ * @param   ...         Format arguments.
+ */
+static RTEXITCODE parseError(PSCMSTREAM pStrm, size_t off, const char *pszFormat, ...)
+{
+    va_list va;
+    va_start(va, pszFormat);
+    RTEXITCODE rcExit = parseErrorExV(pStrm, false, off, pszFormat, va);
+    va_end(va);
+    return rcExit;
+}
+
+
+/**
+ * Parser error with line and position, absolute version.
+ *
+ * @returns RTEXITCODE_FAILURE.
+ * @param   pStrm       The stream.
+ * @param   off         The offset from the current position to the point of
+ *                      failure.
+ * @param   pszFormat   The message format string.
+ * @param   ...         Format arguments.
+ */
+static RTEXITCODE parseErrorAbs(PSCMSTREAM pStrm, size_t off, const char *pszFormat, ...)
+{
+    va_list va;
+    va_start(va, pszFormat);
+    RTEXITCODE rcExit = parseErrorExV(pStrm, true /*fAbs*/, off, pszFormat, va);
+    va_end(va);
+    return rcExit;
+}
+
+
+/**
+ * Parser warning with line and position.
+ *
+ * @param   pStrm       The stream.
+ * @param   fAbs        Absolute or relative offset.
+ * @param   offSeek     When @a fAbs is @c false, the offset from the current
+ *                      position to the point of failure.  When @a fAbs is @c
+ *                      true, it's the absolute position.
+ * @param   pszFormat   The message format string.
+ * @param   va          Format arguments.
+ */
+static void parseWarnExV(PSCMSTREAM pStrm, bool fAbs, size_t offSeek, const char *pszFormat, va_list va)
+{
+    /* Save the stream position. */
+    size_t const offOrg = ScmStreamTell(pStrm);
+
+    if (fAbs)
+        ScmStreamSeekAbsolute(pStrm, offSeek);
+    else if (offSeek != 0)
+        ScmStreamSeekRelative(pStrm, -(ssize_t)offSeek);
+    size_t const off     = ScmStreamTell(pStrm);
+    size_t const iLine   = ScmStreamTellLine(pStrm);
+    ScmStreamSeekByLine(pStrm, iLine);
+    size_t const offLine = ScmStreamTell(pStrm);
+
+    va_list va2;
+    va_copy(va2, va);
+    RTPrintf("%s:%d:%zd: warning: %N.\n", g_pszScript, iLine + 1, off - offLine + 1, pszFormat, &va2);
+    va_end(va2);
+
+    size_t cchLine;
+    SCMEOL enmEof;
+    const char *pszLine = ScmStreamGetLineByNo(pStrm, iLine, &cchLine, &enmEof);
+    if (pszLine)
+        RTPrintf("  %.*s\n"
+                 "  %*s^\n",
+                 cchLine, pszLine, off - offLine, "");
+
+    /* restore the position. */
+    int rc = ScmStreamSeekAbsolute(pStrm, offOrg);
+    AssertRC(rc);
+}
+
+#if 0 /* unused */
+/**
+ * Parser warning with line and position.
+ *
+ * @param   pStrm       The stream.
+ * @param   off         The offset from the current position to the point of
+ *                      failure.
+ * @param   pszFormat   The message format string.
+ * @param   ...         Format arguments.
+ */
+static void parseWarn(PSCMSTREAM pStrm, size_t off, const char *pszFormat, ...)
+{
+    va_list va;
+    va_start(va, pszFormat);
+    parseWarnExV(pStrm, false, off, pszFormat, va);
+    va_end(va);
+}
+#endif /* unused */
+
+/**
+ * Parser warning with line and position, absolute version.
+ *
+ * @param   pStrm       The stream.
+ * @param   off         The offset from the current position to the point of
+ *                      failure.
+ * @param   pszFormat   The message format string.
+ * @param   ...         Format arguments.
+ */
+static void parseWarnAbs(PSCMSTREAM pStrm, size_t off, const char *pszFormat, ...)
+{
+    va_list va;
+    va_start(va, pszFormat);
+    parseWarnExV(pStrm, true /*fAbs*/, off, pszFormat, va);
+    va_end(va);
 }
 
@@ -1705 +1824 @@
  * @return  Type flags.
  * @param   pszType         The type expression.
- */
-static uint32_t parseTypeExpression(const char *pszType)
+ * @param   pStrm           The input stream (for errors + warnings).
+ * @param   offSrc          The absolute source position of this expression (for
+ *                          warnings).
+ */
+static uint32_t parseTypeExpression(const char *pszType, PSCMSTREAM pStrm, size_t offSrc)
 {
     size_t cchType = strlen(pszType);
@@ -1721 +1843 @@
     if (pszType[cchType - 1] == '&')
     {
-        RTMsgWarning("Please avoid using references like '%s' for probe arguments!", pszType);
+        parseWarnAbs(pStrm, offSrc, "Please avoid using references like '%s' for probe arguments!", pszType);
         return VTG_TYPE_POINTER;
     }
@@ -1823 +1945 @@
         || MY_STRMATCH("unsigned short")
        )
-        RTMsgWarning("Please avoid using the type '%s' for probe arguments!", pszType);
+        parseWarnAbs(pStrm, offSrc, "Please avoid using the type '%s' for probe arguments!", pszType);
     if (MY_STRMATCH("unsigned"))        return VTG_TYPE_FIXED_SIZED | sizeof(int)   | VTG_TYPE_UNSIGNED;
     if (MY_STRMATCH("unsigned int"))    return VTG_TYPE_FIXED_SIZED | sizeof(int)   | VTG_TYPE_UNSIGNED;
@@ -1858 +1980 @@
  * @param   pProbe              The probe.
  * @param   pArg                The argument.
- * @param   pStrm               The input stream (for errors).
+ * @param   pStrm               The input stream (for errors + warnings).
  * @param   pchType             The type.
  * @param   cchType             The type length.
@@ -1874 +1996 @@
     if (!pArg->pszTracerType || !pArg->pszName)
         return parseError(pStrm, 1, "Out of memory");
-    pArg->fType             = parseTypeExpression(pArg->pszTracerType);
+    pArg->fType             = parseTypeExpression(pArg->pszTracerType, pStrm, pArg->offSrc);
 
     if (   (pArg->fType & VTG_TYPE_POINTER)
@@ -1965 +2087 @@
 static RTEXITCODE parseProbe(PSCMSTREAM pStrm, PVTGPROVIDER pProv)
 {
+    size_t const iProbeLine = ScmStreamTellLine(pStrm);
+
     /*
      * Next up is a name followed by an opening parenthesis.
@@ -1985 +2109 @@
     RTListAppend(&pProv->ProbeHead, &pProbe->ListEntry);
     pProbe->offArgList     = UINT32_MAX;
+    pProbe->iLine          = iProbeLine;
     pProbe->pszMangledName = RTStrDupN(pszProbe, cchProbe);
     if (!pProbe->pszMangledName)
@@ -2047 +2172 @@
                         return parseError(pStrm, 1, "Out of memory");
                     RTListAppend(&pProbe->ArgHead, &pArg->ListEntry);
-                    pProbe->cArgs++;
+                    pArg->iArgNo = pProbe->cArgs++;
+                    pArg->pProbe = pProbe;
+                    pArg->offSrc = ScmStreamTell(pStrm) - cchWord;
 
                     if (cchWord + 1 > sizeof(szArg))