Repository files navigation

Strata

Strata is a portable C++20 memory placement and allocation library with first-class ESP32 internal-RAM and PSRAM support.

It gives applications and libraries one vocabulary for allocation intent while platform-specific backends own the underlying memory mechanics. Core allocation APIs remain standard-C++ compatible, while optional PMR, FreeRTOS, and ArduinoJson integrations add specialized capabilities without leaking them into the core contract.

CIReleaseLicense: MIT

Why use Strata?

  • Explicit placement — request default, internal, preferred-external, or required-external memory.
  • Shared memory policy — embed Strata::MemoryPolicy in ZekStack library configs for consistent allocation and task-stack defaults.
  • Portable vocabulary — application code describes memory intent instead of ESP-IDF heap flags.
  • Strict capability requirements — DMA and executable requirements never silently degrade.
  • Typed ownership — raw allocation, typed construction, unique ownership, shared ownership, and move-only buffers use the same placement model.
  • STL integration — placement-aware allocators and container helpers preserve allocation intent.
  • PMR integration — use the same placement policies through standard polymorphic allocators and nested PMR containers.
  • Runtime diagnostics — inspect actual memory regions, heap statistics, and current/peak region usage.
  • Optional advanced diagnostics — opt into allocation/failure/fallback counters without a global allocation registry.
  • Optional FreeRTOS memory primitives — explicitly place task stacks and queue item storage, and own static mutex control blocks, while keeping FreeRTOS out of the core headers.
  • Optional ArduinoJson allocation — route ArduinoJson 7 document memory through the same Strata placement policies.
  • Standalone core — Strata does not depend on other ZekStack libraries.

Install

PlatformIO

[env:esp32dev]platform = espressif32
board = esp32dev
framework = arduino
lib_deps =
https://github.com/ZekStack/strata.git
build_flags =
-std=gnu++20
build_unflags =
-std=gnu++11

ArduinoJson users should add ArduinoJson separately because it remains an optional integration:

lib_deps =
https://github.com/ZekStack/strata.git
bblanchon/ArduinoJson@^7.4.3

Arduino IDE

Strata is not published to Arduino Library Manager yet.

Install it by downloading the repository ZIP or cloning it into the Arduino libraries directory:

Arduino/libraries/Strata

Quick start

#include<Arduino.h>
#include<Strata.h>voidsetup() {
Serial.begin(115200);
void *bulk = Strata::allocate(4096, Strata::Placement::PreferExternal);
if (bulk == nullptr) {
Serial.println("allocation failed");
return;
}
Serial.printf("region=%u\n", static_cast<unsigned>(Strata::regionOf(bulk)));
Strata::free(bulk);
}
voidloop() {
delay(1000);
}

Owned buffers and STL helpers use the same placement policy:

Strata::Buffer buffer(4096, Strata::Placement::PreferExternal);
auto values = Strata::makeVector<int>(Strata::Placement::PreferExternal);
values.push_back(42);

Reusable library configs can expose the shared policy type directly:

structSomeLibConfig {
Strata::MemoryPolicy memory{};
};
SomeLibConfig config;
config.memory.allocation = Strata::Placement::PreferExternal;
config.memory.taskStack = Strata::Placement::Internal;

Important notes

Important

PreferExternal may fall back to internal memory. RequireExternal never does. Capability requirements such as DMA or executable memory remain mandatory during fallback.

  • Placement describes requested policy; Region describes where memory actually resides.
  • MemoryPolicy is local configuration vocabulary, not a global Strata setting. Hard safety requirements may tighten its defaults.
  • Placement::Default means backend-default allocation and must not be used as an inheritance sentinel.
  • Invalid or corrupted Placement enum values are rejected by allocation/support APIs instead of being interpreted as another policy.
  • Generic builds support normal process-heap allocation but deliberately report external-memory and embedded hardware capabilities as unsupported. The generic backend is validated with GCC/Clang-compatible C++20 toolchains; native MSVC is not supported.
  • Raw allocation, typed ownership, and Buffer report allocation failure without requiring exceptions.
  • Strata::Allocator<T> follows standard allocator expectations and throws std::bad_alloc when exceptions are enabled.
  • The optional PMR adapter requires standard-library <memory_resource> support and exceptions to preserve std::pmr::memory_resource failure semantics.
  • External RAM is not automatically safe for DMA, ISR use, or cache-disabled flash windows.
  • FreeRTOS task, queue, and mutex integrations are opt-in and require static allocation support. The task wrapper also requires INCLUDE_vTaskDelete == 1 and INCLUDE_uxTaskGetStackHighWaterMark == 1; the mutex wrapper requires mutex and recursive-mutex support.
  • A Strata::FreeRTOS::Task owner must be destroyed/reset from a different task context than the task it owns; managed tasks must not self-delete.
  • Tasks that can execute while flash/cache is disabled should keep their stacks in internal memory.
  • ISR-accessible Strata queues require internal item storage; external queue storage is task-only.
  • Strata mutex control blocks are always internal and use FreeRTOS static creation APIs.
  • ArduinoJson integration is opt-in, targets ArduinoJson 7, and requires the Strata allocator object to outlive the JsonDocument using it.
  • Advanced allocation counters are disabled by default; enable them build-wide with STRATA_ENABLE_ADVANCED_DIAGNOSTICS=1.

Examples

ExampleDescription
BasicMinimal allocation, region inspection, and cleanup.
PlacementPlacement and region terminology.
AllocationRaw allocation and explicit requests.
DiagnosticsSupport queries and heap statistics.
TypedOwnershipTyped construction and ownership helpers.
STLPlacement-aware standard-library containers.
BufferMove-only owned byte buffers and resize behavior.
CapabilitiesDMA/executable capability requirements.
FreeRTOSTaskOptional placed FreeRTOS task stacks and diagnostics.
FreeRTOSQueueOptional typed FreeRTOS queues with placed item storage.
FreeRTOSMutexOptional static mutex and recursive-mutex ownership.
ArduinoJsonOptional ArduinoJson 7 document allocation through Strata placement.

Start with:

examples/Basic

Documentation

DocumentDescription
docs/getting-started.mdInstallation, first allocation, and placement choices.
docs/placement.mdStable placement, region, fallback, reallocation, and safety semantics.
docs/memory-policy.mdShared ZekStack library configuration contract for allocations and task stacks.
docs/migration.mdRecipes for migrating raw allocation, library policies, containers, tasks, queues, mutexes, and adapters.
docs/configuration.mdBuild requirements, backend selection, PSRAM, diagnostics, exceptions, and optional integrations.
docs/api.mdPublic API overview and include boundaries.
docs/examples.mdGuide to the included sketches.
docs/troubleshooting.mdCommon allocation, PSRAM, capability, and integration issues.
docs/architecture.mdArchitectural boundaries, stable vocabulary, platform mapping, and failure contracts.
docs/diagnostics.mdRegion/heap introspection plus optional allocation/failure/fallback counters.
docs/typed-ownership.mdTyped raw storage, object lifetime, and unique ownership.
docs/stl.mdStateful allocator semantics and STL helpers.
docs/pmr.mdOptional placement-aware std::pmr::memory_resource integration.
docs/buffer.mdOwned byte buffers and resize semantics.
docs/capabilities.mdRequired DMA/executable constraints and safety boundaries.
docs/freertos-tasks.mdOptional task-stack placement and static task creation.
docs/freertos-queues.mdOptional typed queue storage placement and ISR safety.
docs/freertos-mutexes.mdOptional internal static mutex and recursive-mutex ownership.
docs/arduinojson.mdOptional ArduinoJson 7 custom allocator integration.
docs/roadmap.mdCompleted v0.1.0 roadmap and post-release planning boundary.
docs/ecosystem-adoption.mdPlanned adoption across ZekStack and Core.
docs/releasing.mdVersion/tag requirements and the validated GitHub release flow.

API overview

void *raw = Strata::allocate(4096, Strata::Placement::PreferExternal);
void *dma = Strata::allocate(Strata::AllocationRequest{
.sizeBytes = 1024,
.placement = Strata::Placement::Internal,
.alignment = 32,
.capabilities = Strata::Capability::Dma,
});
Strata::MemoryPolicy policy{
.allocation = Strata::Placement::PreferExternal,
.taskStack = Strata::Placement::Internal,
};
Strata::Buffer buffer(4096, Strata::Placement::PreferExternal);
auto object = Strata::makeUnique<MyType>(Strata::Placement::PreferExternal, constructorArg);
auto values = Strata::makeVector<int>(Strata::Placement::PreferExternal);
auto stats = Strata::memoryStats(Strata::Region::Internal);
Strata::free(raw);
Strata::free(dma);

With advanced diagnostics enabled at build time:

auto total = Strata::allocationDiagnostics();
auto preferred = Strata::allocationDiagnostics(Strata::Placement::PreferExternal);
Serial.printf("failures=%u fallbacks=%u\n",
static_cast<unsigned>(total.failures),
static_cast<unsigned>(preferred.preferredExternalFallbacks));

Optional PMR integration:

#include<strata/pmr/MemoryResource.h>
Strata::MemoryResource resource{Strata::Placement::PreferExternal};
std::pmr::vector<std::pmr::string> values{&resource};
values.emplace_back("Strata");

Optional ArduinoJson integration:

#include<ArduinoJson.h>
#include<strata/arduinojson/Allocator.h>
Strata::ArduinoJson::Allocator allocator{Strata::Placement::PreferExternal};
ArduinoJson::JsonDocument document{&allocator};
document["library"] = "Strata";

Optional FreeRTOS integrations:

#include<strata/freertos/Task.h>
#include<strata/freertos/Queue.h>
#include<strata/freertos/Mutex.h>
Strata::FreeRTOS::Task task = Strata::FreeRTOS::Task::create(worker, nullptr, {
.name = "worker",
.stackBytes = 4096,
.stackPlacement = Strata::Placement::PreferExternal,
.priority = 1,
.affinity = Strata::FreeRTOS::NoAffinity,
});
auto queue = Strata::FreeRTOS::Queue<Event>::create({
.length = 16,
.storagePlacement = Strata::Placement::PreferExternal,
.usage = Strata::FreeRTOS::QueueUsage::TaskOnly,
});
auto mutex = Strata::FreeRTOS::Mutex::create();
auto recursiveMutex = Strata::FreeRTOS::RecursiveMutex::create();

Compatibility

ItemSupport
LanguageC++20
Core APIStandard C++
ESP32 backendArduino ESP32 / ESP-IDF-compatible build environment
Generic backendGCC/Clang-compatible C++20 process heap; native MSVC is not supported
External memoryESP32 PSRAM through ESP-IDF heap capabilities
Core dependenciesnone
Optional PMR integrationStandard-library <memory_resource> with exceptions enabled
Optional FreeRTOS integrationFreeRTOS with static allocation; task deletion/high-water-mark APIs for tasks; mutex and recursive-mutex support for mutex wrappers
Optional ArduinoJson integrationArduinoJson 7; CI compatibility target 7.4.3
Advanced diagnosticsOptional compile-time counters; disabled by default
ExceptionsNot required by core APIs; STL/PMR standard allocator surfaces follow standard semantics
Statusv0.1.1 compatibility release for ZekStack memory-policy adoption

License

MIT — see LICENSE.md.

ZekStack

Part of the ZekStack library stack. v0.1.1 adds the common consuming-library memory-policy contract and static FreeRTOS mutex ownership so Worker and subsequent libraries can migrate without inventing library-specific placement vocabulary.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Repository files navigation

