KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #codex #claude-code #mcp #rust #deepseek-harness #typescript #ai-agent #cli

static_exception

★ 39 Open GitHub ↗

Static exception memory allocation policy.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Introduction

Avoiding dynamic memory allocations is ciritical in safety relevant systems,
but throwing an exception dynamically allocates memory in GCC. This header
only library replaces this allocation scheme with a thread safe memory pool.

# Usage

To use this library you need to include it and then link to it:

```
add_subdirectory(static_exception)
add_executable(my_exe ...)
target_link_libraries(my_exe static_exception ...)
```

# Configuration

The resource limits of memory pool can be configured using compiler
defines:

```
# Set custom memory pool limits:
add_definitions(-EXCEPTION_MEMORY__CXX_MAX_EXCEPTION_SIZE 1024)
add_definitions(-EXCEPTION_MEMORY__CXX_POOL_SIZE 64*128)
add_definitions(-EXCEPTION_MEMORY__CXX_POOL_ALIGNMENT 8)
```

Errors can be handled by overwriting error specific callback functions.
By default these call `std::terminate`:

```cpp
/** Overridable function to specify behaviour if the exception memory pool is exhausted. By default
 *  this function calls std::terminate.
 *  \param thrown_size The requested memory size.
 *  \return A pointer to some additional memory.
 */
extern "C" void* exception_memory_pool_exhausted(const size_t thrown_size) {
  std::terminate();
  return nullptr;
}

/** Overridable function to specify behaviour if the thrown exception is too large for the
 *  exception memory pool. By default this function calls std::terminate.
 *  \param thrown_size The requested memory size.
 *  \return A pointer to some additional memory.
 */
extern "C" void* exception_too_large(const size_t thrown_size) {
  std::terminate();
  return nullptr;
}

/** Overridable function to specify behaviour if the memory pool detects an memory leak. By
 *  default this function calls std::terminate.
 */
extern "C" void exception_memory_pool_leak() {
  std::terminate();
}
```

# Running the Tests

Note that you can omit the `cmake` parameter in the instructions below
on ubuntu as the gtest source dirctory is automatically set.

1. Install gtest: `sudo apt-get install libgtest-dev`.
1. Create and enter build folder: `cd static_exception && mkdir build && cd build`.
1. Build the tests: `cmake ../static_exception -DGTEST_SOURCE_DIR:STRING="pathToGtestInstallation" .. && make`.
1. Run the tests: `test/static_exception_test`.

# Limitations

* Exceptions thrown during library initalization might still be allocated
dynamically. This is usually not a problem as static memory is only required
during steady time.

* Standard exceptions such `std::runtime_error` will still allocate memory
for their internal error string if thrown. This library does not solve
this issue.

static_exception

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README