# scarletshroud/reliability_lib architecture

> Architecture diagram of the GitHub repository scarletshroud/reliability_lib, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/scarletshroud/reliability_lib
- Repository: https://github.com/scarletshroud/reliability_lib

## Overview

##### Project type and purpose
- A portability‐focused, embedded C library (“reliability_lib”) providing error-detection and recovery mechanisms for microcontrollers.
- Supports multiple platforms (bare-metal mk32, FreeRTOS, AUTOSAR, QEMU) via a hardware‐abstraction/adapter layer.
- Includes standalone tools for error monitoring and reliability evaluation.

##### File structure
Top‐level:
- main.c – example or test harness (application).
- CMakeLists.txt, build scripts (.cfg, .ld, .bat).
- platform/ – adapter API + platform‐specific implementations.
- snippets/ & tools/reliability_mechanisms/ – core reliability modules.
- tools/ – CLI utilities (error_monitor, reliability_evaluation_models).
Key patterns:
- Layered architecture: Application → Library API → Adapter → Platform → Hardware.
- Core modules grouped by mechanism type (single_design, design_diversity).
- Tools separated from embedded library, but reuse core modules for model simulation.

##### Extract architecture details from README
- Core features = modular mechanisms (CRC, CFC, N-version, recovery blocks, watchdog, etc.).
- Designed for resource‐constrained MCUs.
- Intended embedding in various RTOS/bare‐metal/AUTOSAR environments.

##### Main components & interactions
a. Application Layer
– main.c invokes reliability APIs (e.g., CFC_CHECK).
b. Reliability Core (Library API)
– Modules under snippets/ & tools/reliability_mechanisms/
– Provides interface headers (e.g., cfc_monitor.h, checksum_snippet.h, n_version_snippet.h).
c. Platform Abstraction Layer
– platform/adapter: defines adapter_target.h and init_platform_adapter.h
– Decouples core from platform details (timers, memory, I/O).
d. Platform Implementations
– mk32_baremetal: HAL drivers (core/peripherals), startup, linker scripts.
– freeRTOS & autosar: stubbed directories for OS integration.
– qemu: simulator glue (qemu_riscv_uart.c), .ld, run scripts.
e. Hardware / Simulator
– Actual MCU registers accessed via HAL.
– QEMU as virtual hardware target.
f. Tools Subsystem (Desktop)
– error_monitor: CLI to track runtime errors.
– reliability_evaluation_models: continuous, discrete, static model code.
– These tools link against core reliability modules to simulate or analyze.

Interactions:
- Application → calls Reliability Core → calls Adapter API → uses Platform Impl → accesses Hardware.
- Tools CLI → links Reliability Core + Models → outputs metrics.

##### Architectural patterns / principles
- Layered, modular design for portability and scalability.
- Hardware‐abstraction via adapter interface.
- Build‐time selection of platform via CMake + scripts.
- Separation of embedded library vs. desktop tools.

## Diagram (Mermaid)