Strata

Strata is a portable C++20 memory placement and allocation library with first-class ESP32 internal-RAM and PSRAM support.

It gives applications and libraries one vocabulary for allocation intent while platform-specific backends own the underlying memory mechanics. Core allocation APIs remain standard-C++ compatible, while optional PMR, FreeRTOS, and ArduinoJson integrations add specialized capabilities without leaking them into the core contract.

CIReleaseLicense: MIT

Why use Strata?

  • Explicit placement — request default, internal, preferred-external, or required-external memory.
  • Shared memory policy — embed Strata::MemoryPolicy in ZekStack library configs for consistent allocation and task-stack defaults.
  • Portable vocabulary — application code describes memory intent instead of ESP-IDF heap flags.
  • Strict capability requirements — DMA and executable requirements never silently degrade.
  • Typed ownership — raw allocation, typed construction, unique ownership, shared ownership, and move-only buffers use the same placement model.
  • STL integration — placement-aware allocators and container helpers preserve allocation intent.
  • PMR integration — use the same placement policies through standard polymorphic allocators and nested PMR containers.
  • Runtime diagnostics — inspect actual memory regions, heap statistics, and current/peak region usage.
  • Optional advanced diagnostics — opt into allocation/failure/fallback counters without a global allocation registry.
  • Optional FreeRTOS memory primitives — explicitly place task stacks and queue item storage, and own static mutex control blocks, while keeping FreeRTOS out of the core headers.
  • Optional ArduinoJson allocation — route ArduinoJson 7 document memory through the same Strata placement policies.
  • Standalone core — Strata does not depend on other ZekStack libraries.

Install

PlatformIO

[env:esp32dev]platform = espressif32
board = esp32dev
framework = arduino
lib_deps =
https://github.com/ZekStack/strata.git
build_flags =
-std=gnu++20
build_unflags =
-std=gnu++11

ArduinoJson users should add ArduinoJson separately because it remains an optional integration:

lib_deps =
https://github.com/ZekStack/strata.git
bblanchon/ArduinoJson@^7.4.3

Arduino IDE

Strata is not published to Arduino Library Manager yet.

Install it by downloading the repository ZIP or cloning it into the Arduino libraries directory:

Arduino/libraries/Strata

Quick start

#include<Arduino.h>
#include<Strata.h>voidsetup() {
Serial.begin(115200);
void *bulk = Strata::allocate(4096, Strata::Placement::PreferExternal);
if (bulk == nullptr) {
Serial.println("allocation failed");
return;
}
Serial.printf("region=%u\n", static_cast<unsigned>(Strata::regionOf(bulk)));
Strata::free(bulk);
}
voidloop() {
delay(1000);
}

Owned buffers and STL helpers use the same placement policy:

Strata::Buffer buffer(4096, Strata::Placement::PreferExternal);
auto values = Strata::makeVector<int>(Strata::Placement::PreferExternal);
values.push_back(42);

Reusable library configs can expose the shared policy type directly:

structSomeLibConfig {
Strata::MemoryPolicy memory{};
};
SomeLibConfig config;
config.memory.allocation = Strata::Placement::PreferExternal;
config.memory.taskStack = Strata::Placement::Internal;

Important notes

Important

PreferExternal may fall back to internal memory. RequireExternal never does. Capability requirements such as DMA or executable memory remain mandatory during fallback.

  • Placement describes requested policy; Region describes where memory actually resides.
  • MemoryPolicy is local configuration vocabulary, not a global Strata setting. Hard safety requirements may tighten its defaults.
  • Placement::Default means backend-default allocation and must not be used as an inheritance sentinel.
  • Invalid or corrupted Placement enum values are rejected by allocation/support APIs instead of being interpreted as another policy.
  • Generic builds support normal process-heap allocation but deliberately report external-memory and embedded hardware capabilities as unsupported. The generic backend is validated with GCC/Clang-compatible C++20 toolchains; native MSVC is not supported.
  • Raw allocation, typed ownership, and Buffer report allocation failure without requiring exceptions.
  • Strata::Allocator<T> follows standard allocator expectations and throws std::bad_alloc when exceptions are enabled.
  • The optional PMR adapter requires standard-library <memory_resource> support and exceptions to preserve std::pmr::memory_resource failure semantics.
  • External RAM is not automatically safe for DMA, ISR use, or cache-disabled flash windows.
  • FreeRTOS task, queue, and mutex integrations are opt-in and require static allocation support. The task wrapper also requires INCLUDE_vTaskDelete == 1 and INCLUDE_uxTaskGetStackHighWaterMark == 1; the mutex wrapper requires mutex and recursive-mutex support.
  • A Strata::FreeRTOS::Task owner must be destroyed/reset from a different task context than the task it owns; managed tasks must not self-delete.
  • Tasks that can execute while flash/cache is disabled should keep their stacks in internal memory.
  • ISR-accessible Strata queues require internal item storage; external queue storage is task-only.
  • Strata mutex control blocks are always internal and use FreeRTOS static creation APIs.
  • ArduinoJson integration is opt-in, targets ArduinoJson 7, and requires the Strata allocator object to outlive the JsonDocument using it.
  • Advanced allocation counters are disabled by default; enable them build-wide with STRATA_ENABLE_ADVANCED_DIAGNOSTICS=1.

Examples

ExampleDescription
BasicMinimal allocation, region inspection, and cleanup.
PlacementPlacement and region terminology.
AllocationRaw allocation and explicit requests.
DiagnosticsSupport queries and heap statistics.
TypedOwnershipTyped construction and ownership helpers.
STLPlacement-aware standard-library containers.
BufferMove-only owned byte buffers and resize behavior.
CapabilitiesDMA/executable capability requirements.
FreeRTOSTaskOptional placed FreeRTOS task stacks and diagnostics.
FreeRTOSQueueOptional typed FreeRTOS queues with placed item storage.
FreeRTOSMutexOptional static mutex and recursive-mutex ownership.
ArduinoJsonOptional ArduinoJson 7 document allocation through Strata placement.

Start with:

examples/Basic

Documentation

DocumentDescription
docs/getting-started.mdInstallation, first allocation, and placement choices.
docs/placement.mdStable placement, region, fallback, reallocation, and safety semantics.
docs/memory-policy.mdShared ZekStack library configuration contract for allocations and task stacks.
docs/migration.mdRecipes for migrating raw allocation, library policies, containers, tasks, queues, mutexes, and adapters.
docs/configuration.mdBuild requirements, backend selection, PSRAM, diagnostics, exceptions, and optional integrations.
docs/api.mdPublic API overview and include boundaries.
docs/examples.mdGuide to the included sketches.
docs/troubleshooting.mdCommon allocation, PSRAM, capability, and integration issues.
docs/architecture.mdArchitectural boundaries, stable vocabulary, platform mapping, and failure contracts.
docs/diagnostics.mdRegion/heap introspection plus optional allocation/failure/fallback counters.
docs/typed-ownership.mdTyped raw storage, object lifetime, and unique ownership.
docs/stl.mdStateful allocator semantics and STL helpers.
docs/pmr.mdOptional placement-aware std::pmr::memory_resource integration.
docs/buffer.mdOwned byte buffers and resize semantics.
docs/capabilities.mdRequired DMA/executable constraints and safety boundaries.
docs/freertos-tasks.mdOptional task-stack placement and static task creation.
docs/freertos-queues.mdOptional typed queue storage placement and ISR safety.
docs/freertos-mutexes.mdOptional internal static mutex and recursive-mutex ownership.
docs/arduinojson.mdOptional ArduinoJson 7 custom allocator integration.
docs/roadmap.mdCompleted v0.1.0 roadmap and post-release planning boundary.
docs/ecosystem-adoption.mdPlanned adoption across ZekStack and Core.
docs/releasing.mdVersion/tag requirements and the validated GitHub release flow.

API overview

void *raw = Strata::allocate(4096, Strata::Placement::PreferExternal);
void *dma = Strata::allocate(Strata::AllocationRequest{
.sizeBytes = 1024,
.placement = Strata::Placement::Internal,
.alignment = 32,
.capabilities = Strata::Capability::Dma,
});
Strata::MemoryPolicy policy{
.allocation = Strata::Placement::PreferExternal,
.taskStack = Strata::Placement::Internal,
};
Strata::Buffer buffer(4096, Strata::Placement::PreferExternal);
auto object = Strata::makeUnique<MyType>(Strata::Placement::PreferExternal, constructorArg);
auto values = Strata::makeVector<int>(Strata::Placement::PreferExternal);
auto stats = Strata::memoryStats(Strata::Region::Internal);
Strata::free(raw);
Strata::free(dma);

With advanced diagnostics enabled at build time:

auto total = Strata::allocationDiagnostics();
auto preferred = Strata::allocationDiagnostics(Strata::Placement::PreferExternal);
Serial.printf("failures=%u fallbacks=%u\n",
static_cast<unsigned>(total.failures),
static_cast<unsigned>(preferred.preferredExternalFallbacks));

Optional PMR integration:

#include<strata/pmr/MemoryResource.h>
Strata::MemoryResource resource{Strata::Placement::PreferExternal};
std::pmr::vector<std::pmr::string> values{&resource};
values.emplace_back("Strata");

Optional ArduinoJson integration:

#include<ArduinoJson.h>
#include<strata/arduinojson/Allocator.h>
Strata::ArduinoJson::Allocator allocator{Strata::Placement::PreferExternal};
ArduinoJson::JsonDocument document{&allocator};
document["library"] = "Strata";

Optional FreeRTOS integrations:

#include<strata/freertos/Task.h>
#include<strata/freertos/Queue.h>
#include<strata/freertos/Mutex.h>
Strata::FreeRTOS::Task task = Strata::FreeRTOS::Task::create(worker, nullptr, {
.name = "worker",
.stackBytes = 4096,
.stackPlacement = Strata::Placement::PreferExternal,
.priority = 1,
.affinity = Strata::FreeRTOS::NoAffinity,
});
auto queue = Strata::FreeRTOS::Queue<Event>::create({
.length = 16,
.storagePlacement = Strata::Placement::PreferExternal,
.usage = Strata::FreeRTOS::QueueUsage::TaskOnly,
});
auto mutex = Strata::FreeRTOS::Mutex::create();
auto recursiveMutex = Strata::FreeRTOS::RecursiveMutex::create();

Compatibility

ItemSupport
LanguageC++20
Core APIStandard C++
ESP32 backendArduino ESP32 / ESP-IDF-compatible build environment
Generic backendGCC/Clang-compatible C++20 process heap; native MSVC is not supported
External memoryESP32 PSRAM through ESP-IDF heap capabilities
Core dependenciesnone
Optional PMR integrationStandard-library <memory_resource> with exceptions enabled
Optional FreeRTOS integrationFreeRTOS with static allocation; task deletion/high-water-mark APIs for tasks; mutex and recursive-mutex support for mutex wrappers
Optional ArduinoJson integrationArduinoJson 7; CI compatibility target 7.4.3
Advanced diagnosticsOptional compile-time counters; disabled by default
ExceptionsNot required by core APIs; STL/PMR standard allocator surfaces follow standard semantics
Statusv0.1.1 compatibility release for ZekStack memory-policy adoption

License

MIT — see LICENSE.md.

ZekStack

Part of the ZekStack library stack. v0.1.1 adds the common consuming-library memory-policy contract and static FreeRTOS mutex ownership so Worker and subsequent libraries can migrate without inventing library-specific placement vocabulary.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

