[legacy, test] Add e test to verify the heap/malloc

Signed-off-by: Douglas Reis <[email protected]>

Author: engdoreis

sw/legacy/test/CMakeLists.txt

@@ -19,3 +19,13 @@ add_custom_command(
   COMMAND ${CMAKE_OBJCOPY} -O binary "$<TARGET_FILE:spi_test>" "$<TARGET_FILE:spi_test>.bin"
   COMMAND srec_cat "$<TARGET_FILE:spi_test>.bin" -binary -offset 0x0000 -byte-swap 4 -o "$<TARGET_FILE:spi_test>.vmem" -vmem
   VERBATIM)
+
+add_executable(heap_test heap_test.c)
+target_link_libraries(heap_test common syscall)
+target_link_options(heap_test PRIVATE "-specs=nosys.specs")
+
+add_custom_command(
+  TARGET heap_test POST_BUILD
+  COMMAND ${CMAKE_OBJCOPY} -O binary "$<TARGET_FILE:heap_test>" "$<TARGET_FILE:heap_test>.bin"
+  COMMAND srec_cat "$<TARGET_FILE:heap_test>.bin" -binary -offset 0x0000 -byte-swap 4 -o "$<TARGET_FILE:heap_test>.vmem" -vmem
+  VERBATIM)

sw/legacy/test/heap_test.c

@@ -0,0 +1,119 @@
+// Copyright lowRISC contributors.
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+
+#include <stdbool.h>
+#include <stdlib.h>
+
+#include "dev_access.h"
+#include "sonata_system.h"
+#include "timer.h"
+
+extern char _heap_size[];
+#define TEST_DATA (0xDEADBEEF)
+// Total ram size minus space for .text and .rodata
+#define TEST_SIZE_BYTES ((uint32_t)_heap_size / 4)
+#define TEST_SIZE_WORDS TEST_SIZE_BYTES / 4
+
+int pass() {
+  puts("Test Passed");
+
+  while (true);
+  return 0;
+}
+
+int fail() {
+  puts("Test Failed");
+
+  while (true);
+  return -1;
+}
+
+int memory_test(uint32_t *pointer, size_t size) {
+  putstr("Memory_test testing 0x");
+  puthex(size * sizeof(uint32_t));
+  putstr(" bytes  at addr: 0x");
+  puthex(pointer);
+  putstr("...");
+  // Simple word write/read test of most of the RAM; some RAM is used by the
+  // code itself, global static and stack...
+  for (int i = 0; i < size; i++) {
+    pointer[i] = TEST_DATA + i;
+  }
+  // Read back data and check it is correct
+  for (int i = 0; i < size; i++) {
+    if (pointer[i] != TEST_DATA + i) {
+      puts("Failed");
+      return -1;
+    }
+  }
+
+  // Byte read/write test
+  uint8_t *btest = (uint8_t *)pointer;
+  for (int i = 0; i < size; i++) {
+    btest[i * 4 + (i & 3)] ^= i;
+  }
+  // Read back data and check it is correct
+  for (int i = 0; i < size; i++) {
+    uint32_t orig = TEST_DATA + i;
+    uint32_t mod  = orig ^ (uint8_t)i << (8 * (i & 3));
+    if (pointer[i] != mod) {
+      puts("Failed");
+      return -1;
+    }
+  }
+  puts("Passed");
+  return 0;
+}
+
+int main(void) {
+  uart_init(DEFAULT_UART);
+
+  putstr("\n>>> Starting ");
+  puts(__FILE__);
+
+  // Allocate a chunk of memory, run the test and free the pointer.
+  uint32_t *test_array1 = (uint32_t *)malloc(TEST_SIZE_BYTES);
+  if (test_array1 == NULL) {
+    puts("Failed to allocate memory");
+    return fail();
+  }
+  int ret = memory_test(test_array1, TEST_SIZE_WORDS);
+  free(test_array1);
+  if (ret == -1) {
+    return fail();
+  }
+
+  // Allocate another chunk of memory, Check that the pointers point to the same address, run the test, and let the
+  // pointer allocated.
+  uint32_t *test_array2 = (uint32_t *)malloc(TEST_SIZE_BYTES);
+  if (test_array2 == NULL) {
+    puts("Failed to allocate memory");
+    return fail();
+  }
+  if (test_array1 != test_array2) {
+    puts("Failed: Second malloc should reuse freed memory.");
+    return fail();
+  }
+  ret = memory_test(test_array2, TEST_SIZE_WORDS);
+  if (ret == -1) {
+    return fail();
+  }
+
+  // Allocate another chunk of memory, Check that the pointers point to different addresses, run the test, and free the
+  // pointer.
+  uint32_t *test_array3 = (uint32_t *)malloc(TEST_SIZE_BYTES);
+  if (test_array3 == NULL) {
+    puts("Failed to allocate memory");
+    return fail();
+  }
+  if (test_array3 == test_array2) {
+    puts("Failed: Allocated unfree memory.");
+    return fail();
+  }
+  ret = memory_test(test_array3, TEST_SIZE_WORDS);
+  free(test_array2);
+  free(test_array3);
+
+  return pass();
+}