```mermaid
graph TD
    subgraph "Application Layer"
        AppMain["main.c"]:::blue
    end

    subgraph "Reliability Core" 
        subgraph "Single-Design Mechanisms"
            CoreSingle["snippets/single_design"]:::blue
        end
        subgraph "Design-Diversity Mechanisms"
            CoreDesign["snippets/design_diversity"]:::blue
        end
        CoreSuite["snippets_suit.h/.c"]:::blue
    end

    subgraph "Platform Abstraction Layer"
        AdapterAPI["platform_adapter.h/.c"]:::green
        AdapterTarget["adapter_target.h"]:::green
        AdapterInit["init_platform_adapter.h/.c"]:::green
    end

    subgraph "Platform Implementations"
        subgraph "MK32 Bare-Metal"
            MK32HAL["HAL Drivers"]:::green
            MK32Runtime["runtime/crt0.S"]:::green
            MK32Script["scripts"]:::green
            MK32CoreSrc["src/core"]:::green
            MK32PeriSrc["src/periphery"]:::green
        end
        FreeRTOS["FreeRTOS Stubs"]:::green
        AUTOSAR["AUTOSAR Stubs"]:::green
        QEMU["QEMU Simulator"]:::green
    end

    subgraph "Hardware / Simulator"
        HardwareHAL["MCU HAL Interface Headers"]:::orange
    end

    subgraph "Tools Subsystem"
        ErrorMonitor["Error Monitor CLI"]:::purple
        subgraph "Reliability Evaluation Models"
            ModelCont["continuous"]:::purple
            ModelDisc["discrete"]:::purple
            ModelStat["static"]:::purple
        end
        subgraph "Desktop Reliability Mechanisms"
            ToolsSingle["single_design"]:::purple
            ToolsDesign["design_diversity"]:::purple
        end
    end

    subgraph "Build Configuration & Scripts"
        BuildConfig["CMakeLists.txt & scripts"]:::blue
    end

    %% Connections
    AppMain -->|"CFC_CHECK"| CoreSuite
    CoreSuite -->|"uses modules"| CoreSingle
    CoreSuite -->|"uses modules"| CoreDesign
    CoreSuite -->|"adapter_init"| AdapterInit
    AdapterInit -->|"defines targets"| AdapterTarget
    AdapterTarget -->|"API calls"| AdapterAPI
    AdapterAPI -->|"calls HAL"| MK32HAL
    MK32HAL -->|"startup"| MK32Runtime
    MK32Runtime -->|"linker scripts"| MK32Script
    MK32HAL -->|"core routines"| MK32CoreSrc
    MK32HAL -->|"peripherals"| MK32PeriSrc
    MK32HAL -->|"accesses"| HardwareHAL
    AdapterAPI -->|"if FreeRTOS"| FreeRTOS
    AdapterAPI -->|"if AUTOSAR"| AUTOSAR
    AdapterAPI -->|"if QEMU"| QEMU
    QEMU -->|"simulates"| HardwareHAL

    ErrorMonitor -->|"links Core"| CoreSuite
    ModelCont -->|"links Core"| CoreSuite
    ModelDisc -->|"links Core"| CoreSuite
    ModelStat -->|"links Core"| CoreSuite
    ToolsSingle -->|"links Core"| CoreSingle
    ToolsDesign -->|"links Core"| CoreDesign

    BuildConfig -->|"configures build"| AppMain
    BuildConfig -->|"selects platform"| AdapterInit
    BuildConfig -->|"selects platform"| FreeRTOS
    BuildConfig -->|"selects platform"| AUTOSAR
    BuildConfig -->|"selects platform"| QEMU
    BuildConfig -->|"includes scripts"| MK32Script

    %% Click Events
    click AppMain "https://github.com/scarletshroud/reliability_lib/blob/master/main.c"
    click CoreSingle "https://github.com/scarletshroud/reliability_lib/tree/master/snippets/single_design/"
    click CoreDesign "https://github.com/scarletshroud/reliability_lib/tree/master/snippets/design_diversity/"
    click CoreSuite "https://github.com/scarletshroud/reliability_lib/blob/master/snippets/snippets_suit.h"
    click CoreSuite "https://github.com/scarletshroud/reliability_lib/blob/master/snippets/snippets_suit.c"
    click AdapterAPI "https://github.com/scarletshroud/reliability_lib/blob/master/platform/adapter/platform_adapter.h"
    click AdapterAPI "https://github.com/scarletshroud/reliability_lib/blob/master/platform/adapter/platform_adapter.c"
    click AdapterTarget "https://github.com/scarletshroud/reliability_lib/blob/master/platform/adapter/adapter_target.h"
    click AdapterInit "https://github.com/scarletshroud/reliability_lib/blob/master/platform/adapter/init_platform_adapter.h"
    click AdapterInit "https://github.com/scarletshroud/reliability_lib/blob/master/platform/adapter/init_platform_adapter.c"
    click MK32HAL "https://github.com/scarletshroud/reliability_lib/tree/master/platform/mk32_baremetal/HAL/"
    click MK32Runtime "https://github.com/scarletshroud/reliability_lib/blob/master/platform/mk32_baremetal/runtime/crt0.S"
    click MK32Script "https://github.com/scarletshroud/reliability_lib/tree/master/platform/mk32_baremetal/scripts/"
    click MK32CoreSrc "https://github.com/scarletshroud/reliability_lib/tree/master/platform/mk32_baremetal/src/core/"
    click MK32PeriSrc "https://github.com/scarletshroud/reliability_lib/tree/master/platform/mk32_baremetal/src/periphery/"
    click FreeRTOS "https://github.com/scarletshroud/reliability_lib/tree/master/platform/freeRTOS/"
    click AUTOSAR "https://github.com/scarletshroud/reliability_lib/tree/master/platform/autosar/"
    click QEMU "https://github.com/scarletshroud/reliability_lib/blob/master/platform/qemu/qemu_riscv_uart.c"
    click QEMU "https://github.com/scarletshroud/reliability_lib/blob/master/platform/qemu/qemu_riscv_uart.h"
    click QEMU "https://github.com/scarletshroud/reliability_lib/blob/master/platform/qemu/qemu_project.ld"
    click QEMU "https://github.com/scarletshroud/reliability_lib/blob/master/platform/qemu/startup.s"
    click QEMU "https://github.com/scarletshroud/reliability_lib/blob/master/platform/qemu/run_qemu.sh"
    click HardwareHAL "https://github.com/scarletshroud/reliability_lib/blob/master/platform/mk32_baremetal/HAL/peripherals/Include/*.h"
    click ErrorMonitor "https://github.com/scarletshroud/reliability_lib/blob/master/tools/error_monitor/error_monitor.c"
    click ErrorMonitor "https://github.com/scarletshroud/reliability_lib/blob/master/tools/error_monitor/error_monitor.h"
    click ModelCont "https://github.com/scarletshroud/reliability_lib/tree/master/tools/reliability_evaluation_models/continuous/"
    click ModelDisc "https://github.com/scarletshroud/reliability_lib/tree/master/tools/reliability_evaluation_models/discrete/"
    click ModelStat "https://github.com/scarletshroud/reliability_lib/tree/master/tools/reliability_evaluation_models/static/"
    click ToolsSingle "https://github.com/scarletshroud/reliability_lib/tree/master/tools/reliability_mechanisms/single_design/"
    click ToolsDesign "https://github.com/scarletshroud/reliability_lib/tree/master/tools/reliability_mechanisms/design_diversity/"
    click BuildConfig "https://github.com/scarletshroud/reliability_lib/blob/master/CMakeLists.txt"
    click BuildConfig "https://github.com/scarletshroud/reliability_lib/tree/master/scripts/"

    %% Styles
    classDef blue fill:#cce5ff,stroke:#004085,color:#004085
    classDef green fill:#d4edda,stroke:#155724,color:#155724
    classDef orange fill:#fff3cd,stroke:#856404,color:#856404
    classDef purple fill:#e2e3e5,stroke:#6c757d,color:#6c757d
```
