utility.h File Reference

System utilities for diagnostics, memory, stack usage, and tracing. More...

#include <string>
#include <cstring>
#include <unordered_map>

Include dependency graph for utility.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	printTaskStackSizes ()
	Print stack high watermark for all FreeRTOS tasks.
void	printHeapInfo ()
	Print heap size and minimum ever free heap.
void	printSystemMemoryInfo ()
	Print stack and heap usage together.
std::string	toLower (std::string str)
	Convert string to lowercase.
void	runTimeStats ()
	Display task priorities, stack usage, and heap stats.
void	printActivePCBs ()
	Print number of active lwIP TCP PCBs.
void	logSystemStats ()
	Print FreeRTOS heap and task stack status.
void	printTCPState ()
	Print full lwIP statistics if available.
void	printMemsize ()
	Print lwIP memory pool statistics.
int	is_in_interrupt (void)
	Check whether currently in interrupt context.
void	debug_print (const char *msg)
	Print in a mode that can be used in an ISR context.
void	debug_print (const std::string &msg)
void	debug_print (const char *msg, size_t len)
void	warning (const std::string &msg)
void	warning (const std::string &msg, int32_t code)
void	rebootSystem ()
	Reboot the device immediately.

Detailed Description

Author

Ian Archbell

Provides functions to report heap, stack, and lwIP memory stats, along with runtime diagnostics. Intended for use in embedded applications.

Version

0.1

Date

2025-03-26

License:\n MIT License

Copyright

Copyright (c) 2025, Ian Archbell

Definition in file utility.h.

Function Documentation

debug_print() [1/3]

void debug_print

(

const char *

msg

)

Print in a mode that can be used in an ISR context.

Print in a mode that can be used in an ISR context.

Definition at line 184 of file utility.cpp.

{
    if (msg)
    {
        for (const char *p = msg; *p; ++p)
        {
            uart_putc(uart0, *p);
        }
    }
}

Referenced by EventManager::enqueue().

Here is the caller graph for this function:

debug_print() [2/3]

void debug_print	(	const char *	msg,
		size_t	len
	)

Definition at line 203 of file utility.cpp.

{
    if (msg && len > 0)
    {
        for (size_t i = 0; i < len; ++i)
        {
            uart_putc(uart0, msg[i]);
        }
    }
}

debug_print() [3/3]

void debug_print

(

const std::string &

msg

)

Definition at line 195 of file utility.cpp.

{
    for (const char *p = msg.c_str(); *p; ++p)
    {
        uart_putc(uart0, *p);
    }
}

is_in_interrupt()

int is_in_interrupt

(

void

)

Check whether currently in interrupt context.

Check whether currently in interrupt context.

Definition at line 172 of file utility.cpp.

{
    uint32_t ipsr_value;
#ifndef UNIT_TEST
    __asm volatile("MRS %0, ipsr" : "=r"(ipsr_value));
#else
    ipsr_value = 0;
#endif
    return (ipsr_value != 0);
}

Referenced by EventManager::enqueue(), and EventManager::postNotification().

Here is the caller graph for this function:

logSystemStats()

void logSystemStats

(

)

Print FreeRTOS heap and task stack status.

Print FreeRTOS heap and task stack status.

Definition at line 65 of file utility.cpp.

{
    printf("\n===== SYSTEM STATS =====\n");
    printf("Free heap size: %zu bytes\n", xPortGetFreeHeapSize());
    printf("Minimum ever free heap: %zu bytes\n", xPortGetMinimumEverFreeHeapSize());
    printf("Stack watermark: AcceptConnect: %zu, HandleClient: %zu, tcpip_thread: %zu\n",
           uxTaskGetStackHighWaterMark(NULL),
           uxTaskGetStackHighWaterMark(NULL),
           uxTaskGetStackHighWaterMark(NULL));
    printf("========================\n");
}

printActivePCBs()

void printActivePCBs

(

)

Print number of active lwIP TCP PCBs.

Print number of active lwIP TCP PCBs.

Definition at line 142 of file utility.cpp.

{
#if LWIP_STATS && MEMP_STATS
    TRACE("Active TCP PCBs: %d\n", lwip_stats.memp[MEMP_TCP_PCB]->used);
#else
    TRACE("LWIP stats are not enabled, cannot track active PCBs.\n");
#endif
}

References TRACE.

printHeapInfo()

void printHeapInfo

(

)

Print heap size and minimum ever free heap.

Print heap size and minimum ever free heap.

Definition at line 78 of file utility.cpp.

{
    TRACE("Heap Information:\n");
    TRACE("Free heap size: %u bytes\n", (unsigned int)xPortGetFreeHeapSize());
    TRACE("Minimum ever free heap size: %u bytes\n", (unsigned int)xPortGetMinimumEverFreeHeapSize());
}

References TRACE.

Referenced by printSystemMemoryInfo().

Here is the caller graph for this function:

printMemsize()

void printMemsize

(

)

Print lwIP memory pool statistics.

Print lwIP memory pool statistics.

Definition at line 165 of file utility.cpp.

{
    printf("MEM SIZE: %d\n", lwip_stats.mem.avail);
    printf("MEM USED: %d\n", lwip_stats.mem.used);
}

printSystemMemoryInfo()

void printSystemMemoryInfo

(

)

Print stack and heap usage together.