Strata

Strata is a portable C++20 memory placement and allocation library with first-class ESP32 internal-RAM and PSRAM support.

It gives applications and libraries one vocabulary for allocation intent while platform-specific backends own the underlying memory mechanics. Core allocation APIs remain standard-C++ compatible, while optional PMR, FreeRTOS, and ArduinoJson integrations add specialized capabilities without leaking them into the core contract.

CIReleaseLicense: MIT

Why use Strata?

  • Explicit placement — request default, internal, preferred-external, or required-external memory.
  • Shared memory policy — embed Strata::MemoryPolicy in ZekStack library configs for consistent allocation and task-stack defaults.
  • Portable vocabulary — application code describes memory intent instead of ESP-IDF heap flags.
  • Strict capability requirements — DMA and executable requirements never silently degrade.
  • Typed ownership — raw allocation, typed construction, unique ownership, shared ownership, and move-only buffers use the same placement model.
  • STL integration — placement-aware allocators and container helpers preserve allocation intent.
  • PMR integration — use the same placement policies through standard polymorphic allocators and nested PMR containers.
  • Runtime diagnostics — inspect actual memory regions, heap statistics, and current/peak region usage.
  • Optional advanced diagnostics — opt into allocation/failure/fallback counters without a global allocation registry.
  • Optional FreeRTOS memory primitives — explicitly place task stacks and queue item storage, and own static mutex control blocks, while keeping FreeRTOS out of the core headers.
  • Optional ArduinoJson allocation — route ArduinoJson 7 document memory through the same Strata placement policies.
  • Standalone core — Strata does not depend on other ZekStack libraries.

Install

PlatformIO

[env:esp32dev]platform = espressif32
board = esp32dev
framework = arduino
lib_deps =
https://github.com/ZekStack/strata.git
build_flags =
-std=gnu++20
build_unflags =
-std=gnu++11

ArduinoJson users should add ArduinoJson separately because it remains an optional integration:

lib_deps =
https://github.com/ZekStack/strata.git
bblanchon/ArduinoJson@^7.4.3

Arduino IDE

Strata is not published to Arduino Library Manager yet.

Install it by downloading the repository ZIP or cloning it into the Arduino libraries directory:

Arduino/libraries/Strata

Quick start

#include<Arduino.h>
#include<Strata.h>voidsetup() {
Serial.begin(115200);
void *bulk = Strata::allocate(4096, Strata::Placement::PreferExternal);
if (bulk == nullptr) {
Serial.println("allocation failed");
return;
}
Serial.printf("region=%u\n", static_cast<unsigned>(Strata::regionOf(bulk)));
Strata::free(bulk);
}
voidloop() {
delay(1000);
}

Owned buffers and STL helpers use the same placement policy:

Strata::Buffer buffer(4096, Strata::Placement::PreferExternal);
auto values = Strata::makeVector<int>(Strata::Placement::PreferExternal);
values.push_back(42);

Reusable library configs can expose the shared policy type directly:

structSomeLibConfig {
Strata::MemoryPolicy memory{};
};
SomeLibConfig config;
config.memory.allocation = Strata::Placement::PreferExternal;
config.memory.taskStack = Strata::Placement::Internal;

Important notes

Important

PreferExternal may fall back to internal memory. RequireExternal never does. Capability requirements such as DMA or executable memory remain mandatory during fallback.

  • Placement describes requested policy; Region describes where memory actually resides.
  • MemoryPolicy is local configuration vocabulary, not a global Strata setting. Hard safety requirements may tighten its defaults.
  • Placement::Default means backend-default allocation and must not be used as an inheritance sentinel.
  • Invalid or corrupted Placement enum values are rejected by allocation/support APIs instead of being interpreted as another policy.
  • Generic builds support normal process-heap allocation but deliberately report external-memory and embedded hardware capabilities as unsupported. The generic backend is validated with GCC/Clang-compatible C++20 toolchains; native MSVC is not supported.
  • Raw allocation, typed ownership, and Buffer report allocation failure without requiring exceptions.
  • Strata::Allocator<T> follows standard allocator expectations and throws std::bad_alloc when exceptions are enabled.
  • The optional PMR adapter requires standard-library <memory_resource> support and exceptions to preserve std::pmr::memory_resource failure semantics.
  • External RAM is not automatically safe for DMA, ISR use, or cache-disabled flash windows.
  • FreeRTOS task, queue, and mutex integrations are opt-in and require static allocation support. The task wrapper also requires INCLUDE_vTaskDelete == 1 and INCLUDE_uxTaskGetStackHighWaterMark == 1; the mutex wrapper requires mutex and recursive-mutex support.
  • A Strata::FreeRTOS::Task owner must be destroyed/reset from a different task context than the task it owns; managed tasks must not self-delete.
  • Tasks that can execute while flash/cache is disabled should keep their stacks in internal memory.
  • ISR-accessible Strata queues require internal item storage; external queue storage is task-only.
  • Strata mutex control blocks are always internal and use FreeRTOS static creation APIs.
  • ArduinoJson integration is opt-in, targets ArduinoJson 7, and requires the Strata allocator object to outlive the JsonDocument using it.
  • Advanced allocation counters are disabled by default; enable them build-wide with STRATA_ENABLE_ADVANCED_DIAGNOSTICS=1.

Examples

ExampleDescription
BasicMinimal allocation, region inspection, and cleanup.
PlacementPlacement and region terminology.
AllocationRaw allocation and explicit requests.
DiagnosticsSupport queries and heap statistics.
TypedOwnershipTyped construction and ownership helpers.
STLPlacement-aware standard-library containers.
BufferMove-only owned byte buffers and resize behavior.
CapabilitiesDMA/executable capability requirements.
FreeRTOSTaskOptional placed FreeRTOS task stacks and diagnostics.
FreeRTOSQueueOptional typed FreeRTOS queues with placed item storage.
FreeRTOSMutexOptional static mutex and recursive-mutex ownership.
ArduinoJsonOptional ArduinoJson 7 document allocation through Strata placement.

Start with:

examples/Basic

Documentation

DocumentDescription
docs/getting-started.mdInstallation, first allocation, and placement choices.
docs/placement.mdStable placement, region, fallback, reallocation, and safety semantics.
docs/memory-policy.mdShared ZekStack library configuration contract for allocations and task stacks.
docs/migration.mdRecipes for migrating raw allocation, library policies, containers, tasks, queues, mutexes, and adapters.
docs/configuration.mdBuild requirements, backend selection, PSRAM, diagnostics, exceptions, and optional integrations.
docs/api.mdPublic API overview and include boundaries.
docs/examples.mdGuide to the included sketches.
docs/troubleshooting.mdCommon allocation, PSRAM, capability, and integration issues.
docs/architecture.mdArchitectural boundaries, stable vocabulary, platform mapping, and failure contracts.
docs/diagnostics.mdRegion/heap introspection plus optional allocation/failure/fallback counters.
docs/typed-ownership.mdTyped raw storage, object lifetime, and unique ownership.
docs/stl.mdStateful allocator semantics and STL helpers.
docs/pmr.mdOptional placement-aware std::pmr::memory_resource integration.
docs/buffer.mdOwned byte buffers and resize semantics.
docs/capabilities.mdRequired DMA/executable constraints and safety boundaries.
docs/freertos-tasks.mdOptional task-stack placement and static task creation.
docs/freertos-queues.mdOptional typed queue storage placement and ISR safety.
docs/freertos-mutexes.mdOptional internal static mutex and recursive-mutex ownership.
docs/arduinojson.mdOptional ArduinoJson 7 custom allocator integration.
docs/roadmap.mdCompleted v0.1.0 roadmap and post-release planning boundary.
docs/ecosystem-adoption.mdPlanned adoption across ZekStack and Core.
docs/releasing.mdVersion/tag requirements and the validated GitHub release flow.

API overview

void *raw = Strata::allocate(4096, Strata::Placement::PreferExternal);
void *dma = Strata::allocate(Strata::AllocationRequest{
.sizeBytes = 1024,
.placement = Strata::Placement::Internal,
.alignment = 32,
.capabilities = Strata::Capability::Dma,
});
Strata::MemoryPolicy policy{
.allocation = Strata::Placement::PreferExternal,
.taskStack = Strata::Placement::Internal,
};
Strata::Buffer buffer(4096, Strata::Placement::PreferExternal);
auto object = Strata::makeUnique<MyType>(Strata::Placement::PreferExternal, constructorArg);
auto values = Strata::makeVector<int>(Strata::Placement::PreferExternal);
auto stats = Strata::memoryStats(Strata::Region::Internal);
Strata::free(raw);
Strata::free(dma);

With advanced diagnostics enabled at build time:

auto total = Strata::allocationDiagnostics();
auto preferred = Strata::allocationDiagnostics(Strata::Placement::PreferExternal);
Serial.printf("failures=%u fallbacks=%u\n",
static_cast<unsigned>(total.failures),
static_cast<unsigned>(preferred.preferredExternalFallbacks));

Optional PMR integration:

#include<strata/pmr/MemoryResource.h>
Strata::MemoryResource resource{Strata::Placement::PreferExternal};
std::pmr::vector<std::pmr::string> values{&resource};
values.emplace_back("Strata");

Optional ArduinoJson integration:

#include<ArduinoJson.h>
#include<strata/arduinojson/Allocator.h>
Strata::ArduinoJson::Allocator allocator{Strata::Placement::PreferExternal};
ArduinoJson::JsonDocument document{&allocator};
document["library"] = "Strata";

Optional FreeRTOS integrations:

#include<strata/freertos/Task.h>
#include<strata/freertos/Queue.h>
#include<strata/freertos/Mutex.h>
Strata::FreeRTOS::Task task = Strata::FreeRTOS::Task::create(worker, nullptr, {
.name = "worker",
.stackBytes = 4096,
.stackPlacement = Strata::Placement::PreferExternal,
.priority = 1,
.affinity = Strata::FreeRTOS::NoAffinity,
});
auto queue = Strata::FreeRTOS::Queue<Event>::create({
.length = 16,
.storagePlacement = Strata::Placement::PreferExternal,
.usage = Strata::FreeRTOS::QueueUsage::TaskOnly,
});
auto mutex = Strata::FreeRTOS::Mutex::create();
auto recursiveMutex = Strata::FreeRTOS::RecursiveMutex::create();

Compatibility

ItemSupport
LanguageC++20
Core APIStandard C++
ESP32 backendArduino ESP32 / ESP-IDF-compatible build environment
Generic backendGCC/Clang-compatible C++20 process heap; native MSVC is not supported
External memoryESP32 PSRAM through ESP-IDF heap capabilities
Core dependenciesnone
Optional PMR integrationStandard-library <memory_resource> with exceptions enabled
Optional FreeRTOS integrationFreeRTOS with static allocation; task deletion/high-water-mark APIs for tasks; mutex and recursive-mutex support for mutex wrappers
Optional ArduinoJson integrationArduinoJson 7; CI compatibility target 7.4.3
Advanced diagnosticsOptional compile-time counters; disabled by default
ExceptionsNot required by core APIs; STL/PMR standard allocator surfaces follow standard semantics
Statusv0.1.1 compatibility release for ZekStack memory-policy adoption

License

MIT — see LICENSE.md.

ZekStack

Part of the ZekStack library stack. v0.1.1 adds the common consuming-library memory-policy contract and static FreeRTOS mutex ownership so Worker and subsequent libraries can migrate without inventing library-specific placement vocabulary.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

