feat(cmd): add hexdump command for memory inspection

Author: MDLZCOOL

.github/workflows/fuzzing.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Configure fuzz target
         run: |
           cmake -S . -B build-fuzz -G Ninja \
-            -DCTSHELL_ENABLE_FUZZING=ON \
+            -DCONFIG_CTSHELL_ENABLE_FUZZING=ON \
             -DCMAKE_C_COMPILER=clang
 
       - name: Build fuzz target

CMakeLists.txt

@@ -8,7 +8,7 @@ set(ctshell_incs
 
 set(CTSHELL_DEFINITIONS "")
 
-option(CTSHELL_ENABLE_FUZZING "Enable libFuzzer based fuzz testing" OFF)
+option(CONFIG_CTSHELL_ENABLE_FUZZING "Enable libFuzzer based fuzz testing" OFF)
 
 if(ESP_PLATFORM)
     set(CONFIG_CTSHELL_PORT_ESP32 1)
@@ -81,9 +81,8 @@ if(ESP_PLATFORM)
 
     target_link_libraries(${COMPONENT_LIB} INTERFACE "-T ${CMAKE_CURRENT_SOURCE_DIR}/port/esp32/ctshell_cmd.ld")
 else()
-    set(CTSHELL_DEFINITIONS ${CTSHELL_DEFINITIONS} CACHE INTERNAL "ctshell definitions")
-
-    if(CTSHELL_ENABLE_FUZZING)
+    if(CONFIG_CTSHELL_ENABLE_FUZZING)
+        list(APPEND CTSHELL_DEFINITIONS "CONFIG_CTSHELL_ENABLE_FUZZING=1")
         if(CMAKE_C_COMPILER_ID MATCHES "Clang")
             set(CTSHELL_FUZZ_TARGET ctshell_fuzz)
             set(CTSHELL_FUZZ_SRC "${CMAKE_CURRENT_SOURCE_DIR}/test/fuzz/ctshell_fuzz.c")
@@ -110,4 +109,6 @@ else()
             message(FATAL_ERROR "Fuzzing requires Clang compiler. Run with: CC=clang cmake ..")
         endif()
     endif()
+
+    set(CTSHELL_DEFINITIONS ${CTSHELL_DEFINITIONS} CACHE INTERNAL "ctshell definitions")
 endif()

ctshell.c

@@ -887,6 +887,63 @@ static int cmd_unset(int argc, char *argv[]) {
 }
 CTSHELL_EXPORT_CMD(unset, cmd_unset, "Unset a variable", CTSHELL_ATTR_NONE);
 
+static int cmd_hexdump(int argc, char *argv[]) {
+#ifdef CONFIG_CTSHELL_ENABLE_FUZZING
+    // FIXME: remove this from user code
+    return 0;
+#endif
+    if (argc != 3) {
+        ctshell_printf("Usage: hexdump <base> <len>\r\n");
+        return 0;
+    }
+
+    char *end_base = NULL;
+    char *end_len = NULL;
+    uintptr_t base = (uintptr_t) strtoull(argv[1], &end_base, 0);
+    unsigned long length = strtoul(argv[2], &end_len, 0);
+
+    if (!argv[1][0] || !argv[2][0] || *end_base != '\0' || *end_len != '\0') {
+        ctshell_printf("hexdump: invalid base or length\r\n");
+        return 0;
+    }
+    if (length == 0) {
+        return 0;
+    }
+
+    const unsigned char *mem = (const unsigned char *) base;
+    uintptr_t aligned_base = base & ~(uintptr_t) 0x0F;
+    uintptr_t data_end = base + (uintptr_t) length;
+    uintptr_t aligned_end = (data_end + 15U) & ~(uintptr_t) 0x0F;
+
+    for (uintptr_t addr = aligned_base; addr < aligned_end; addr += 16U) {
+        ctshell_printf("%08lX  ", (unsigned long) addr);
+        for (size_t i = 0; i < 16; i++) {
+            uintptr_t cur = addr + i;
+            if (cur < base || cur >= data_end) {
+                ctshell_printf("   ");
+            } else {
+                ctshell_printf("%02X ", mem[cur - base]);
+            }
+            if (i == 7) {
+                ctshell_printf(" ");
+            }
+        }
+        ctshell_printf(" |");
+        for (size_t i = 0; i < 16; i++) {
+            uintptr_t cur = addr + i;
+            if (cur < base || cur >= data_end) {
+                ctshell_printf(" ");
+            } else {
+                unsigned char ch = mem[cur - base];
+                ctshell_printf("%c", isprint(ch) ? ch : '.');
+            }
+        }
+        ctshell_printf("|\r\n");
+    }
+    return 0;
+}
+CTSHELL_EXPORT_CMD(hexdump, cmd_hexdump, "Display memory content in hex format", CTSHELL_ATTR_NONE);
+
 #ifdef CONFIG_CTSHELL_USE_FS
 static int cmd_ls(int argc, char *argv[]) {
     CHECK_FS_READY();

docs/en/api/api.rst

@@ -458,6 +458,8 @@ Ctshell provides the following built-in commands:
     * Usage: ``set [NAME] [VALUE]``
 5. **unset**: Delete an environment variable.
     * Usage: ``unset [NAME]``
+6. **hexdump**: Display memory contents in hexadecimal and ASCII format.
+    * Usage: ``hexdump <base> <len>``
 
 If file system support is enabled, the following built-in commands are available:
 

docs/zh/api/api.rst

@@ -458,6 +458,8 @@ Ctshell 提供以下内置命令：
     * 用法: ``set [NAME] [VALUE]``
 5. **unset**: 删除环境变量。
     * 用法: ``unset [NAME]``
+6. **hexdump**: 十六进制转储。
+    * 用法: ``hexdump <base> <len>``
 
 若开启文件系统支持，则下面内置命令可用：