Changeset 108192 in vbox for trunk/src

Timestamp:

Feb 13, 2025 11:50:11 AM (3 months ago)

Author:

vboxsync

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

167508

Message:

Runtime/tools/RTIasl: Add option to create a generated AML file to a C header, bugref:10733

File:

• trunk/src/VBox/Runtime/tools/RTIasl.cpp (modified) (12 diffs)

trunk/src/VBox/Runtime/tools/RTIasl.cpp

@@ -52 +52 @@
 #include <iprt/string.h>
 #include <iprt/vfs.h>
+#include <iprt/vfslowlevel.h>
 
 
@@ -70 +71 @@
     /** Output blob version. */
     uint32_t            u32VersionBlobOut;
+    /** The byte array name when converting to a C Header. */
+    const char          *pszCHdrArrayName;
 } RTCMDIASLOPTS;
 /** Pointer to const IASL options. */
 typedef RTCMDIASLOPTS const *PCRTCMDIASLOPTS;
+
+
+/**
+ * Private data of the to C header conversion I/O stream.
+ */
+typedef struct RTVFS2CHDRIOS
+{
+    /** The I/O stream handle. */
+    RTVFSIOSTREAM   hVfsIos;
+    /** Current stream offset. */
+    RTFOFF          offStream;
+    /** Number of characters to indent. */
+    uint32_t        cchIndent;
+    /** Number of bytes per line. */
+    uint32_t        cBytesPerLine;
+    /** Bytes outputted in the current line. */
+    uint32_t        cBytesOutput;
+} RTVFS2CHDRIOS;
+/** Pointer to the private data the to C header conversion I/O stream. */
+typedef RTVFS2CHDRIOS *PRTVFS2CHDRIOS;
+
+
+static char g_szHexDigits[17] = "0123456789abcdef";
+
+/**
+ * @interface_method_impl{RTVFSOBJOPS,pfnClose}
+ */
+static DECLCALLBACK(int) rtVfs2CHdrIos_Close(void *pvThis)
+{
+    PRTVFS2CHDRIOS pThis = (PRTVFS2CHDRIOS)pvThis;
+
+    int rc = RTVfsIoStrmPrintf(pThis->hVfsIos, "\n};\n");
+
+    RTVfsIoStrmRelease(pThis->hVfsIos);
+    pThis->hVfsIos = NIL_RTVFSIOSTREAM;
+    return rc;
+}
+
+
+/**
+ * @interface_method_impl{RTVFSOBJOPS,pfnQueryInfo}
+ */
+static DECLCALLBACK(int) rtVfs2CHdrIos_QueryInfo(void *pvThis, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr)
+{
+    PRTVFS2CHDRIOS pThis = (PRTVFS2CHDRIOS)pvThis;
+    return RTVfsIoStrmQueryInfo(pThis->hVfsIos, pObjInfo, enmAddAttr); /** @todo This is kind of wrong. */
+}
+
+
+/**
+ * @interface_method_impl{RTVFSIOSTREAMOPS,pfnRead}
+ */
+static DECLCALLBACK(int) rtVfs2CHdrIos_Read(void *pvThis, RTFOFF off, PRTSGBUF pSgBuf, bool fBlocking, size_t *pcbRead)
+{
+    RT_NOREF(pvThis, off, pSgBuf, fBlocking, pcbRead);
+    return VERR_ACCESS_DENIED;
+}
+
+
+/**
+ * @interface_method_impl{RTVFSIOSTREAMOPS,pfnWrite}
+ */
+static DECLCALLBACK(int) rtVfs2CHdrIos_Write(void *pvThis, RTFOFF off, PRTSGBUF pSgBuf, bool fBlocking, size_t *pcbWritten)
+{
+    PRTVFS2CHDRIOS pThis = (PRTVFS2CHDRIOS)pvThis;
+    AssertReturn(off == -1 || off == pThis->offStream , VERR_INVALID_PARAMETER);
+    RT_NOREF(fBlocking);
+
+    int             rc        = VINF_SUCCESS;
+    size_t          cbWritten = 0;
+    uint8_t const  *pbSrc     = (uint8_t const *)pSgBuf->paSegs[0].pvSeg;
+    size_t          cbLeft    = pSgBuf->paSegs[0].cbSeg;
+    char            achBuf[_4K];
+    uint32_t        offBuf = 0;
+    for (;;)
+    {
+        if (!cbLeft)
+            break;
+
+        /* New line? */
+        if (!pThis->cBytesOutput)
+        {
+            if (offBuf + pThis->cchIndent < RT_ELEMENTS(achBuf))
+            {
+                rc = RTVfsIoStrmWrite(pThis->hVfsIos, &achBuf[0], offBuf, true /*fBlocking*/, NULL /*pcbWritten*/);
+                if (RT_FAILURE(rc))
+                    return rc;
+                offBuf = 0;
+            }
+            memset(&achBuf[offBuf], ' ', pThis->cchIndent);
+            offBuf += pThis->cchIndent;
+        }
+
+        while (   cbLeft
+               && pThis->cBytesOutput < pThis->cBytesPerLine)
+        {
+            /* Each byte tykes up to 6 characters '0x00, ' so flush if the buffer is too full. */
+            if (offBuf + pThis->cBytesPerLine * 6 < RT_ELEMENTS(achBuf))
+            {
+                rc = RTVfsIoStrmWrite(pThis->hVfsIos, &achBuf[0], offBuf, true /*fBlocking*/, NULL /*pcbWritten*/);
+                if (RT_FAILURE(rc))
+                    return rc;
+                offBuf = 0;
+            }
+
+            achBuf[offBuf++] = '0';
+            achBuf[offBuf++] = 'x';
+            achBuf[offBuf++] = g_szHexDigits[*pbSrc >> 4];
+            achBuf[offBuf++] = g_szHexDigits[*pbSrc & 0xf];
+            cbLeft--;
+            pbSrc++;
+            pThis->cBytesOutput++;
+
+            if (cbLeft)
+            {
+                achBuf[offBuf++] = ',';
+
+                if (pThis->cBytesOutput < pThis->cBytesPerLine)
+                    achBuf[offBuf++] = ' ';
+                else
+                {
+                    achBuf[offBuf++] = '\n';
+                    pThis->cBytesOutput = 0;
+                    break;
+                }
+            }
+        }
+    }
+
+    /* Last flush */
+    if (offBuf)
+        rc = RTVfsIoStrmWrite(pThis->hVfsIos, &achBuf[0], offBuf, true /*fBlocking*/, NULL /*pcbWritten*/);
+
+    pThis->offStream += cbWritten;
+    if (pcbWritten)
+        *pcbWritten = cbWritten;
+    RTSgBufAdvance(pSgBuf, cbWritten);
+
+    return rc;
+}
+
+
+/**
+ * @interface_method_impl{RTVFSIOSTREAMOPS,pfnFlush}
+ */
+static DECLCALLBACK(int) rtVfs2CHdrIos_Flush(void *pvThis)
+{
+    PRTVFS2CHDRIOS pThis = (PRTVFS2CHDRIOS)pvThis;
+    return RTVfsIoStrmFlush(pThis->hVfsIos);
+}
+
+
+/**
+ * @interface_method_impl{RTVFSIOSTREAMOPS,pfnTell}
+ */
+static DECLCALLBACK(int) rtVfs2CHdrIos_Tell(void *pvThis, PRTFOFF poffActual)
+{
+    PRTVFS2CHDRIOS pThis = (PRTVFS2CHDRIOS)pvThis;
+    *poffActual = pThis->offStream;
+    return VINF_SUCCESS;
+}
+
+
+/**
+ * I/O stream progress operations.
+ */
+DECL_HIDDEN_CONST(const RTVFSIOSTREAMOPS) g_rtVfs2CHdrIosOps =
+{
+    { /* Obj */
+        RTVFSOBJOPS_VERSION,
+        RTVFSOBJTYPE_IO_STREAM,
+        "I/O Stream 2 C header",
+        rtVfs2CHdrIos_Close,
+        rtVfs2CHdrIos_QueryInfo,
+        NULL,
+        RTVFSOBJOPS_VERSION
+    },
+    RTVFSIOSTREAMOPS_VERSION,
+    RTVFSIOSTREAMOPS_FEAT_NO_SG,
+    rtVfs2CHdrIos_Read,
+    rtVfs2CHdrIos_Write,
+    rtVfs2CHdrIos_Flush,
+    NULL /*PollOne*/,
+    rtVfs2CHdrIos_Tell,
+    NULL /*Skip*/,
+    NULL /*ZeroFill*/,
+    RTVFSIOSTREAMOPS_VERSION,
+};
 
 
@@ -115 +306 @@
  * @returns IPRT status code.
  *