Strata

Strata is a portable C++20 memory placement and allocation library with first-class ESP32 internal-RAM and PSRAM support.

It gives applications and libraries one vocabulary for allocation intent while platform-specific backends own the underlying memory mechanics. Core allocation APIs remain standard-C++ compatible, while optional PMR, FreeRTOS, and ArduinoJson integrations add specialized capabilities without leaking them into the core contract.

CIReleaseLicense: MIT

Why use Strata?

  • Explicit placement — request default, internal, preferred-external, or required-external memory.
  • Shared memory policy — embed Strata::MemoryPolicy in ZekStack library configs for consistent allocation and task-stack defaults.
  • Portable vocabulary — application code describes memory intent instead of ESP-IDF heap flags.
  • Strict capability requirements — DMA and executable requirements never silently degrade.
  • Typed ownership — raw allocation, typed construction, unique ownership, shared ownership, and move-only buffers use the same placement model.
  • STL integration — placement-aware allocators and container helpers preserve allocation intent.
  • PMR integration — use the same placement policies through standard polymorphic allocators and nested PMR containers.
  • Runtime diagnostics — inspect actual memory regions, heap statistics, and current/peak region usage.
  • Optional advanced diagnostics — opt into allocation/failure/fallback counters without a global allocation registry.
  • Optional FreeRTOS memory primitives — explicitly place task stacks and queue item storage, and own static mutex control blocks, while keeping FreeRTOS out of the core headers.
  • Optional ArduinoJson allocation — route ArduinoJson 7 document memory through the same Strata placement policies.
  • Standalone core — Strata does not depend on other ZekStack libraries.

Install

PlatformIO

[env:esp32dev]platform = espressif32
board = esp32dev
framework = arduino
lib_deps =
https://github.com/ZekStack/strata.git
build_flags =
-std=gnu++20
build_unflags =
-std=gnu++11

ArduinoJson users should add ArduinoJson separately because it remains an optional integration:

lib_deps =
https://github.com/ZekStack/strata.git
bblanchon/ArduinoJson@^7.4.3

Arduino IDE

Strata is not published to Arduino Library Manager yet.

Install it by downloading the repository ZIP or cloning it into the Arduino libraries directory:

Arduino/libraries/Strata

Quick start

#include<Arduino.h>
#include<Strata.h>voidsetup() {
Serial.begin(115200);
void *bulk = Strata::allocate(4096, Strata::Placement::PreferExternal);
if (bulk == nullptr) {
Serial.println("allocation failed");
return;
}
Serial.printf("region=%u\n", static_cast<unsigned>(Strata::regionOf(bulk)));
Strata::free(bulk);
}
voidloop() {
delay(1000);
}

Owned buffers and STL helpers use the same placement policy:

Strata::Buffer buffer(4096, Strata::Placement::PreferExternal);
auto values = Strata::makeVector<int>(Strata::Placement::PreferExternal);
values.push_back(42);

Reusable library configs can expose the shared policy type directly:

structSomeLibConfig {
Strata::MemoryPolicy memory{};
};
SomeLibConfig config;
config.memory.allocation = Strata::Placement::PreferExternal;
config.memory.taskStack = Strata::Placement::Internal;

Important notes

Important

PreferExternal may fall back to internal memory. RequireExternal never does. Capability requirements such as DMA or executable memory remain mandatory during fallback.

  • Placement describes requested policy; Region describes where memory actually resides.
  • MemoryPolicy is local configuration vocabulary, not a global Strata setting. Hard safety requirements may tighten its defaults.
  • Placement::Default means backend-default allocation and must not be used as an inheritance sentinel.
  • Invalid or corrupted Placement enum values are rejected by allocation/support APIs instead of being interpreted as another policy.
  • Generic builds support normal process-heap allocation but deliberately report external-memory and embedded hardware capabilities as unsupported. The generic backend is validated with GCC/Clang-compatible C++20 toolchains; native MSVC is not supported.
  • Raw allocation, typed ownership, and Buffer report allocation failure without requiring exceptions.
  • Strata::Allocator<T> follows standard allocator expectations and throws std::bad_alloc when exceptions are enabled.
  • The optional PMR adapter requires standard-library <memory_resource> support and exceptions to preserve std::pmr::memory_resource failure semantics.
  • External RAM is not automatically safe for DMA, ISR use, or cache-disabled flash windows.
  • FreeRTOS task, queue, and mutex integrations are opt-in and require static allocation support. The task wrapper also requires INCLUDE_vTaskDelete == 1 and INCLUDE_uxTaskGetStackHighWaterMark == 1; the mutex wrapper requires mutex and recursive-mutex support.
  • A Strata::FreeRTOS::Task owner must be destroyed/reset from a different task context than the task it owns; managed tasks must not self-delete.
  • Tasks that can execute while flash/cache is disabled should keep their stacks in internal memory.
  • ISR-accessible Strata queues require internal item storage; external queue storage is task-only.
  • Strata mutex control blocks are always internal and use FreeRTOS static creation APIs.
  • ArduinoJson integration is opt-in, targets ArduinoJson 7, and requires the Strata allocator object to outlive the JsonDocument using it.
  • Advanced allocation counters are disabled by default; enable them build-wide with STRATA_ENABLE_ADVANCED_DIAGNOSTICS=1.

Examples

ExampleDescription
BasicMinimal allocation, region inspection, and cleanup.
PlacementPlacement and region terminology.
AllocationRaw allocation and explicit requests.
DiagnosticsSupport queries and heap statistics.
TypedOwnershipTyped construction and ownership helpers.
STLPlacement-aware standard-library containers.
BufferMove-only owned byte buffers and resize behavior.
CapabilitiesDMA/executable capability requirements.
FreeRTOSTaskOptional placed FreeRTOS task stacks and diagnostics.
FreeRTOSQueueOptional typed FreeRTOS queues with placed item storage.
FreeRTOSMutexOptional static mutex and recursive-mutex ownership.
ArduinoJsonOptional ArduinoJson 7 document allocation through Strata placement.

Start with:

examples/Basic

Documentation

DocumentDescription
docs/getting-started.mdInstallation, first allocation, and placement choices.
docs/placement.mdStable placement, region, fallback, reallocation, and safety semantics.
docs/memory-policy.mdShared ZekStack library configuration contract for allocations and task stacks.
docs/migration.mdRecipes for migrating raw allocation, library policies, containers, tasks, queues, mutexes, and adapters.
docs/configuration.mdBuild requirements, backend selection, PSRAM, diagnostics, exceptions, and optional integrations.
docs/api.mdPublic API overview and include boundaries.
docs/examples.mdGuide to the included sketches.
docs/troubleshooting.mdCommon allocation, PSRAM, capability, and integration issues.
docs/architecture.mdArchitectural boundaries, stable vocabulary, platform mapping, and failure contracts.
docs/diagnostics.mdRegion/heap introspection plus optional allocation/failure/fallback counters.
docs/typed-ownership.mdTyped raw storage, object lifetime, and unique ownership.
docs/stl.mdStateful allocator semantics and STL helpers.
docs/pmr.mdOptional placement-aware std::pmr::memory_resource integration.
docs/buffer.mdOwned byte buffers and resize semantics.
docs/capabilities.mdRequired DMA/executable constraints and safety boundaries.
docs/freertos-tasks.mdOptional task-stack placement and static task creation.
docs/freertos-queues.mdOptional typed queue storage placement and ISR safety.
docs/freertos-mutexes.mdOptional internal static mutex and recursive-mutex ownership.
docs/arduinojson.mdOptional ArduinoJson 7 custom allocator integration.
docs/roadmap.mdCompleted v0.1.0 roadmap and post-release planning boundary.
docs/ecosystem-adoption.mdPlanned adoption across ZekStack and Core.
docs/releasing.mdVersion/tag requirements and the validated GitHub release flow.

API overview

void *raw = Strata::allocate(4096, Strata::Placement::PreferExternal);
void *dma = Strata::allocate(Strata::AllocationRequest{
.sizeBytes = 1024,
.placement = Strata::Placement::Internal,
.alignment = 32,
.capabilities = Strata::Capability::Dma,
});
Strata::MemoryPolicy policy{
.allocation = Strata::Placement::PreferExternal,
.taskStack = Strata::Placement::Internal,
};
Strata::Buffer buffer(4096, Strata::Placement::PreferExternal);
auto object = Strata::makeUnique<MyType>(Strata::Placement::PreferExternal, constructorArg);
auto values = Strata::makeVector<int>(Strata::Placement::PreferExternal);
auto stats = Strata::memoryStats(Strata::Region::Internal);
Strata::free(raw);
Strata::free(dma);

With advanced diagnostics enabled at build time:

auto total = Strata::allocationDiagnostics();
auto preferred = Strata::allocationDiagnostics(Strata::Placement::PreferExternal);
Serial.printf("failures=%u fallbacks=%u\n",
static_cast<unsigned>(total.failures),
static_cast<unsigned>(preferred.preferredExternalFallbacks));

Optional PMR integration:

#include<strata/pmr/MemoryResource.h>
Strata::MemoryResource resource{Strata::Placement::PreferExternal};
std::pmr::vector<std::pmr::string> values{&resource};
values.emplace_back("Strata");

Optional ArduinoJson integration:

#include<ArduinoJson.h>
#include<strata/arduinojson/Allocator.h>
Strata::ArduinoJson::Allocator allocator{Strata::Placement::PreferExternal};
ArduinoJson::JsonDocument document{&allocator};
document["library"] = "Strata";

Optional FreeRTOS integrations:

#include<strata/freertos/Task.h>
#include<strata/freertos/Queue.h>
#include<strata/freertos/Mutex.h>
Strata::FreeRTOS::Task task = Strata::FreeRTOS::Task::create(worker, nullptr, {
.name = "worker",
.stackBytes = 4096,
.stackPlacement = Strata::Placement::PreferExternal,
.priority = 1,
.affinity = Strata::FreeRTOS::NoAffinity,
});
auto queue = Strata::FreeRTOS::Queue<Event>::create({
.length = 16,
.storagePlacement = Strata::Placement::PreferExternal,
.usage = Strata::FreeRTOS::QueueUsage::TaskOnly,
});
auto mutex = Strata::FreeRTOS::Mutex::create();
auto recursiveMutex = Strata::FreeRTOS::RecursiveMutex::create();

Compatibility

ItemSupport
LanguageC++20
Core APIStandard C++
ESP32 backendArduino ESP32 / ESP-IDF-compatible build environment
Generic backendGCC/Clang-compatible C++20 process heap; native MSVC is not supported
External memoryESP32 PSRAM through ESP-IDF heap capabilities
Core dependenciesnone
Optional PMR integrationStandard-library <memory_resource> with exceptions enabled
Optional FreeRTOS integrationFreeRTOS with static allocation; task deletion/high-water-mark APIs for tasks; mutex and recursive-mutex support for mutex wrappers
Optional ArduinoJson integrationArduinoJson 7; CI compatibility target 7.4.3
Advanced diagnosticsOptional compile-time counters; disabled by default
ExceptionsNot required by core APIs; STL/PMR standard allocator surfaces follow standard semantics
Statusv0.1.1 compatibility release for ZekStack memory-policy adoption

License

MIT — see LICENSE.md.

ZekStack

Part of the ZekStack library stack. v0.1.1 adds the common consuming-library memory-policy contract and static FreeRTOS mutex ownership so Worker and subsequent libraries can migrate without inventing library-specific placement vocabulary.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Repository files navigation

