Migrate to using the spiram-cpp library

Author: johnboiles

lib/Simulator/Common/CMakeLists.txt

@@ -67,6 +67,19 @@ endif()
 
 add_subdirectory(${REPO_ROOT_DIR}/lib/esp_ringbuf ${CMAKE_CURRENT_BINARY_DIR}/esp_ringbuf)
 
+# Add spiram-cpp library for simulator (via FetchContent)
+include(FetchContent)
+FetchContent_Declare(
+    spiram_cpp
+    GIT_REPOSITORY https://github.com/sindarin-inc/spiram-cpp.git
+    GIT_TAG main
+)
+FetchContent_MakeAvailable(spiram_cpp)
+
+# Use this repo's esp_heap_caps stubs instead of the ones from spiram-cpp
+target_include_directories(spiram-cpp PUBLIC ${REPO_ROOT_DIR}/lib/Simulator/stubs/esp-idf)
+target_compile_definitions(spiram-cpp PUBLIC ESP_PLATFORM=1)
+
 # Before adding mbedtls, set options to disable tests and programs
 set(ENABLE_TESTING OFF CACHE BOOL "Disable mbedtls tests" FORCE)
 set(ENABLE_PROGRAMS OFF CACHE BOOL "Disable mbedtls programs" FORCE)
@@ -81,7 +94,7 @@ endif()
 
 add_library(${PROJECT_NAME} STATIC ${SOURCES} ${HTTP_CLIENT_SOURCE})
 