- * @param   pszFile             The input filename.
+ * @param   pszInputFile        Input filename (for writing it to the header if enabled).
+ * @param   pszFile             The output filename.
+ * @param   pszCHdrArrayName    If not NULL the output will be a C header with the given byte array containing the AML.
  * @param   phVfsIos            Where to return the input stream handle.
  */
-static int rtCmdIaslOpenOutput(const char *pszFile, PRTVFSIOSTREAM phVfsIos)
+static int rtCmdIaslOpenOutput(const char *pszInputFile, const char *pszFile, const char *pszCHdrArrayName, PRTVFSIOSTREAM phVfsIos)
 {
     int rc;
 
+    RTVFSIOSTREAM hVfsIosOut = NIL_RTVFSIOSTREAM;
     if (!strcmp(pszFile, "-"))
     {
@@ -127 +321 @@
                                       RTFILE_O_WRITE | RTFILE_O_OPEN | RTFILE_O_DENY_NONE,
                                       true /*fLeaveOpen*/,
-                                      phVfsIos);
+                                      &hVfsIosOut);
         if (RT_FAILURE(rc))
             return RTMsgErrorRc(rc, "Error opening standard output: %Rrc", rc);
@@ -135 +329 @@
         uint32_t        offError = 0;
         RTERRINFOSTATIC ErrInfo;