Strata

Strata is a portable C++20 memory placement and allocation library with first-class ESP32 internal-RAM and PSRAM support.

It gives applications and libraries one vocabulary for allocation intent while platform-specific backends own the underlying memory mechanics. Core allocation APIs remain standard-C++ compatible, while optional PMR, FreeRTOS, and ArduinoJson integrations add specialized capabilities without leaking them into the core contract.

CIReleaseLicense: MIT

Why use Strata?

  • Explicit placement — request default, internal, preferred-external, or required-external memory.
  • Shared memory policy — embed Strata::MemoryPolicy in ZekStack library configs for consistent allocation and task-stack defaults.
  • Portable vocabulary — application code describes memory intent instead of ESP-IDF heap flags.
  • Strict capability requirements — DMA and executable requirements never silently degrade.
  • Typed ownership — raw allocation, typed construction, unique ownership, shared ownership, and move-only buffers use the same placement model.
  • STL integration — placement-aware allocators and container helpers preserve allocation intent.
  • PMR integration — use the same placement policies through standard polymorphic allocators and nested PMR containers.
  • Runtime diagnostics — inspect actual memory regions, heap statistics, and current/peak region usage.
  • Optional advanced diagnostics — opt into allocation/failure/fallback counters without a global allocation registry.
  • Optional FreeRTOS memory primitives — explicitly place task stacks and queue item storage, and own static mutex control blocks, while keeping FreeRTOS out of the core headers.
  • Optional ArduinoJson allocation — route ArduinoJson 7 document memory through the same Strata placement policies.
  • Standalone core — Strata does not depend on other ZekStack libraries.

Install

PlatformIO

[env:esp32dev]platform = espressif32
board = esp32dev
framework = arduino
lib_deps =
https://github.com/ZekStack/strata.git
build_flags =
-std=gnu++20
build_unflags =
-std=gnu++11

ArduinoJson users should add ArduinoJson separately because it remains an optional integration:

lib_deps =
https://github.com/ZekStack/strata.git
bblanchon/ArduinoJson@^7.4.3

Arduino IDE

Strata is not published to Arduino Library Manager yet.

Install it by downloading the repository ZIP or cloning it into the Arduino libraries directory:

Arduino/libraries/Strata

Quick start

#include<Arduino.h>
#include<Strata.h>voidsetup() {
Serial.begin(115200);
void *bulk = Strata::allocate(4096, Strata::Placement::PreferExternal);
if (bulk == nullptr) {
Serial.println("allocation failed");
return;
}
Serial.printf("region=%u\n", static_cast<unsigned>(Strata::regionOf(bulk)));
Strata::free(bulk);
}
voidloop() {
delay(1000);
}

Owned buffers and STL helpers use the same placement policy:

Strata::Buffer buffer(4096, Strata::Placement::PreferExternal);
auto values = Strata::makeVector<int>(Strata::Placement::PreferExternal);
values.push_back(42);

Reusable library configs can expose the shared policy type directly:

structSomeLibConfig {
Strata::MemoryPolicy memory{};
};
SomeLibConfig config;
config.memory.allocation = Strata::Placement::PreferExternal;
config.memory.taskStack = Strata::Placement::Internal;

Important notes

Important

PreferExternal may fall back to internal memory. RequireExternal never does. Capability requirements such as DMA or executable memory remain mandatory during fallback.

  • Placement describes requested policy; Region describes where memory actually resides.
  • MemoryPolicy is local configuration vocabulary, not a global Strata setting. Hard safety requirements may tighten its defaults.
  • Placement::Default means backend-default allocation and must not be used as an inheritance sentinel.
  • Invalid or corrupted Placement enum values are rejected by allocation/support APIs instead of being interpreted as another policy.
  • Generic builds support normal process-heap allocation but deliberately report external-memory and embedded hardware capabilities as unsupported. The generic backend is validated with GCC/Clang-compatible C++20 toolchains; native MSVC is not supported.
  • Raw allocation, typed ownership, and Buffer report allocation failure without requiring exceptions.
  • Strata::Allocator<T> follows standard allocator expectations and throws std::bad_alloc when exceptions are enabled.
  • The optional PMR adapter requires standard-library <memory_resource> support and exceptions to preserve std::pmr::memory_resource failure semantics.
  • External RAM is not automatically safe for DMA, ISR use, or cache-disabled flash windows.
  • FreeRTOS task, queue, and mutex integrations are opt-in and require static allocation support. The task wrapper also requires INCLUDE_vTaskDelete == 1 and INCLUDE_uxTaskGetStackHighWaterMark == 1; the mutex wrapper requires mutex and recursive-mutex support.
  • A Strata::FreeRTOS::Task owner must be destroyed/reset from a different task context than the task it owns; managed tasks must not self-delete.
  • Tasks that can execute while flash/cache is disabled should keep their stacks in internal memory.
  • ISR-accessible Strata queues require internal item storage; external queue storage is task-only.
  • Strata mutex control blocks are always internal and use FreeRTOS static creation APIs.
  • ArduinoJson integration is opt-in, targets ArduinoJson 7, and requires the Strata allocator object to outlive the JsonDocument using it.
  • Advanced allocation counters are disabled by default; enable them build-wide with STRATA_ENABLE_ADVANCED_DIAGNOSTICS=1.

Examples

ExampleDescription
BasicMinimal allocation, region inspection, and cleanup.
PlacementPlacement and region terminology.
AllocationRaw allocation and explicit requests.
DiagnosticsSupport queries and heap statistics.
TypedOwnershipTyped construction and ownership helpers.
STLPlacement-aware standard-library containers.
BufferMove-only owned byte buffers and resize behavior.
CapabilitiesDMA/executable capability requirements.
FreeRTOSTaskOptional placed FreeRTOS task stacks and diagnostics.
FreeRTOSQueueOptional typed FreeRTOS queues with placed item storage.
FreeRTOSMutexOptional static mutex and recursive-mutex ownership.
ArduinoJsonOptional ArduinoJson 7 document allocation through Strata placement.

Start with:

examples/Basic

Documentation

DocumentDescription
docs/getting-started.mdInstallation, first allocation, and placement choices.
docs/placement.mdStable placement, region, fallback, reallocation, and safety semantics.
docs/memory-policy.mdShared ZekStack library configuration contract for allocations and task stacks.
docs/migration.mdRecipes for migrating raw allocation, library policies, containers, tasks, queues, mutexes, and adapters.
docs/configuration.mdBuild requirements, backend selection, PSRAM, diagnostics, exceptions, and optional integrations.
docs/api.mdPublic API overview and include boundaries.
docs/examples.mdGuide to the included sketches.
docs/troubleshooting.mdCommon allocation, PSRAM, capability, and integration issues.
docs/architecture.mdArchitectural boundaries, stable vocabulary, platform mapping, and failure contracts.
docs/diagnostics.mdRegion/heap introspection plus optional allocation/failure/fallback counters.
docs/typed-ownership.mdTyped raw storage, object lifetime, and unique ownership.
docs/stl.mdStateful allocator semantics and STL helpers.
docs/pmr.mdOptional placement-aware std::pmr::memory_resource integration.
docs/buffer.mdOwned byte buffers and resize semantics.
docs/capabilities.mdRequired DMA/executable constraints and safety boundaries.
docs/freertos-tasks.mdOptional task-stack placement and static task creation.
docs/freertos-queues.mdOptional typed queue storage placement and ISR safety.
docs/freertos-mutexes.mdOptional internal static mutex and recursive-mutex ownership.
docs/arduinojson.mdOptional ArduinoJson 7 custom allocator integration.
docs/roadmap.mdCompleted v0.1.0 roadmap and post-release planning boundary.
docs/ecosystem-adoption.mdPlanned adoption across ZekStack and Core.
docs/releasing.mdVersion/tag requirements and the validated GitHub release flow.

API overview

void *raw = Strata::allocate(4096, Strata::Placement::PreferExternal);
void *dma = Strata::allocate(Strata::AllocationRequest{
.sizeBytes = 1024,
.placement = Strata::Placement::Internal,
.alignment = 32,
.capabilities = Strata::Capability::Dma,
});
Strata::MemoryPolicy policy{
.allocation = Strata::Placement::PreferExternal,
.taskStack = Strata::Placement::Internal,
};
Strata::Buffer buffer(4096, Strata::Placement::PreferExternal);
auto object = Strata::makeUnique<MyType>(Strata::Placement::PreferExternal, constructorArg);
auto values = Strata::makeVector<int>(Strata::Placement::PreferExternal);
auto stats = Strata::memoryStats(Strata::Region::Internal);
Strata::free(raw);
Strata::free(dma);

With advanced diagnostics enabled at build time:

auto total = Strata::allocationDiagnostics();
auto preferred = Strata::allocationDiagnostics(Strata::Placement::PreferExternal);
Serial.printf("failures=%u fallbacks=%u\n",
static_cast<unsigned>(total.failures),
static_cast<unsigned>(preferred.preferredExternalFallbacks));

Optional PMR integration:

#include<strata/pmr/MemoryResource.h>
Strata::MemoryResource resource{Strata::Placement::PreferExternal};
std::pmr::vector<std::pmr::string> values{&resource};
values.emplace_back("Strata");

Optional ArduinoJson integration:

#include<ArduinoJson.h>
#include<strata/arduinojson/Allocator.h>
Strata::ArduinoJson::Allocator allocator{Strata::Placement::PreferExternal};
ArduinoJson::JsonDocument document{&allocator};
document["library"] = "Strata";

Optional FreeRTOS integrations:

#include<strata/freertos/Task.h>
#include<strata/freertos/Queue.h>
#include<strata/freertos/Mutex.h>
Strata::FreeRTOS::Task task = Strata::FreeRTOS::Task::create(worker, nullptr, {
.name = "worker",
.stackBytes = 4096,
.stackPlacement = Strata::Placement::PreferExternal,
.priority = 1,
.affinity = Strata::FreeRTOS::NoAffinity,
});
auto queue = Strata::FreeRTOS::Queue<Event>::create({
.length = 16,
.storagePlacement = Strata::Placement::PreferExternal,
.usage = Strata::FreeRTOS::QueueUsage::TaskOnly,
});
auto mutex = Strata::FreeRTOS::Mutex::create();
auto recursiveMutex = Strata::FreeRTOS::RecursiveMutex::create();

Compatibility

ItemSupport
LanguageC++20
Core APIStandard C++
ESP32 backendArduino ESP32 / ESP-IDF-compatible build environment
Generic backendGCC/Clang-compatible C++20 process heap; native MSVC is not supported
External memoryESP32 PSRAM through ESP-IDF heap capabilities
Core dependenciesnone
Optional PMR integrationStandard-library <memory_resource> with exceptions enabled
Optional FreeRTOS integrationFreeRTOS with static allocation; task deletion/high-water-mark APIs for tasks; mutex and recursive-mutex support for mutex wrappers
Optional ArduinoJson integrationArduinoJson 7; CI compatibility target 7.4.3
Advanced diagnosticsOptional compile-time counters; disabled by default
ExceptionsNot required by core APIs; STL/PMR standard allocator surfaces follow standard semantics
Statusv0.1.1 compatibility release for ZekStack memory-policy adoption

License

MIT — see LICENSE.md.

ZekStack

Part of the ZekStack library stack. v0.1.1 adds the common consuming-library memory-policy contract and static FreeRTOS mutex ownership so Worker and subsequent libraries can migrate without inventing library-specific placement vocabulary.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