-target_link_libraries(${PROJECT_NAME} PUBLIC pugixml ArduinoJson miniz astubs esp-idf-stubs nvs_flash Adafruit-GFX-Library tiny-font mbedtls mbedx509 mbedcrypto esp_ringbuf)
+target_link_libraries(${PROJECT_NAME} PUBLIC pugixml ArduinoJson miniz astubs esp-idf-stubs nvs_flash Adafruit-GFX-Library tiny-font mbedtls mbedx509 mbedcrypto esp_ringbuf spiram-cpp)
 
 target_include_directories(${PROJECT_NAME} PUBLIC
     "${REPO_ROOT_DIR}/src"

src/Communications/FileDownload.cpp

@@ -1,5 +1,6 @@
 #include "FileDownload.hpp"
 
+#include <Spiram/Memory.hpp>
 #include <esp_heap_caps.h>
 #include <esp_timer.h>
 #include <freertos/ringbuf.h>
@@ -9,7 +10,6 @@
 #include "Misc/Defer.hpp"
 #include "Misc/GUnzipStream.hpp"
 #include "Misc/RateLimiter.hpp"
-#include "Misc/SpiramAllocator.hpp"
 #include "sindarin-debug.h"
 
 // There's three ways DownloadFileToPath can run:
@@ -204,7 +204,7 @@ auto DownloadFileWithWriteBytes(
     -> int {
 
     constexpr int bufferSize = 4096;
-    auto buffer = SpiRamArrayPtr<uint8_t>(bufferSize);
+    auto buffer = SpiramArrayPtr<uint8_t>(bufferSize);
 
     return DownloadFileCommon(
         url, openedConnection,

src/Communications/HtmlCleaner.hpp

@@ -1,10 +1,10 @@
 #pragma once
 
+#include <Spiram/String.hpp>
 #include <iostream>
 #include <sstream>
 #include <string>
 
-#include "Misc/SpiramAllocator.hpp"
 #include "Renderers/RendererStream.hpp"
 #include "Storage/SFile.hpp"
 

src/Communications/HttpIstream.hpp

@@ -1,5 +1,6 @@
 #pragma once
 
+#include <Spiram/Memory.hpp>
 #include <algorithm>
 #include <esp_http_client.h>
 #include <functional>
@@ -8,7 +9,6 @@
 #include <utility>
 #include <vector>
 
-#include "Misc/SpiramAllocator.hpp"
 #include "sindarin-debug.h"
 
 template <std::size_t BUFFER_SIZE = BUFSIZ>
@@ -17,11 +17,11 @@ class HttpIStreambuf : public std::streambuf {
     HttpIStreambuf(std::function<size_t(char *, size_t)> readFunc)
         : readFunc_(std::move(readFunc)) {
         buffer_ =
-            static_cast<char *>(SpiRamMalloc(std::max(static_cast<int>(BUFFER_SIZE), BUFSIZ)));
+            static_cast<char *>(SpiramMalloc(std::max(static_cast<int>(BUFFER_SIZE), BUFSIZ)));
         setg(buffer_, buffer_, buffer_);
     }
 
-    ~HttpIStreambuf() override { SpiRamFree(buffer_); }
+    ~HttpIStreambuf() override { SpiramFree(buffer_); }
 
 private:
     char *buffer_;

src/Communications/HttpOstream.hpp

@@ -17,7 +17,7 @@ class HttpOstreambuf : public std::streambuf {
 
     ~HttpOstreambuf() override {
         sync();
-        SpiRamFree(buffer_);
+        SpiramFree(buffer_);
     }
 
 private:

src/Communications/SindarinAPI.cpp

@@ -78,7 +78,7 @@ auto SindarinAPI::checkSync(const std::string &url, CheckSyncRequest &req, Check
     ConvertToJson(req, body);
 
     size_t serializedMaxSize = (*doc).memoryUsage() * 2;
-    auto reqBody = SpiRamArrayPtr<char>(serializedMaxSize);
+    auto reqBody = SpiramArrayPtr<char>(serializedMaxSize);
     size_t bodyLength = serializeJson(*doc, reqBody.get(), serializedMaxSize);
 
     err = client->open(bodyLength);
@@ -328,7 +328,7 @@ auto SindarinAPI::uploadTelemetryFile(SFile &telemetryFile, const std::string &l
 
     // Write the file data in chunks
     size_t bufferSize = 4096;
-    auto buffer = SpiRamArrayPtr<char>(bufferSize);
+    auto buffer = SpiramArrayPtr<char>(bufferSize);
     int totalBytesWritten = 0;
     int writeSize = telemetryFile.size();
     while (totalBytesWritten < writeSize) {
@@ -386,7 +386,7 @@ auto SindarinAPI::uploadCrashReport(SFile &crashFile, const std::string &content
     defer { client->close(); };
 
     size_t bufferSize = 4096;
-    auto buffer = SpiRamArrayPtr<char>(bufferSize);
+    auto buffer = SpiramArrayPtr<char>(bufferSize);
 
     int totalBytesWritten = 0;
     while (totalBytesWritten < writeSize) {
@@ -433,7 +433,7 @@ auto SindarinAPI::getServerTime(time_t *time, bool useBle,
     }
 
     // Read the timestamp directly as a string
-    auto buffer = SpiRamArrayPtr<char>(contentLength + 1);
+    auto buffer = SpiramArrayPtr<char>(contentLength + 1);
     auto stream = client->makeReadStream();
     size_t totalRead = 0;
 
@@ -484,7 +484,7 @@ auto SindarinAPI::askQuestion(const BookQuestionRequest &req, BookQuestionRespon
     req.toJson(body);
 
     size_t serializedMaxSize = (*doc).memoryUsage() * 2;
-    auto reqBody = SpiRamArrayPtr<char>(serializedMaxSize);
+    auto reqBody = SpiramArrayPtr<char>(serializedMaxSize);
     size_t bodyLength = serializeJson(*doc, reqBody.get(), serializedMaxSize);
 
     err = client->open(bodyLength);
@@ -678,7 +678,7 @@ auto SindarinAPI::submitLastReadPageChoice(bool gotoLastReadPage, bool useBle,
     body["goto_last_read_page"] = gotoLastReadPage;
 
     size_t serializedMaxSize = (*doc).memoryUsage() * 2;
-    auto reqBody = SpiRamArrayPtr<char>(serializedMaxSize);
+    auto reqBody = SpiramArrayPtr<char>(serializedMaxSize);
     size_t bodyLength = serializeJson(*doc, reqBody.get(), serializedMaxSize);
 
     err = client->open(bodyLength);
@@ -743,7 +743,7 @@ auto SindarinAPI::fetchKindleChaptersWithUuids(const std::string &kindleUuid, in
     body["page"] = currentPage;
 
     size_t serializedMaxSize = (*doc).memoryUsage() * 2;
-    auto reqBody = SpiRamArrayPtr<char>(serializedMaxSize);
+    auto reqBody = SpiramArrayPtr<char>(serializedMaxSize);
     size_t serializedSize = serializeJson(*doc, reqBody.get(), serializedMaxSize);
 
     log_d("Request body: %s", reqBody.get());
@@ -826,7 +826,7 @@ auto SindarinAPI::navigateKindleToChapter(const std::string &kindleUuid,
     body["page"] = currentPage;
 
     size_t serializedMaxSize = (*doc).memoryUsage() * 2;
-    auto reqBody = SpiRamArrayPtr<char>(serializedMaxSize);
+    auto reqBody = SpiramArrayPtr<char>(serializedMaxSize);
     size_t serializedSize = serializeJson(*doc, reqBody.get(), serializedMaxSize);
 
     log_d("Request body: %s", reqBody.get());

src/Communications/USBSerial.cpp

@@ -1,11 +1,10 @@
 #include "Communications/USBSerial.hpp"
 
+#include <Spiram/Memory.hpp>
 #include <esp_system.h>
 #include <freertos/FreeRTOS.h>
 #include <freertos/task.h>
 
-#include "Misc/SpiramAllocator.hpp"
-
 RTC_NOINIT_ATTR bool USBSerial::usbLoggingEnabled;
 RTC_NOINIT_ATTR esp_log_level_t USBSerial::logLevel;
 
@@ -59,7 +58,7 @@ void USBSerial::enableLogging() {
 void USBSerial::rxCommandCallback(int itf, cdcacm_event_t *event) {
     size_t rxSize = 0;
 
-    auto buffer = SpiRamArrayPtr<uint8_t>(CONFIG_TINYUSB_CDC_RX_BUFSIZE + 1);
+    auto buffer = SpiramArrayPtr<uint8_t>(CONFIG_TINYUSB_CDC_RX_BUFSIZE + 1);
 
     esp_err_t ret = tinyusb_cdcacm_read(static_cast<tinyusb_cdcacm_itf_t>(itf), buffer.get(),
                                         CONFIG_TINYUSB_CDC_RX_BUFSIZE, &rxSize);

src/Communications/WiFi.cpp

@@ -1,10 +1,10 @@
 #include "Communications/WiFi.hpp"
 
+#include <Spiram/Memory.hpp>
 #include <cstring>
 #include <string>
 
 #include "Misc/Defer.hpp"
-#include "Misc/SpiramAllocator.hpp"
 #include "config.h"
 #include "sindarin-debug.h"
 
@@ -198,7 +198,7 @@ auto WiFi::scanNetworks(const std::function<void(std::shared_ptr<wifi_ap_record_
             continue;
         }
 
-        auto apRecords = SpiRamArrayPtr<wifi_ap_record_t>(apNum);
+        auto apRecords = SpiramArrayPtr<wifi_ap_record_t>(apNum);
 
         err = esp_wifi_scan_get_ap_records(&apNum, apRecords.get());
         if (err != ESP_OK) {

src/Communications/WiFiSettings.hpp

@@ -1,8 +1,8 @@
 #pragma once
 
+#include <Spiram/String.hpp>
 #include <utility>
 
-#include "Misc/SpiramAllocator.hpp"
 #include "Models/Json.hpp"
 #include "Models/JsonSerializable.hpp"
 #include "Storage/PreferencesStore.hpp"

src/Displays/DisplaySystem.cpp

@@ -267,7 +267,7 @@ void DisplaySystem::drawPBM(int16_t x, int16_t y, RendererStream &stream) {
     } else {
         // not fullscreen
         // load bitmap into memory
-        auto bitmap = SpiRamArrayPtr<uint8_t>(byteSize);
+        auto bitmap = SpiramArrayPtr<uint8_t>(byteSize);
         if (stream.readBytes(bitmap.get(), byteSize) != byteSize) {
             log_e("failed to read bitmap");
             return;