-        rc = RTVfsChainOpenIoStream(pszFile, RTFILE_O_WRITE | RTFILE_O_CREATE | RTFILE_O_DENY_NONE,
-                                    phVfsIos, &offError, RTErrInfoInitStatic(&ErrInfo));
+        rc = RTVfsChainOpenIoStream(pszFile, RTFILE_O_WRITE | RTFILE_O_CREATE_REPLACE | RTFILE_O_DENY_NONE,
+                                    &hVfsIosOut, &offError, RTErrInfoInitStatic(&ErrInfo));
         if (RT_FAILURE(rc))
         {
@@ -144 +338 @@
     }
 
+    if (pszCHdrArrayName)
+    {
+        /* Print the header. */
+        rc = RTVfsIoStrmPrintf(hVfsIosOut, "/*\n"
+                                           " * This file was automatically generated\n"
+                                           " * from %s\n"
+                                           " * by RTIasl.\n"
+                                           " */\n"
+                                           "\n"
+                                           "\n"
+                                           "static const unsigned char %s[] =\n"
+                                           "{\n",
+                                           pszInputFile, pszCHdrArrayName);
+
+        PRTVFS2CHDRIOS pThis;
+        rc = RTVfsNewIoStream(&g_rtVfs2CHdrIosOps, sizeof(*pThis), RTVfsIoStrmGetOpenFlags(hVfsIosOut),
+                              NIL_RTVFS, NIL_RTVFSLOCK, phVfsIos, (void **)&pThis);
+        if (RT_SUCCESS(rc))
+        {
+            pThis->hVfsIos       = hVfsIosOut;
+            pThis->offStream     =  0;
+            pThis->cchIndent     =  4;
+            pThis->cBytesPerLine = 16;
+            pThis->cBytesOutput  =  0;
+        }
+        return rc;
+    }
+    else
+        *phVfsIos = hVfsIosOut;
+
     return VINF_SUCCESS;
 
@@ -153 +377 @@
  *
  * @returns Command exit code, error messages written using RTMsg*.
+ * @param   pszInputFile        Input filename (for writing it to the header if enabled).
  * @param   pOpts               The command options.
  * @param   hVfsSrc             VFS I/O stream handle of the input.
  */
-static RTEXITCODE rtCmdIaslProcess(PCRTCMDIASLOPTS pOpts, RTVFSIOSTREAM hVfsSrc)
+static RTEXITCODE rtCmdIaslProcess(const char *pszInputFile, PCRTCMDIASLOPTS pOpts, RTVFSIOSTREAM hVfsSrc)
 {
     if (pOpts->enmInType == RTACPITBLTYPE_INVALID)
@@ -165 +390 @@
     RTERRINFOSTATIC ErrInfo;
     RTVFSIOSTREAM hVfsIosDst = NIL_RTVFSIOSTREAM;
-    int rc = rtCmdIaslOpenOutput(pOpts->pszOutFile, &hVfsIosDst);
+    int rc = rtCmdIaslOpenOutput(pszInputFile, pOpts->pszOutFile, pOpts->pszCHdrArrayName, &hVfsIosDst);
     if (RT_SUCCESS(rc))
     {
@@ -204 +429 @@
         { "--help",                             'h', RTGETOPT_REQ_NOTHING },
         { "--version",                          'v', RTGETOPT_REQ_NOTHING },
-
+        { "--text-c-hdr",                       't', RTGETOPT_REQ_STRING  }
     };
 
@@ -210 +435 @@
     Opts.enmInType              = RTACPITBLTYPE_ASL;
     Opts.enmOutType             = RTACPITBLTYPE_AML;
+    Opts.pszCHdrArrayName       = NULL;
 
     RTEXITCODE      rcExit      = RTEXITCODE_SUCCESS;
@@ -230 +456 @@
                     if (rcExit2 == RTEXITCODE_SUCCESS)
                     {
-                        rcExit2 = rtCmdIaslProcess(&Opts, hVfsSrc);
+                        rcExit2 = rtCmdIaslProcess(ValueUnion.psz, &Opts, hVfsSrc);
                         RTVfsIoStrmRelease(hVfsSrc);
                     }
@@ -248 +474 @@
                     break;
 
+                case 't':
+                    Opts.pszCHdrArrayName = ValueUnion.psz;
+                    break;
+
                 case 'h':
                     RTPrintf("Usage: to be written\nOption dump:\n");