Strata

Strata is a portable C++20 memory placement and allocation library with first-class ESP32 internal-RAM and PSRAM support.

It gives applications and libraries one vocabulary for allocation intent while platform-specific backends own the underlying memory mechanics. Core allocation APIs remain standard-C++ compatible, while optional PMR, FreeRTOS, and ArduinoJson integrations add specialized capabilities without leaking them into the core contract.

CIReleaseLicense: MIT

Why use Strata?

  • Explicit placement — request default, internal, preferred-external, or required-external memory.
  • Shared memory policy — embed Strata::MemoryPolicy in ZekStack library configs for consistent allocation and task-stack defaults.
  • Portable vocabulary — application code describes memory intent instead of ESP-IDF heap flags.
  • Strict capability requirements — DMA and executable requirements never silently degrade.
  • Typed ownership — raw allocation, typed construction, unique ownership, shared ownership, and move-only buffers use the same placement model.
  • STL integration — placement-aware allocators and container helpers preserve allocation intent.
  • PMR integration — use the same placement policies through standard polymorphic allocators and nested PMR containers.
  • Runtime diagnostics — inspect actual memory regions, heap statistics, and current/peak region usage.
  • Optional advanced diagnostics — opt into allocation/failure/fallback counters without a global allocation registry.
  • Optional FreeRTOS memory primitives — explicitly place task stacks and queue item storage, and own static mutex control blocks, while keeping FreeRTOS out of the core headers.
  • Optional ArduinoJson allocation — route ArduinoJson 7 document memory through the same Strata placement policies.
  • Standalone core — Strata does not depend on other ZekStack libraries.

Install

PlatformIO

[env:esp32dev]platform = espressif32
board = esp32dev
framework = arduino
lib_deps =
https://github.com/ZekStack/strata.git
build_flags =
-std=gnu++20
build_unflags =
-std=gnu++11

ArduinoJson users should add ArduinoJson separately because it remains an optional integration:

lib_deps =
https://github.com/ZekStack/strata.git
bblanchon/ArduinoJson@^7.4.3

Arduino IDE

Strata is not published to Arduino Library Manager yet.

Install it by downloading the repository ZIP or cloning it into the Arduino libraries directory:

Arduino/libraries/Strata

Quick start

#include<Arduino.h>
#include<Strata.h>voidsetup() {
Serial.begin(115200);
void *bulk = Strata::allocate(4096, Strata::Placement::PreferExternal);
if (bulk == nullptr) {
Serial.println("allocation failed");
return;
}
Serial.printf("region=%u\n", static_cast<unsigned>(Strata::regionOf(bulk)));
Strata::free(bulk);
}
voidloop() {
delay(1000);
}

Owned buffers and STL helpers use the same placement policy:

Strata::Buffer buffer(4096, Strata::Placement::PreferExternal);
auto values = Strata::makeVector<int>(Strata::Placement::PreferExternal);
values.push_back(42);

Reusable library configs can expose the shared policy type directly:

structSomeLibConfig {
Strata::MemoryPolicy memory{};
};
SomeLibConfig config;
config.memory.allocation = Strata::Placement::PreferExternal;
config.memory.taskStack = Strata::Placement::Internal;

Important notes

Important

PreferExternal may fall back to internal memory. RequireExternal never does. Capability requirements such as DMA or executable memory remain mandatory during fallback.

  • Placement describes requested policy; Region describes where memory actually resides.
  • MemoryPolicy is local configuration vocabulary, not a global Strata setting. Hard safety requirements may tighten its defaults.
  • Placement::Default means backend-default allocation and must not be used as an inheritance sentinel.
  • Invalid or corrupted Placement enum values are rejected by allocation/support APIs instead of being interpreted as another policy.
  • Generic builds support normal process-heap allocation but deliberately report external-memory and embedded hardware capabilities as unsupported. The generic backend is validated with GCC/Clang-compatible C++20 toolchains; native MSVC is not supported.
  • Raw allocation, typed ownership, and Buffer report allocation failure without requiring exceptions.
  • Strata::Allocator<T> follows standard allocator expectations and throws std::bad_alloc when exceptions are enabled.
  • The optional PMR adapter requires standard-library <memory_resource> support and exceptions to preserve std::pmr::memory_resource failure semantics.
  • External RAM is not automatically safe for DMA, ISR use, or cache-disabled flash windows.
  • FreeRTOS task, queue, and mutex integrations are opt-in and require static allocation support. The task wrapper also requires INCLUDE_vTaskDelete == 1 and INCLUDE_uxTaskGetStackHighWaterMark == 1; the mutex wrapper requires mutex and recursive-mutex support.
  • A Strata::FreeRTOS::Task owner must be destroyed/reset from a different task context than the task it owns; managed tasks must not self-delete.
  • Tasks that can execute while flash/cache is disabled should keep their stacks in internal memory.
  • ISR-accessible Strata queues require internal item storage; external queue storage is task-only.
  • Strata mutex control blocks are always internal and use FreeRTOS static creation APIs.
  • ArduinoJson integration is opt-in, targets ArduinoJson 7, and requires the Strata allocator object to outlive the JsonDocument using it.
  • Advanced allocation counters are disabled by default; enable them build-wide with STRATA_ENABLE_ADVANCED_DIAGNOSTICS=1.

Examples

ExampleDescription
BasicMinimal allocation, region inspection, and cleanup.
PlacementPlacement and region terminology.
AllocationRaw allocation and explicit requests.
DiagnosticsSupport queries and heap statistics.
TypedOwnershipTyped construction and ownership helpers.
STLPlacement-aware standard-library containers.
BufferMove-only owned byte buffers and resize behavior.
CapabilitiesDMA/executable capability requirements.
FreeRTOSTaskOptional placed FreeRTOS task stacks and diagnostics.
FreeRTOSQueueOptional typed FreeRTOS queues with placed item storage.
FreeRTOSMutexOptional static mutex and recursive-mutex ownership.
ArduinoJsonOptional ArduinoJson 7 document allocation through Strata placement.

Start with:

examples/Basic

Documentation

DocumentDescription
docs/getting-started.mdInstallation, first allocation, and placement choices.
docs/placement.mdStable placement, region, fallback, reallocation, and safety semantics.
docs/memory-policy.mdShared ZekStack library configuration contract for allocations and task stacks.
docs/migration.mdRecipes for migrating raw allocation, library policies, containers, tasks, queues, mutexes, and adapters.
docs/configuration.mdBuild requirements, backend selection, PSRAM, diagnostics, exceptions, and optional integrations.
docs/api.mdPublic API overview and include boundaries.
docs/examples.mdGuide to the included sketches.
docs/troubleshooting.mdCommon allocation, PSRAM, capability, and integration issues.
docs/architecture.mdArchitectural boundaries, stable vocabulary, platform mapping, and failure contracts.
docs/diagnostics.mdRegion/heap introspection plus optional allocation/failure/fallback counters.
docs/typed-ownership.mdTyped raw storage, object lifetime, and unique ownership.
docs/stl.mdStateful allocator semantics and STL helpers.
docs/pmr.mdOptional placement-aware std::pmr::memory_resource integration.
docs/buffer.mdOwned byte buffers and resize semantics.
docs/capabilities.mdRequired DMA/executable constraints and safety boundaries.
docs/freertos-tasks.mdOptional task-stack placement and static task creation.
docs/freertos-queues.mdOptional typed queue storage placement and ISR safety.
docs/freertos-mutexes.mdOptional internal static mutex and recursive-mutex ownership.
docs/arduinojson.mdOptional ArduinoJson 7 custom allocator integration.
docs/roadmap.mdCompleted v0.1.0 roadmap and post-release planning boundary.
docs/ecosystem-adoption.mdPlanned adoption across ZekStack and Core.
docs/releasing.mdVersion/tag requirements and the validated GitHub release flow.

API overview

void *raw = Strata::allocate(4096, Strata::Placement::PreferExternal);
void *dma = Strata::allocate(Strata::AllocationRequest{
.sizeBytes = 1024,
.placement = Strata::Placement::Internal,
.alignment = 32,
.capabilities = Strata::Capability::Dma,
});
Strata::MemoryPolicy policy{
.allocation = Strata::Placement::PreferExternal,
.taskStack = Strata::Placement::Internal,
};
Strata::Buffer buffer(4096, Strata::Placement::PreferExternal);
auto object = Strata::makeUnique<MyType>(Strata::Placement::PreferExternal, constructorArg);
auto values = Strata::makeVector<int>(Strata::Placement::PreferExternal);
auto stats = Strata::memoryStats(Strata::Region::Internal);
Strata::free(raw);
Strata::free(dma);

With advanced diagnostics enabled at build time:

auto total = Strata::allocationDiagnostics();
auto preferred = Strata::allocationDiagnostics(Strata::Placement::PreferExternal);
Serial.printf("failures=%u fallbacks=%u\n",
static_cast<unsigned>(total.failures),
static_cast<unsigned>(preferred.preferredExternalFallbacks));

Optional PMR integration:

#include<strata/pmr/MemoryResource.h>
Strata::MemoryResource resource{Strata::Placement::PreferExternal};
std::pmr::vector<std::pmr::string> values{&resource};
values.emplace_back("Strata");

Optional ArduinoJson integration:

#include<ArduinoJson.h>
#include<strata/arduinojson/Allocator.h>
Strata::ArduinoJson::Allocator allocator{Strata::Placement::PreferExternal};
ArduinoJson::JsonDocument document{&allocator};
document["library"] = "Strata";

Optional FreeRTOS integrations:

#include<strata/freertos/Task.h>
#include<strata/freertos/Queue.h>
#include<strata/freertos/Mutex.h>
Strata::FreeRTOS::Task task = Strata::FreeRTOS::Task::create(worker, nullptr, {
.name = "worker",
.stackBytes = 4096,
.stackPlacement = Strata::Placement::PreferExternal,
.priority = 1,
.affinity = Strata::FreeRTOS::NoAffinity,
});
auto queue = Strata::FreeRTOS::Queue<Event>::create({
.length = 16,
.storagePlacement = Strata::Placement::PreferExternal,
.usage = Strata::FreeRTOS::QueueUsage::TaskOnly,
});
auto mutex = Strata::FreeRTOS::Mutex::create();
auto recursiveMutex = Strata::FreeRTOS::RecursiveMutex::create();

Compatibility

ItemSupport
LanguageC++20
Core APIStandard C++
ESP32 backendArduino ESP32 / ESP-IDF-compatible build environment
Generic backendGCC/Clang-compatible C++20 process heap; native MSVC is not supported
External memoryESP32 PSRAM through ESP-IDF heap capabilities
Core dependenciesnone
Optional PMR integrationStandard-library <memory_resource> with exceptions enabled
Optional FreeRTOS integrationFreeRTOS with static allocation; task deletion/high-water-mark APIs for tasks; mutex and recursive-mutex support for mutex wrappers
Optional ArduinoJson integrationArduinoJson 7; CI compatibility target 7.4.3
Advanced diagnosticsOptional compile-time counters; disabled by default
ExceptionsNot required by core APIs; STL/PMR standard allocator surfaces follow standard semantics
Statusv0.1.1 compatibility release for ZekStack memory-policy adoption

License

MIT — see LICENSE.md.

ZekStack

Part of the ZekStack library stack. v0.1.1 adds the common consuming-library memory-policy contract and static FreeRTOS mutex ownership so Worker and subsequent libraries can migrate without inventing library-specific placement vocabulary.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

