examples/sotest: Make CMake fixture generation portable.

Replace the shell-based CMake fixture generation with Python helpers\nso the generated symtab and ROMFS sources are produced in a\nportable way across the supported build hosts.\n\nThis keeps the sotest packaged shared-library fixture flow aligned\nwith the existing Makefile path while making the generated outputs\nexplicit to CMake.

Signed-off-by: aviralgarg05 <gargaviral99@gmail.com>

Author: aviralgarg05

examples/sotest/main/CMakeLists.txt

@@ -26,6 +26,8 @@ if(CONFIG_EXAMPLES_SOTEST)
   set(SOTEST_ROMFS_SRC ${CMAKE_CURRENT_BINARY_DIR}/sotest_romfs.c)
   set(SOTEST_MODPRINT_ELF ${CMAKE_BINARY_DIR}/bin/modprint)
   set(SOTEST_SHARED_ELF ${CMAKE_BINARY_DIR}/bin/sotest)
+  set(SOTEST_GEN_SYMTAB ${CMAKE_CURRENT_SOURCE_DIR}/gen_symtab.py)
+  set(SOTEST_GEN_ROMFS_SRC ${CMAKE_CURRENT_SOURCE_DIR}/gen_romfs_source.py)
 
   # Dynamic applications are wrapped in ELF_* helper targets when the build uses
   # the non-ELF-capable compiler path.
@@ -39,10 +41,10 @@ if(CONFIG_EXAMPLES_SOTEST)
 
   add_custom_command(
     OUTPUT ${SOTEST_SYMTAB}
-    COMMAND
-      sh -c
-      "\"${NUTTX_APPS_DIR}/tools/mksymtab.sh\" \"${SOTEST_MODPRINT_ELF}\" \"${SOTEST_SHARED_ELF}\" g_sot > \"${SOTEST_SYMTAB}\""
+    COMMAND ${Python3_EXECUTABLE} ${SOTEST_GEN_SYMTAB} ${SOTEST_MODPRINT_ELF}
+            ${SOTEST_SHARED_ELF} g_sot ${SOTEST_SYMTAB}
     DEPENDS ${SOTEST_MODPRINT_TARGET} ${SOTEST_SHARED_TARGET}
+            ${SOTEST_GEN_SYMTAB}
     VERBATIM)
 
   set_source_files_properties(${SOTEST_SYMTAB} PROPERTIES GENERATED TRUE)
@@ -80,10 +82,9 @@ if(CONFIG_EXAMPLES_SOTEST)
 
     add_custom_command(
       OUTPUT ${SOTEST_ROMFS_SRC}
-      COMMAND
-        sh -c
-        "echo '#include <nuttx/compiler.h>' > \"${SOTEST_ROMFS_SRC}\" && xxd -i \"${SOTEST_ROMFS_IMG}\" | sed -e 's/^unsigned char/const unsigned char aligned_data(4)/g' >> \"${SOTEST_ROMFS_SRC}\""
-      DEPENDS ${SOTEST_ROMFS_IMG}
+      COMMAND ${Python3_EXECUTABLE} ${SOTEST_GEN_ROMFS_SRC} ${SOTEST_ROMFS_IMG}
+              ${SOTEST_ROMFS_SRC}
+      DEPENDS ${SOTEST_ROMFS_IMG} ${SOTEST_GEN_ROMFS_SRC}
       VERBATIM)
 
     set_source_files_properties(${SOTEST_ROMFS_SRC} PROPERTIES GENERATED TRUE)

examples/sotest/main/gen_romfs_source.py

@@ -0,0 +1,58 @@
+#!/usr/bin/env python3
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import pathlib
+import sys
+
+
+def usage() -> int:
+    print("usage: gen_romfs_source.py <input> <output>", file=sys.stderr)
+    return 1
+
+
+def symbol_from_path(path: pathlib.Path) -> str:
+    return path.name.replace(".", "_")
+
+
+def format_bytes(data: bytes) -> str:
+    rows = []
+    for index in range(0, len(data), 12):
+        chunk = data[index : index + 12]
+        rows.append("  " + ", ".join(f"0x{byte:02x}" for byte in chunk))
+    return ",\n".join(rows)
+
+
+def write_output(input_path: pathlib.Path, output_path: pathlib.Path) -> None:
+    symbol = symbol_from_path(input_path)
+    data = input_path.read_bytes()
+    text = "\n".join(
+        [
+            "#include <nuttx/compiler.h>",
+            "",
+            f"const unsigned char aligned_data(4) {symbol}[] = {{",
+            format_bytes(data),
+            "};",
+            f"const unsigned int {symbol}_len = {len(data)};",
+            "",
+        ]
+    )
+
+    if output_path.exists() and output_path.read_text(encoding="utf-8") == text:
+        return
+
+    output_path.write_text(text, encoding="utf-8")
+
+
+def main() -> int:
+    if len(sys.argv) != 3:
+        return usage()
+
+    input_path = pathlib.Path(sys.argv[1])
+    output_path = pathlib.Path(sys.argv[2])
+    write_output(input_path, output_path)
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

examples/sotest/main/gen_symtab.py

@@ -0,0 +1,91 @@
+#!/usr/bin/env python3
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import pathlib
+import subprocess
+import sys
+
+
+def usage() -> int:
+    print(
+        "usage: gen_symtab.py <input> [<input> ...] <prefix> <output>",
+        file=sys.stderr,
+    )
+    return 1
+
+
+def run_nm(path: pathlib.Path) -> subprocess.CompletedProcess[str]:
+    return subprocess.run(
+        ["nm", str(path)],
+        check=False,
+        text=True,
+        capture_output=True,
+    )
+
+
+def symbol_name(line: str) -> str:
+    return line.split()[-1].replace('"', "")
+
+
+def collect_symbols(paths):
+    undefined: set[str] = set()
+    defined: set[str] = set()
+
+    for path in paths:
+        result = run_nm(path)
+        if result.returncode not in (0, 1):
+            raise RuntimeError(result.stderr.strip() or f"nm failed for {path}")
+
+        for line in result.stdout.splitlines():
+            if " U " in line:
+                undefined.add(symbol_name(line))
+            elif line and not line.endswith(":"):
+                defined.add(symbol_name(line))
+
+    return sorted(undefined - defined)
+
+
+def write_output(path: pathlib.Path, prefix: str, symbols) -> None:
+    lines = [
+        "#include <nuttx/compiler.h>",
+        "#include <nuttx/symtab.h>",
+        "",
+    ]
+
+    for symbol in symbols:
+        lines.append(f"extern void *{symbol};")
+
+    lines.append("")
+    lines.append(f"const struct symtab_s {prefix}_exports[] = ")
+    lines.append("{")
+
+    for symbol in symbols:
+        lines.append(f'  {{"{symbol}", &{symbol}}},')
+
+    lines.append("};")
+    lines.append("")
+    lines.append(
+        f"const int {prefix}_nexports = sizeof({prefix}_exports) / sizeof(struct symtab_s);"
+    )
+    lines.append("")
+
+    text = "\n".join(lines)
+    if path.exists() and path.read_text(encoding="utf-8") == text:
+        return
+
+    path.write_text(text, encoding="utf-8")
+
+
+def main() -> int:
+    if len(sys.argv) < 4:
+        return usage()
+
+    *input_paths, prefix, output = sys.argv[1:]
+    symbols = collect_symbols([pathlib.Path(item) for item in input_paths])
+    write_output(pathlib.Path(output), prefix, symbols)
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())