Functions
	CH_HEAP_AREA (luaExtraHeapArea, LUA_EXTRA_HEAP) SDRAM_OPTIONAL

static Heap	luaExtraHeap (luaExtraHeapArea)

void	luaHeapInit ()

void *	luaHeapAlloc (void , void optr, size_t osize, size_t nsize)

size_t	luaHeapUsed ()

void	luaHeapReset ()

void	luaHeapPrintInfo ()

Variables
static Heap	luaOptionalHeap

static Heap	luaCcmHeap

static size_t	luaMemoryUsed = 0

uint8_t	__heap_base__ []

uint8_t	__heap_end__ []

Function Documentation

◆ CH_HEAP_AREA()

CH_HEAP_AREA	(	luaExtraHeapArea	,
		LUA_EXTRA_HEAP
	)

Here is the call graph for this function:

◆ luaExtraHeap()

static Heap luaExtraHeap ( luaExtraHeapArea )

static

Referenced by luaHeapAlloc(), luaHeapPrintInfo(), and luaHeapReset().

Here is the caller graph for this function:

◆ luaHeapAlloc()

void * luaHeapAlloc	(	void *	,
		void *	optr,
		size_t	osize,
		size_t	nsize
	)

Definition at line 138 of file lua_heap.cpp.

                                                                    {
    // If new size is zero, this is a free. Do not allocate.
    if (nsize == 0) {
        if (optr) {
            size_t oldSize = chHeapGetSize(optr);
            chHeapFree(optr);
            luaMemoryUsed -= oldSize;
        }
        return nullptr;
    }
 
    void *nptr = nullptr;
 
    // [tag:multi-step-lua-alloc]
    // First try dedicated Lua heap(s)
#if (LUA_EXTRA_HEAP > 0)
    if (nptr == nullptr) {
        nptr = luaExtraHeap.alloc(nsize);
    }
#endif
#if defined(STM32F4)
    if (nptr == nullptr) {
        nptr = luaOptionalHeap.alloc(nsize);
    }
#endif
#if MCU_HAS_CCM_RAM
    if (nptr == nullptr) {
        nptr = luaCcmHeap.alloc(nsize);
    }
#endif
 
    // [tag:multi-step-lua-alloc]
    // then try ChibiOS default heap
    if (nptr == nullptr) {
        nptr = chHeapAlloc(NULL, nsize);
    }
 
    size_t newSize = 0;
    if (nptr) {
        // Account for newly allocated memory by actual block size
        newSize = chHeapGetSize(nptr);
        chDbgAssert(newSize >= nsize, "Lua allocator returned smaller block than requested");
        luaMemoryUsed += newSize;
    }
 
    if (optr) {
        chDbgAssert(osize <= chHeapGetSize(optr), "Lua lost track of allocated mem");
        // An old pointer was passed in. Only free it if we successfully allocated a new one.
        size_t oldSize = chHeapGetSize(optr);
        if (nptr != nullptr) {
            // Copy the minimum of old and new block sizes
            size_t copySize = (oldSize < newSize) ? oldSize : newSize;
            memcpy(nptr, optr, copySize);
            // chHeapFree will find correct heap to return memory to
            chHeapFree(optr);
            luaMemoryUsed -= oldSize;
        } else {
            if (nsize <= oldSize) {
                return optr; // shrink must not fail per Lua's assumption
            }
            return nullptr; // grow failed
        }
    }
 
    if (engineConfiguration->debugMode == DBG_LUA) {
        engine->outputChannels.debugIntField1 = luaHeapUsed();
    }
 
    return nptr;
}

Referenced by runScript(), and testLuaExecString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ luaHeapInit()

void luaHeapInit ( )

Definition at line 109 of file lua_heap.cpp.

{
    // stm32f4xx can have optional ram3 region
#if defined(STM32F4)
    // Some boads can be equiped with STM32F42x only, in this case we allow linker to take care of ram3
#if !defined(EFI_IS_F42x)
    // cute hack: let's check at runtime if you are a lucky owner of board with extra RAM and use that extra RAM for extra Lua
    // we need this on microRusEFI for sure
    // definitely should NOT have this on Proteus
    // on Hellen a bit of open question what's the best track
    if (isStm32F42x()) {
        // This is safe to use section base and end as we define ram3 for all F4 chips
        extern uint8_t __ram3_base__[];
        extern uint8_t __ram3_end__[];
        luaOptionalHeap.init(__ram3_base__, __ram3_end__ - __ram3_base__);
    }
#endif // !EFI_IS_F42x
#endif // STM32F4
 
    // stm32f4xx have CCM memory that may have some leftovers
#if MCU_HAS_CCM_RAM
    extern uint8_t __heap_ccm_base__[];
    extern uint8_t __heap_ccm_end__[];
    luaCcmHeap.init(__heap_ccm_base__, __heap_ccm_end__ - __heap_ccm_base__);
#endif
}

Referenced by startLua().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ luaHeapPrintInfo()

void luaHeapPrintInfo ( )

Definition at line 234 of file lua_heap.cpp.

                        {
    size_t chMemTotal =
        /* Chibios heap size */
        #if CH_CFG_MEMCORE_SIZE == 0
            (__heap_end__ - __heap_base__);
        #else
            CH_CFG_MEMCORE_SIZE;
        #endif
    auto totalHeapSize =
        chMemTotal +
    #if (LUA_EXTRA_HEAP > 0)
        luaExtraHeap.size() +
    #endif
    #if defined(STM32F4)
        luaOptionalHeap.size() +
    #endif
    #if MCU_HAS_CCM_RAM
        luaCcmHeap.size() +
    #endif
        0;
 
    if (totalHeapSize) {
        auto memoryUsed = luaHeapUsed();
        float pct = 100.0f * memoryUsed / totalHeapSize;
        efiPrintf("Lua total heap(s) usage: %d / %d bytes = %.1f%%", memoryUsed, totalHeapSize, pct);
    } else {
        efiPrintf("No heap available for Lua");
    }
 
    #if (LUA_EXTRA_HEAP > 0)
        efiPrintf("Lua extra heap usage: %d / %d", luaExtraHeap.used(), luaExtraHeap.size());
    #endif
    #if defined(STM32F4)
        efiPrintf("Lua optional heap usage: %d / %d", luaOptionalHeap.used(), luaOptionalHeap.size());
    #endif
    #if MCU_HAS_CCM_RAM
        efiPrintf("Lua CCM heap usage: %d / %d", luaCcmHeap.used(), luaCcmHeap.size());
    #endif
 
    size_t chHeapFree = 0;
    chHeapStatus(NULL, &chHeapFree, NULL);
    /* total available for ChibiOS minus left free, plus free in Chibios Heap */
    size_t chMemCoreUsed = chMemTotal - chCoreGetStatusX() - chHeapFree;
    efiPrintf("Common ChibiOS heap: %d bytes free", chHeapFree);
    efiPrintf("ChibiOS memcore usage: %d / %d", chMemCoreUsed, chMemTotal);
}

Referenced by loadScript(), and startLua().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ luaHeapReset()

void luaHeapReset ( )

Definition at line 214 of file lua_heap.cpp.

{
#if (LUA_EXTRA_HEAP > 0)
    luaExtraHeap.reset();
#endif
#if defined(STM32F4)
    luaOptionalHeap.reset();
#endif
#if MCU_HAS_CCM_RAM
    luaCcmHeap.reset();
#endif
 
    luaMemoryUsed = 0;
}