Strata

Strata is a portable C++20 memory placement and allocation library with first-class ESP32 internal-RAM and PSRAM support.

It gives applications and libraries one vocabulary for allocation intent while platform-specific backends own the underlying memory mechanics. Core allocation APIs remain standard-C++ compatible, while optional PMR, FreeRTOS, and ArduinoJson integrations add specialized capabilities without leaking them into the core contract.

CIReleaseLicense: MIT

Why use Strata?

  • Explicit placement — request default, internal, preferred-external, or required-external memory.
  • Shared memory policy — embed Strata::MemoryPolicy in ZekStack library configs for consistent allocation and task-stack defaults.
  • Portable vocabulary — application code describes memory intent instead of ESP-IDF heap flags.
  • Strict capability requirements — DMA and executable requirements never silently degrade.
  • Typed ownership — raw allocation, typed construction, unique ownership, shared ownership, and move-only buffers use the same placement model.
  • STL integration — placement-aware allocators and container helpers preserve allocation intent.
  • PMR integration — use the same placement policies through standard polymorphic allocators and nested PMR containers.
  • Runtime diagnostics — inspect actual memory regions, heap statistics, and current/peak region usage.
  • Optional advanced diagnostics — opt into allocation/failure/fallback counters without a global allocation registry.
  • Optional FreeRTOS memory primitives — explicitly place task stacks and queue item storage, and own static mutex control blocks, while keeping FreeRTOS out of the core headers.
  • Optional ArduinoJson allocation — route ArduinoJson 7 document memory through the same Strata placement policies.
  • Standalone core — Strata does not depend on other ZekStack libraries.

Install

PlatformIO

[env:esp32dev]platform = espressif32
board = esp32dev
framework = arduino
lib_deps =
https://github.com/ZekStack/strata.git
build_flags =
-std=gnu++20
build_unflags =
-std=gnu++11

ArduinoJson users should add ArduinoJson separately because it remains an optional integration:

lib_deps =
https://github.com/ZekStack/strata.git
bblanchon/ArduinoJson@^7.4.3

Arduino IDE

Strata is not published to Arduino Library Manager yet.

Install it by downloading the repository ZIP or cloning it into the Arduino libraries directory:

Arduino/libraries/Strata

Quick start

#include<Arduino.h>
#include<Strata.h>voidsetup() {
Serial.begin(115200);
void *bulk = Strata::allocate(4096, Strata::Placement::PreferExternal);
if (bulk == nullptr) {
Serial.println("allocation failed");
return;
}
Serial.printf("region=%u\n", static_cast<unsigned>(Strata::regionOf(bulk)));
Strata::free(bulk);
}
voidloop() {
delay(1000);
}

Owned buffers and STL helpers use the same placement policy:

Strata::Buffer buffer(4096, Strata::Placement::PreferExternal);
auto values = Strata::makeVector<int>(Strata::Placement::PreferExternal);
values.push_back(42);

Reusable library configs can expose the shared policy type directly:

structSomeLibConfig {
Strata::MemoryPolicy memory{};
};
SomeLibConfig config;
config.memory.allocation = Strata::Placement::PreferExternal;
config.memory.taskStack = Strata::Placement::Internal;

Important notes

Important

PreferExternal may fall back to internal memory. RequireExternal never does. Capability requirements such as DMA or executable memory remain mandatory during fallback.

  • Placement describes requested policy; Region describes where memory actually resides.
  • MemoryPolicy is local configuration vocabulary, not a global Strata setting. Hard safety requirements may tighten its defaults.
  • Placement::Default means backend-default allocation and must not be used as an inheritance sentinel.
  • Invalid or corrupted Placement enum values are rejected by allocation/support APIs instead of being interpreted as another policy.
  • Generic builds support normal process-heap allocation but deliberately report external-memory and embedded hardware capabilities as unsupported. The generic backend is validated with GCC/Clang-compatible C++20 toolchains; native MSVC is not supported.
  • Raw allocation, typed ownership, and Buffer report allocation failure without requiring exceptions.
  • Strata::Allocator<T> follows standard allocator expectations and throws std::bad_alloc when exceptions are enabled.
  • The optional PMR adapter requires standard-library <memory_resource> support and exceptions to preserve std::pmr::memory_resource failure semantics.
  • External RAM is not automatically safe for DMA, ISR use, or cache-disabled flash windows.
  • FreeRTOS task, queue, and mutex integrations are opt-in and require static allocation support. The task wrapper also requires INCLUDE_vTaskDelete == 1 and INCLUDE_uxTaskGetStackHighWaterMark == 1; the mutex wrapper requires mutex and recursive-mutex support.
  • A Strata::FreeRTOS::Task owner must be destroyed/reset from a different task context than the task it owns; managed tasks must not self-delete.
  • Tasks that can execute while flash/cache is disabled should keep their stacks in internal memory.
  • ISR-accessible Strata queues require internal item storage; external queue storage is task-only.
  • Strata mutex control blocks are always internal and use FreeRTOS static creation APIs.
  • ArduinoJson integration is opt-in, targets ArduinoJson 7, and requires the Strata allocator object to outlive the JsonDocument using it.
  • Advanced allocation counters are disabled by default; enable them build-wide with STRATA_ENABLE_ADVANCED_DIAGNOSTICS=1.

Examples

ExampleDescription
BasicMinimal allocation, region inspection, and cleanup.
PlacementPlacement and region terminology.
AllocationRaw allocation and explicit requests.
DiagnosticsSupport queries and heap statistics.
TypedOwnershipTyped construction and ownership helpers.
STLPlacement-aware standard-library containers.
BufferMove-only owned byte buffers and resize behavior.
CapabilitiesDMA/executable capability requirements.
FreeRTOSTaskOptional placed FreeRTOS task stacks and diagnostics.
FreeRTOSQueueOptional typed FreeRTOS queues with placed item storage.
FreeRTOSMutexOptional static mutex and recursive-mutex ownership.
ArduinoJsonOptional ArduinoJson 7 document allocation through Strata placement.

Start with:

examples/Basic

Documentation

DocumentDescription
docs/getting-started.mdInstallation, first allocation, and placement choices.
docs/placement.mdStable placement, region, fallback, reallocation, and safety semantics.
docs/memory-policy.mdShared ZekStack library configuration contract for allocations and task stacks.
docs/migration.mdRecipes for migrating raw allocation, library policies, containers, tasks, queues, mutexes, and adapters.
docs/configuration.mdBuild requirements, backend selection, PSRAM, diagnostics, exceptions, and optional integrations.
docs/api.mdPublic API overview and include boundaries.
docs/examples.mdGuide to the included sketches.
docs/troubleshooting.mdCommon allocation, PSRAM, capability, and integration issues.
docs/architecture.mdArchitectural boundaries, stable vocabulary, platform mapping, and failure contracts.
docs/diagnostics.mdRegion/heap introspection plus optional allocation/failure/fallback counters.
docs/typed-ownership.mdTyped raw storage, object lifetime, and unique ownership.
docs/stl.mdStateful allocator semantics and STL helpers.
docs/pmr.mdOptional placement-aware std::pmr::memory_resource integration.
docs/buffer.mdOwned byte buffers and resize semantics.
docs/capabilities.mdRequired DMA/executable constraints and safety boundaries.
docs/freertos-tasks.mdOptional task-stack placement and static task creation.
docs/freertos-queues.mdOptional typed queue storage placement and ISR safety.
docs/freertos-mutexes.mdOptional internal static mutex and recursive-mutex ownership.
docs/arduinojson.mdOptional ArduinoJson 7 custom allocator integration.
docs/roadmap.mdCompleted v0.1.0 roadmap and post-release planning boundary.
docs/ecosystem-adoption.mdPlanned adoption across ZekStack and Core.
docs/releasing.mdVersion/tag requirements and the validated GitHub release flow.

API overview

void *raw = Strata::allocate(4096, Strata::Placement::PreferExternal);
void *dma = Strata::allocate(Strata::AllocationRequest{
.sizeBytes = 1024,
.placement = Strata::Placement::Internal,
.alignment = 32,
.capabilities = Strata::Capability::Dma,
});
Strata::MemoryPolicy policy{
.allocation = Strata::Placement::PreferExternal,
.taskStack = Strata::Placement::Internal,
};
Strata::Buffer buffer(4096, Strata::Placement::PreferExternal);
auto object = Strata::makeUnique<MyType>(Strata::Placement::PreferExternal, constructorArg);
auto values = Strata::makeVector<int>(Strata::Placement::PreferExternal);
auto stats = Strata::memoryStats(Strata::Region::Internal);
Strata::free(raw);
Strata::free(dma);

With advanced diagnostics enabled at build time:

auto total = Strata::allocationDiagnostics();
auto preferred = Strata::allocationDiagnostics(Strata::Placement::PreferExternal);
Serial.printf("failures=%u fallbacks=%u\n",
static_cast<unsigned>(total.failures),
static_cast<unsigned>(preferred.preferredExternalFallbacks));

Optional PMR integration:

#include<strata/pmr/MemoryResource.h>
Strata::MemoryResource resource{Strata::Placement::PreferExternal};
std::pmr::vector<std::pmr::string> values{&resource};
values.emplace_back("Strata");

Optional ArduinoJson integration:

#include<ArduinoJson.h>
#include<strata/arduinojson/Allocator.h>
Strata::ArduinoJson::Allocator allocator{Strata::Placement::PreferExternal};
ArduinoJson::JsonDocument document{&allocator};
document["library"] = "Strata";

Optional FreeRTOS integrations:

#include<strata/freertos/Task.h>
#include<strata/freertos/Queue.h>
#include<strata/freertos/Mutex.h>
Strata::FreeRTOS::Task task = Strata::FreeRTOS::Task::create(worker, nullptr, {
.name = "worker",
.stackBytes = 4096,
.stackPlacement = Strata::Placement::PreferExternal,
.priority = 1,
.affinity = Strata::FreeRTOS::NoAffinity,
});
auto queue = Strata::FreeRTOS::Queue<Event>::create({
.length = 16,
.storagePlacement = Strata::Placement::PreferExternal,
.usage = Strata::FreeRTOS::QueueUsage::TaskOnly,
});
auto mutex = Strata::FreeRTOS::Mutex::create();
auto recursiveMutex = Strata::FreeRTOS::RecursiveMutex::create();

Compatibility

ItemSupport
LanguageC++20
Core APIStandard C++
ESP32 backendArduino ESP32 / ESP-IDF-compatible build environment
Generic backendGCC/Clang-compatible C++20 process heap; native MSVC is not supported
External memoryESP32 PSRAM through ESP-IDF heap capabilities
Core dependenciesnone
Optional PMR integrationStandard-library <memory_resource> with exceptions enabled
Optional FreeRTOS integrationFreeRTOS with static allocation; task deletion/high-water-mark APIs for tasks; mutex and recursive-mutex support for mutex wrappers
Optional ArduinoJson integrationArduinoJson 7; CI compatibility target 7.4.3
Advanced diagnosticsOptional compile-time counters; disabled by default
ExceptionsNot required by core APIs; STL/PMR standard allocator surfaces follow standard semantics
Statusv0.1.1 compatibility release for ZekStack memory-policy adoption

License

MIT — see LICENSE.md.

ZekStack

Part of the ZekStack library stack. v0.1.1 adds the common consuming-library memory-policy contract and static FreeRTOS mutex ownership so Worker and subsequent libraries can migrate without inventing library-specific placement vocabulary.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Repository files navigation

