oot/src/libu64/stackcheck.c

#include "libu64/debug.h"
#include "attributes.h"
#include "stackcheck.h"
#include "terminal.h"

#include "macros.h"

StackEntry* sStackInfoListStart = NULL;
StackEntry* sStackInfoListEnd = NULL;

void StackCheck_Init(StackEntry* entry, void* stackBottom, void* stackTop, u32 initValue, s32 minSpace,
                     const char* name) {
    StackEntry* iter;
    u32* addr;

    if (entry == NULL) {
        sStackInfoListStart = NULL;
    } else {
        entry->head = stackBottom;
        entry->tail = stackTop;
        entry->initValue = initValue;
        entry->minSpace = minSpace;
        entry->name = name;

#if !PLATFORM_N64
        iter = sStackInfoListStart;
        while (iter) {
            if (iter == entry) {
                PRINTF(VT_COL(RED, WHITE) T("stackcheck_init: %08x は既にリスト中にある\n",
                                            "stackcheck_init: %08x is already in the list\n") VT_RST,
                       entry);
                return;
            }
            iter = iter->next;
        }
#endif

        entry->prev = sStackInfoListEnd;
        entry->next = NULL;

        if (sStackInfoListEnd) {
            sStackInfoListEnd->next = entry;
        }

        sStackInfoListEnd = entry;
        if (!sStackInfoListStart) {
            sStackInfoListStart = entry;
        }

        if (entry->minSpace != -1) {
            addr = entry->head;
            while (addr < entry->tail) {
                *addr++ = entry->initValue;
            }
        }
    }
}

void StackCheck_Cleanup(StackEntry* entry) {
#if PLATFORM_N64
    if (!entry->prev) {
        sStackInfoListStart = entry->next;
    } else {
        entry->prev->next = entry->next;
    }

    if (!entry->next) {
        sStackInfoListEnd = entry->prev;
    }
#else
    u32 inconsistency = false;

    if (!entry->prev) {
        if (entry == sStackInfoListStart) {
            sStackInfoListStart = entry->next;
        } else {
            inconsistency = true;
        }
    } else {
        entry->prev->next = entry->next;
    }

    if (!entry->next) {
        if (entry == sStackInfoListEnd) {
            sStackInfoListEnd = entry->prev;
        } else {
            inconsistency = true;
        }
    }

    if (inconsistency) {
        PRINTF(VT_COL(RED, WHITE) T("stackcheck_cleanup: %08x リスト不整合です\n",
                                    "stackcheck_cleanup: %08x list inconsistent\n") VT_RST,
               entry);
    }
#endif
}

#if PLATFORM_N64

u32 StackCheck_Check(StackEntry* entry) {
    if (entry == NULL) {
        u32 ret = 0;
        StackEntry* iter = sStackInfoListStart;

        while (iter) {
            u32 state = StackCheck_Check(iter);

            if (state != STACK_STATUS_OK) {
                ret = 1;
            }
            iter = iter->next;
        }

        return ret;
    } else {
        u32* last;
        UNUSED_NDEBUG u32 used;
        u32 free;
        u32 ret;

        for (last = entry->head; last < entry->tail; last++) {
            if (entry->initValue != *last) {
                break;
            }
        }

        used = (uintptr_t)entry->tail - (uintptr_t)last;
        free = (uintptr_t)last - (uintptr_t)entry->head;

        if (free == 0) {
            ret = STACK_STATUS_OVERFLOW;
        } else if (free < (u32)entry->minSpace && entry->minSpace != -1) {
            ret = STACK_STATUS_WARNING;
        } else {
            ret = STACK_STATUS_OK;
        }

        osSyncPrintf("head=%08x tail=%08x last=%08x used=%08x free=%08x [%s]\n", entry->head, entry->tail, last, used,
                     free, entry->name != NULL ? entry->name : "(null)");

        return ret;
    }
}

#else

u32 StackCheck_GetState(StackEntry* entry) {
    u32* last;
    UNUSED_NDEBUG u32 used;
    u32 free;
    u32 ret;

    for (last = entry->head; last < entry->tail; last++) {
        if (entry->initValue != *last) {
            break;
        }
    }

    used = (uintptr_t)entry->tail - (uintptr_t)last;
    free = (uintptr_t)last - (uintptr_t)entry->head;

    if (free == 0) {
        ret = STACK_STATUS_OVERFLOW;
        PRINTF_COLOR_RED();
    } else if (free < (u32)entry->minSpace && entry->minSpace != -1) {
        ret = STACK_STATUS_WARNING;
        PRINTF_COLOR_YELLOW();
    } else {
        PRINTF_COLOR_GREEN();
        ret = STACK_STATUS_OK;
    }

#if !DEBUG_FEATURES
    // This string is still in .rodata for retail builds
    (void)"(null)";
#endif

    PRINTF("head=%08x tail=%08x last=%08x used=%08x free=%08x [%s]\n", entry->head, entry->tail, last, used, free,
           entry->name != NULL ? entry->name : "(null)");
    PRINTF_RST();

#if DEBUG_FEATURES
    if (ret != STACK_STATUS_OK) {
        LogUtils_LogHexDump(entry->head, (uintptr_t)entry->tail - (uintptr_t)entry->head);
    }
#endif

    return ret;
}

u32 StackCheck_CheckAll(void) {
    u32 ret = 0;
    StackEntry* iter = sStackInfoListStart;

    while (iter) {
        u32 state = StackCheck_GetState(iter);

        if (state != STACK_STATUS_OK) {
            ret = 1;
        }
        iter = iter->next;
    }

    return ret;
}

u32 StackCheck_Check(StackEntry* entry) {
    if (entry == NULL) {
        return StackCheck_CheckAll();
    } else {
        return StackCheck_GetState(entry);
    }
}

#endif