Print stack and heap usage together.

Definition at line 86 of file utility.cpp.

{
    printTaskStackSizes();
    printHeapInfo();
}

References printHeapInfo(), and printTaskStackSizes().

Here is the call graph for this function:

printTaskStackSizes()

void printTaskStackSizes

(

)

Print stack high watermark for all FreeRTOS tasks.

Print stack high watermark for all FreeRTOS tasks.

Definition at line 39 of file utility.cpp.

{
    TRACE("Task Stack Sizes:\n");
 
    TaskStatus_t *pxTaskStatusArray;
    UBaseType_t uxTaskCount = uxTaskGetNumberOfTasks();
    pxTaskStatusArray = (TaskStatus_t *)pvPortMalloc(uxTaskCount * sizeof(TaskStatus_t));
 
    if (pxTaskStatusArray != NULL)
    {
        uxTaskGetSystemState(pxTaskStatusArray, uxTaskCount, NULL);
        for (UBaseType_t i = 0; i < uxTaskCount; i++)
        {
            TRACE("Task %s: Stack high watermark: %u bytes\n",
                  pxTaskStatusArray[i].pcTaskName,
                  pxTaskStatusArray[i].usStackHighWaterMark);
        }
        vPortFree(pxTaskStatusArray);
    }
    else
    {
        TRACE("Failed to allocate memory for task status array.\n");
    }
}

References TRACE.

Referenced by printSystemMemoryInfo().

Here is the caller graph for this function:

printTCPState()

void printTCPState

(

)

Print full lwIP statistics if available.

Print full lwIP statistics if available.

Definition at line 152 of file utility.cpp.

{
    TRACE("\n===== TCP/IP STATE =====\n");
#if LWIP_STATS && TRACE_INFO
    extern void stats_display(void);
    stats_display();
#else
    TRACE("lwIP stats unavailable. Ensure LWIP_STATS is enabled in lwipopts.h\n");
#endif
    TRACE("========================\n");
}

References TRACE.

rebootSystem()

void rebootSystem

(

)

This function performs a clean system reboot using the appropriate method for the platform (RP2040 or RP2350). Intended for controlled resets, such as after persistent failures or user-initiated reboots.

Definition at line 237 of file utility.cpp.

                    {
    NVIC_SystemReset();
}

Referenced by FrameworkManager::poll().

Here is the caller graph for this function:

runTimeStats()

void runTimeStats

(

)

Display task priorities, stack usage, and heap stats.

Display task priorities, stack usage, and heap stats.

Definition at line 102 of file utility.cpp.

{
    TaskStatus_t *pxTaskStatusArray;
    UBaseType_t uxArraySize = uxTaskGetNumberOfTasks();
    unsigned long ulTotalRunTime;
 
    TRACE("Number of tasks %d\n", uxArraySize);
    pxTaskStatusArray = (TaskStatus_t *)pvPortMalloc(uxArraySize * sizeof(TaskStatus_t));
 
    if (pxTaskStatusArray != NULL)
    {
        uxArraySize = uxTaskGetSystemState(pxTaskStatusArray, uxArraySize, &ulTotalRunTime);
 
        for (UBaseType_t x = 0; x < uxArraySize; x++)
        {
            printf("Task: %d \t cPri:%d \t bPri:%d \t hw:%zu \t%s \t core: %s\n",
                   pxTaskStatusArray[x].xTaskNumber,
                   pxTaskStatusArray[x].uxCurrentPriority,
                   pxTaskStatusArray[x].uxBasePriority,
                   pxTaskStatusArray[x].usStackHighWaterMark,
                   pxTaskStatusArray[x].pcTaskName);
            printf("%d\n", get_core_num());
        }
        vPortFree(pxTaskStatusArray);
    }
    else
    {
        panic("Failed to allocate space for stats\n");
    }
 
    HeapStats_t heapStats;
    vPortGetHeapStats(&heapStats);
    printf("HEAP avl: %zu, blocks %zu, alloc: %zu, free: %zu\n",
           heapStats.xAvailableHeapSpaceInBytes,
           heapStats.xNumberOfFreeBlocks,
           heapStats.xNumberOfSuccessfulAllocations,
           heapStats.xNumberOfSuccessfulFrees);
}

References TRACE.

toLower()

std::string toLower

(

std::string

str

)

Convert string to lowercase.

Convert string to lowercase.

Definition at line 93 of file utility.cpp.

{
    std::transform(str.begin(), str.end(), str.begin(),
                   [](unsigned char c)
                   { return std::tolower(c); });
    return str;
}

Referenced by HttpRequest::getHeader(), and HttpParser::isChunkedEncoding().

Here is the caller graph for this function:

warning() [1/2]

void warning

(

const std::string &

msg

)

Definition at line 215 of file utility.cpp.

{
    printf("\033[31m");
    printf("WARNING: %s\n", msg.c_str());
    printf("\033[0m");
}

Referenced by HttpServer::run(), and Tcp::send().

Here is the caller graph for this function:

warning() [2/2]

void warning	(	const std::string &	msg,
		int32_t	code
	)

Definition at line 223 of file utility.cpp.

{
    std::string fullMsg = msg + " (code: " + std::to_string(code) + ")\n";
    printf("\033[31m");
    printf("WARNING: %s\n", fullMsg.c_str());
    printf("\033[0m");
}