Strata

Strata is a portable C++20 memory placement and allocation library with first-class ESP32 internal-RAM and PSRAM support.

It gives applications and libraries one vocabulary for allocation intent while platform-specific backends own the underlying memory mechanics. Core allocation APIs remain standard-C++ compatible, while optional PMR, FreeRTOS, and ArduinoJson integrations add specialized capabilities without leaking them into the core contract.

CIReleaseLicense: MIT

Why use Strata?

  • Explicit placement — request default, internal, preferred-external, or required-external memory.
  • Shared memory policy — embed Strata::MemoryPolicy in ZekStack library configs for consistent allocation and task-stack defaults.
  • Portable vocabulary — application code describes memory intent instead of ESP-IDF heap flags.
  • Strict capability requirements — DMA and executable requirements never silently degrade.
  • Typed ownership — raw allocation, typed construction, unique ownership, shared ownership, and move-only buffers use the same placement model.
  • STL integration — placement-aware allocators and container helpers preserve allocation intent.
  • PMR integration — use the same placement policies through standard polymorphic allocators and nested PMR containers.
  • Runtime diagnostics — inspect actual memory regions, heap statistics, and current/peak region usage.
  • Optional advanced diagnostics — opt into allocation/failure/fallback counters without a global allocation registry.
  • Optional FreeRTOS memory primitives — explicitly place task stacks and queue item storage, and own static mutex control blocks, while keeping FreeRTOS out of the core headers.
  • Optional ArduinoJson allocation — route ArduinoJson 7 document memory through the same Strata placement policies.
  • Standalone core — Strata does not depend on other ZekStack libraries.

Install

PlatformIO

[env:esp32dev]platform = espressif32
board = esp32dev
framework = arduino
lib_deps =
https://github.com/ZekStack/strata.git
build_flags =
-std=gnu++20
build_unflags =
-std=gnu++11

ArduinoJson users should add ArduinoJson separately because it remains an optional integration:

lib_deps =
https://github.com/ZekStack/strata.git
bblanchon/ArduinoJson@^7.4.3

Arduino IDE

Strata is not published to Arduino Library Manager yet.

Install it by downloading the repository ZIP or cloning it into the Arduino libraries directory:

Arduino/libraries/Strata

Quick start

#include<Arduino.h>
#include<Strata.h>voidsetup() {
Serial.begin(115200);
void *bulk = Strata::allocate(4096, Strata::Placement::PreferExternal);
if (bulk == nullptr) {
Serial.println("allocation failed");
return;
}
Serial.printf("region=%u\n", static_cast<unsigned>(Strata::regionOf(bulk)));
Strata::free(bulk);
}
voidloop() {
delay(1000);
}

Owned buffers and STL helpers use the same placement policy:

Strata::Buffer buffer(4096, Strata::Placement::PreferExternal);
auto values = Strata::makeVector<int>(Strata::Placement::PreferExternal);
values.push_back(42);

Reusable library configs can expose the shared policy type directly:

structSomeLibConfig {
Strata::MemoryPolicy memory{};
};
SomeLibConfig config;
config.memory.allocation = Strata::Placement::PreferExternal;
config.memory.taskStack = Strata::Placement::Internal;

Important notes

Important

PreferExternal may fall back to internal memory. RequireExternal never does. Capability requirements such as DMA or executable memory remain mandatory during fallback.

  • Placement describes requested policy; Region describes where memory actually resides.
  • MemoryPolicy is local configuration vocabulary, not a global Strata setting. Hard safety requirements may tighten its defaults.
  • Placement::Default means backend-default allocation and must not be used as an inheritance sentinel.
  • Invalid or corrupted Placement enum values are rejected by allocation/support APIs instead of being interpreted as another policy.
  • Generic builds support normal process-heap allocation but deliberately report external-memory and embedded hardware capabilities as unsupported. The generic backend is validated with GCC/Clang-compatible C++20 toolchains; native MSVC is not supported.
  • Raw allocation, typed ownership, and Buffer report allocation failure without requiring exceptions.
  • Strata::Allocator<T> follows standard allocator expectations and throws std::bad_alloc when exceptions are enabled.
  • The optional PMR adapter requires standard-library <memory_resource> support and exceptions to preserve std::pmr::memory_resource failure semantics.
  • External RAM is not automatically safe for DMA, ISR use, or cache-disabled flash windows.
  • FreeRTOS task, queue, and mutex integrations are opt-in and require static allocation support. The task wrapper also requires INCLUDE_vTaskDelete == 1 and INCLUDE_uxTaskGetStackHighWaterMark == 1; the mutex wrapper requires mutex and recursive-mutex support.
  • A Strata::FreeRTOS::Task owner must be destroyed/reset from a different task context than the task it owns; managed tasks must not self-delete.
  • Tasks that can execute while flash/cache is disabled should keep their stacks in internal memory.
  • ISR-accessible Strata queues require internal item storage; external queue storage is task-only.
  • Strata mutex control blocks are always internal and use FreeRTOS static creation APIs.
  • ArduinoJson integration is opt-in, targets ArduinoJson 7, and requires the Strata allocator object to outlive the JsonDocument using it.
  • Advanced allocation counters are disabled by default; enable them build-wide with STRATA_ENABLE_ADVANCED_DIAGNOSTICS=1.

Examples

ExampleDescription
BasicMinimal allocation, region inspection, and cleanup.
PlacementPlacement and region terminology.
AllocationRaw allocation and explicit requests.
DiagnosticsSupport queries and heap statistics.
TypedOwnershipTyped construction and ownership helpers.
STLPlacement-aware standard-library containers.
BufferMove-only owned byte buffers and resize behavior.
CapabilitiesDMA/executable capability requirements.
FreeRTOSTaskOptional placed FreeRTOS task stacks and diagnostics.
FreeRTOSQueueOptional typed FreeRTOS queues with placed item storage.
FreeRTOSMutexOptional static mutex and recursive-mutex ownership.
ArduinoJsonOptional ArduinoJson 7 document allocation through Strata placement.

Start with:

examples/Basic

Documentation

DocumentDescription
docs/getting-started.mdInstallation, first allocation, and placement choices.
docs/placement.mdStable placement, region, fallback, reallocation, and safety semantics.
docs/memory-policy.mdShared ZekStack library configuration contract for allocations and task stacks.
docs/migration.mdRecipes for migrating raw allocation, library policies, containers, tasks, queues, mutexes, and adapters.
docs/configuration.mdBuild requirements, backend selection, PSRAM, diagnostics, exceptions, and optional integrations.
docs/api.mdPublic API overview and include boundaries.
docs/examples.mdGuide to the included sketches.
docs/troubleshooting.mdCommon allocation, PSRAM, capability, and integration issues.
docs/architecture.mdArchitectural boundaries, stable vocabulary, platform mapping, and failure contracts.
docs/diagnostics.mdRegion/heap introspection plus optional allocation/failure/fallback counters.
docs/typed-ownership.mdTyped raw storage, object lifetime, and unique ownership.
docs/stl.mdStateful allocator semantics and STL helpers.
docs/pmr.mdOptional placement-aware std::pmr::memory_resource integration.
docs/buffer.mdOwned byte buffers and resize semantics.
docs/capabilities.mdRequired DMA/executable constraints and safety boundaries.
docs/freertos-tasks.mdOptional task-stack placement and static task creation.
docs/freertos-queues.mdOptional typed queue storage placement and ISR safety.
docs/freertos-mutexes.mdOptional internal static mutex and recursive-mutex ownership.
docs/arduinojson.mdOptional ArduinoJson 7 custom allocator integration.
docs/roadmap.mdCompleted v0.1.0 roadmap and post-release planning boundary.
docs/ecosystem-adoption.mdPlanned adoption across ZekStack and Core.
docs/releasing.mdVersion/tag requirements and the validated GitHub release flow.

API overview

void *raw = Strata::allocate(4096, Strata::Placement::PreferExternal);
void *dma = Strata::allocate(Strata::AllocationRequest{
.sizeBytes = 1024,
.placement = Strata::Placement::Internal,
.alignment = 32,
.capabilities = Strata::Capability::Dma,
});
Strata::MemoryPolicy policy{
.allocation = Strata::Placement::PreferExternal,
.taskStack = Strata::Placement::Internal,
};
Strata::Buffer buffer(4096, Strata::Placement::PreferExternal);
auto object = Strata::makeUnique<MyType>(Strata::Placement::PreferExternal, constructorArg);
auto values = Strata::makeVector<int>(Strata::Placement::PreferExternal);
auto stats = Strata::memoryStats(Strata::Region::Internal);
Strata::free(raw);
Strata::free(dma);

With advanced diagnostics enabled at build time:

auto total = Strata::allocationDiagnostics();
auto preferred = Strata::allocationDiagnostics(Strata::Placement::PreferExternal);
Serial.printf("failures=%u fallbacks=%u\n",
static_cast<unsigned>(total.failures),
static_cast<unsigned>(preferred.preferredExternalFallbacks));

Optional PMR integration:

#include<strata/pmr/MemoryResource.h>
Strata::MemoryResource resource{Strata::Placement::PreferExternal};
std::pmr::vector<std::pmr::string> values{&resource};
values.emplace_back("Strata");

Optional ArduinoJson integration:

#include<ArduinoJson.h>
#include<strata/arduinojson/Allocator.h>
Strata::ArduinoJson::Allocator allocator{Strata::Placement::PreferExternal};
ArduinoJson::JsonDocument document{&allocator};
document["library"] = "Strata";

Optional FreeRTOS integrations:

#include<strata/freertos/Task.h>
#include<strata/freertos/Queue.h>
#include<strata/freertos/Mutex.h>
Strata::FreeRTOS::Task task = Strata::FreeRTOS::Task::create(worker, nullptr, {
.name = "worker",
.stackBytes = 4096,
.stackPlacement = Strata::Placement::PreferExternal,
.priority = 1,
.affinity = Strata::FreeRTOS::NoAffinity,
});
auto queue = Strata::FreeRTOS::Queue<Event>::create({
.length = 16,
.storagePlacement = Strata::Placement::PreferExternal,
.usage = Strata::FreeRTOS::QueueUsage::TaskOnly,
});
auto mutex = Strata::FreeRTOS::Mutex::create();
auto recursiveMutex = Strata::FreeRTOS::RecursiveMutex::create();

Compatibility

ItemSupport
LanguageC++20
Core APIStandard C++
ESP32 backendArduino ESP32 / ESP-IDF-compatible build environment
Generic backendGCC/Clang-compatible C++20 process heap; native MSVC is not supported
External memoryESP32 PSRAM through ESP-IDF heap capabilities
Core dependenciesnone
Optional PMR integrationStandard-library <memory_resource> with exceptions enabled
Optional FreeRTOS integrationFreeRTOS with static allocation; task deletion/high-water-mark APIs for tasks; mutex and recursive-mutex support for mutex wrappers
Optional ArduinoJson integrationArduinoJson 7; CI compatibility target 7.4.3
Advanced diagnosticsOptional compile-time counters; disabled by default
ExceptionsNot required by core APIs; STL/PMR standard allocator surfaces follow standard semantics
Statusv0.1.1 compatibility release for ZekStack memory-policy adoption

License

MIT — see LICENSE.md.

ZekStack

Part of the ZekStack library stack. v0.1.1 adds the common consuming-library memory-policy contract and static FreeRTOS mutex ownership so Worker and subsequent libraries can migrate without inventing library-specific placement vocabulary.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages