lua.cpp File Reference

Functions
static Heap	userHeap (luaUserHeap)
static void	printLuaMemoryInfo ()
static void *	myAlloc (void *, void *ptr, size_t osize, size_t nsize)
static int	lua_setTickRate (lua_State *l)
static void	loadLibraries (LuaHandle &ls)
static LuaHandle	setupLuaState (lua_Alloc alloc)
static bool	loadScript (LuaHandle &ls, const char *scriptStr)
static void	doInteractive (LuaHandle &ls)
static void	invokeTick (LuaHandle &ls)
static void	resetLua ()
static bool	runOneLua (lua_Alloc alloc, const char *script)
void	startLua ()
static LuaHandle	runScript (const char *script)
expected< float >	testLuaReturnsNumberOrNil (const char *script)
float	testLuaReturnsNumber (const char *script)
int	testLuaReturnsInteger (const char *script)
void	testLuaExecString (const char *script)
float	strtof_rusefi (const char *str, char **endPtr)

Variables
static char luaUserHeap[LUA_USER_HEAP] SDRAM_OPTIONAL	LUA_HEAD_RAM_SECTION
static int	recentRxCount = 0
static int	totalRxCount = 0
static int	rxTime
static int	luaTickPeriodUs
static bool	interactivePending = false
static char	interactiveCmd [100]
static bool	needsReset = false
static LuaThread	luaThread

Function Documentation

doInteractive()

static void doInteractive ( LuaHandle &  ls )

static

Definition at line 228 of file lua.cpp.

                                         {
    if (!interactivePending) {
        // no cmd pending, return
        return;
    }
 
    auto status = luaL_dostring(ls, interactiveCmd);
 
    if (0 == status) {
        // Function call was OK, resolve return value and print it
        if (lua_isinteger(ls, -1)) {
            efiPrintf(TAG "interactive returned integer: %d", lua_tointeger(ls, -1));
        } else if (lua_isnumber(ls, -1)) {
            efiPrintf(TAG "interactive returned number: %f", lua_tonumber(ls, -1));
        } else if (lua_isstring(ls, -1)) {
            efiPrintf(TAG "interactive returned string: '%s'", lua_tostring(ls, -1));
        } else if (lua_isboolean(ls, -1)) {
            efiPrintf(TAG "interactive returned bool: %s", lua_toboolean(ls, -1) ? "true" : "false");
        } else if (lua_isnil(ls, -1)) {
            efiPrintf(TAG "interactive returned nil.");
        } else {
            efiPrintf(TAG "interactive returned nothing.");
        }
    } else {
        // error with interactive command, print it
        efiPrintf(TAG "interactive error: %s", lua_tostring(ls, -1));
    }
 
    interactivePending = false;
 
    lua_settop(ls, 0);
}

Referenced by runOneLua().

Here is the caller graph for this function:

invokeTick()

static void invokeTick ( LuaHandle &  ls )

static

Definition at line 261 of file lua.cpp.

                                      {
    ScopePerf perf(PE::LuaTickFunction);
 
    // run the tick function
    lua_getglobal(ls, "onTick");
    if (lua_isnil(ls, -1)) {
        // TODO: handle missing tick function
        lua_settop(ls, 0);
        return;
    }
 
    int status = lua_pcall(ls, 0, 0, 0);
 
    if (0 != status) {
        // error calling hook function
        auto errMsg = lua_tostring(ls, -1);
        efiPrintf(TAG "error %s", errMsg);
        lua_pop(ls, 1);
    }
 
    lua_settop(ls, 0);
}

Referenced by runOneLua().

Here is the caller graph for this function:

loadLibraries()

static void loadLibraries ( LuaHandle &  ls )

static

Definition at line 158 of file lua.cpp.

                                         {
    constexpr luaL_Reg libs[] = {
        // TODO: do we even need the base lib?
        //{ LUA_GNAME, luaopen_base },
        { LUA_MATHLIBNAME, luaopen_math },
    };
 
    for (size_t i = 0; i < efi::size(libs); i++) {
        luaL_requiref(ls, libs[i].name, libs[i].func, 1);
        lua_pop(ls, 1);
    }
}

Referenced by setupLuaState().

Here is the caller graph for this function:

loadScript()

static bool loadScript ( LuaHandle &  ls, const char *  scriptStr  )

static

Definition at line 206 of file lua.cpp.

                                                             {
    efiPrintf(TAG "loading script length: %d...", efiStrlen(scriptStr));
 
    if (0 != luaL_dostring(ls, scriptStr)) {
        efiPrintf(TAG "ERROR loading script: %s", lua_tostring(ls, -1));
        lua_pop(ls, 1);
        return false;
    }
 
    efiPrintf(TAG "script loaded successfully!");
 
#if EFI_PROD_CODE
    printLuaMemoryInfo();
#endif // EFI_PROD_CODE
 
    return true;
}

Referenced by runOneLua(), runScript(), and testLuaExecString().

Here is the call graph for this function:

Here is the caller graph for this function:

lua_setTickRate()

static int lua_setTickRate ( lua_State *  l )

static

Definition at line 147 of file lua.cpp.

                                         {
    float freq = luaL_checknumber(l, 1);
 
    // For instance BMW does 100 CAN messages per second on some IDs, let's allow at least twice that speed
    // Limit to 1..200 hz
    freq = clampF(1, freq, 200);
 
    luaTickPeriodUs = 1000000.0f / freq;
    return 0;
}

Referenced by setupLuaState().

Here is the caller graph for this function:

myAlloc()

static void * myAlloc ( void *  , void *  ptr, size_t  osize, size_t  nsize  )

static

Definition at line 122 of file lua.cpp.

                                                                     {
    if (engineConfiguration->debugMode == DBG_LUA) {
        engine->outputChannels.debugIntField1 = userHeap.used();
    }
 
    return userHeap.realloc(ptr, osize, nsize);
}

Referenced by runScript(), and testLuaExecString().

Here is the call graph for this function:

Here is the caller graph for this function:

printLuaMemoryInfo()

static void printLuaMemoryInfo ( )

static

Definition at line 115 of file lua.cpp.

                                 {
    auto heapSize = userHeap.size();
    auto memoryUsed = userHeap.used();
    float pct = 100.0f * memoryUsed / heapSize;
    efiPrintf("Lua memory heap usage: %d / %d bytes = %.1f%%", memoryUsed, heapSize, pct);
}

Referenced by loadScript(), and startLua().

Here is the call graph for this function:

Here is the caller graph for this function:

resetLua()

static void resetLua ( )

static

Definition at line 290 of file lua.cpp.

                       {
    engine->module<AcController>().unmock().isDisabledByLua = false;
#if EFI_CAN_SUPPORT
    resetLuaCanRx();
#endif // EFI_CAN_SUPPORT
 
    // De-init pins, they will reinit next start of the script.
    luaDeInitPins();
}

Referenced by runOneLua().

Here is the call graph for this function:

Here is the caller graph for this function:

runOneLua()

static bool runOneLua ( lua_Alloc  alloc, const char *  script  )

static

Definition at line 310 of file lua.cpp.

                                                           {
    needsReset = false;
 
    auto ls = setupLuaState(alloc);
 
    // couldn't start Lua interpreter, bail out
    if (!ls) {
        return false;
    }
 
    // Reset default tick rate
    luaTickPeriodUs = MS2US(100);
 
    if (!loadScript(ls, script)) {
        return false;
    }
 
    while (!needsReset && !chThdShouldTerminateX()) {
        efitick_t beforeNt = getTimeNowNt();
#if EFI_CAN_SUPPORT
        // First, process any pending can RX messages
        totalRxCount += recentRxCount;
        recentRxCount = doLuaCanRx(ls);
        rxTime = getTimeNowNt() - beforeNt;
#endif // EFI_CAN_SUPPORT
 
        // Next, check if there is a pending interactive command entered by the user
        doInteractive(ls);
 
        invokeTick(ls);
 
        engine->outputChannels.luaLastCycleDuration = (getTimeNowNt() - beforeNt);
        engine->outputChannels.luaInvocationCounter++;
        chThdSleep(TIME_US2I(luaTickPeriodUs));
 
        engine->engineState.luaDigitalState0 = getAuxDigital(0);
        engine->engineState.luaDigitalState1 = getAuxDigital(1);
        engine->engineState.luaDigitalState2 = getAuxDigital(2);
        engine->engineState.luaDigitalState3 = getAuxDigital(3);
    }
 
    resetLua();
 
    return true;
}

Here is the call graph for this function:

runScript()

static LuaHandle runScript ( const char *  script )

static

Definition at line 442 of file lua.cpp.

                                               {
    auto ls = setupLuaState(myAlloc);
 
    if (!ls) {
        throw std::logic_error("Call to setupLuaState failed, returned null");
    }
 
    if (!loadScript(ls, script)) {
        throw std::logic_error("Call to loadScript failed");
    }
 
    lua_getglobal(ls, "testFunc");
    if (lua_isnil(ls, -1)) {
        throw std::logic_error("Failed to find function testFunc");
    }
 
    int status = lua_pcall(ls, 0, 1, 0);
 
    if (0 != status) {
        std::string msg = std::string("lua error while running script: ") + lua_tostring(ls, -1);
        throw std::logic_error(msg);
    }
 
    return ls;
}

Referenced by testLuaReturnsInteger(), testLuaReturnsNumber(), and testLuaReturnsNumberOrNil().

Here is the call graph for this function:

Here is the caller graph for this function:

setupLuaState()

static LuaHandle setupLuaState ( lua_Alloc  alloc )

static

Definition at line 171 of file lua.cpp.

                                                {
    LuaHandle ls = lua_newstate(alloc, NULL);
 
    if (!ls) {
        criticalError("Failed to start Lua interpreter");
 
        return nullptr;
    }
 
    lua_atpanic(ls, [](lua_State* l) {
        criticalError("Lua panic: %s", lua_tostring(l, -1));
 
        // hang the lua thread
        while (true) ;
 
        return 0;
    });
 
    // Load Lua's own libraries
    loadLibraries(ls);
 
    // Load rusEFI hooks
    lua_register(ls, "setTickRate", lua_setTickRate);
    configureRusefiLuaHooks(ls);
 
    // run a GC cycle
    lua_gc(ls, LUA_GCCOLLECT, 0);
 
    // set GC settings
    // see https://www.lua.org/manual/5.4/manual.html#2.5.1
    lua_gc(ls, LUA_GCINC, 50, 1000, 9);
 
    return ls;
}

Referenced by runOneLua(), runScript(), and testLuaExecString().

Here is the call graph for this function:

Here is the caller graph for this function:

startLua()

void startLua

(

)

Definition at line 386 of file lua.cpp.

                {
#if defined(STM32F4) && !defined(EFI_IS_F42x)
    // 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
    // cute hack: let's check at runtime if you are a lucky owner of microRusEFI with extra RAM and use that extra RAM for extra Lua
    if (isStm32F42x()) {
        char *buffer = (char *)0x20020000;
        userHeap.reinit(buffer, 60000);
    }
#endif // STM32F4
 
#if LUA_USER_HEAP > 1
#if EFI_CAN_SUPPORT
    initLuaCanRx();
#endif // EFI_CAN_SUPPORT
 
    addConsoleActionII("set_lua_setting", [](int index, int value) {
        engineConfiguration->scriptSetting[index] = value;
    });
 
    luaThread.start();
 
    addConsoleActionS("lua", [](const char* str){
        if (interactivePending) {
            return;
        }
 
        strncpy(interactiveCmd, str, sizeof(interactiveCmd) - 1);
        interactiveCmd[sizeof(interactiveCmd) - 1] = '\0';
 
        interactivePending = true;
    });
 
    addConsoleAction("luareset", [](){
        needsReset = true;
    });
 
    addConsoleAction("luamemory", [](){
      efiPrintf("rx total/recent %d %d", totalRxCount,
        recentRxCount);
      efiPrintf("luaCycle %dus including luaRxTime %dus", NT2US(engine->outputChannels.luaLastCycleDuration),
        NT2US(rxTime));
 
     printLuaMemoryInfo();
  });
#endif
}

Referenced by commonEarlyInit().

Here is the call graph for this function:

Here is the caller graph for this function:

strtof_rusefi()

float strtof_rusefi	(	const char *	str,
		char **	endPtr
	)

Definition at line 526 of file lua.cpp.

                                                               {
    bool afterDecimalPoint = false;
    float div = 1; // Divider to place digits after the decimal point
 
    if (endPtr) {
        *endPtr = const_cast<char*>(str);
    }
 
    float integerPart = 0;
    float fractionalPart = 0;
 
    while (*str != '\0') {
        char c = *str;
        int digitVal = c - '0';
 
        if (c >= '0' && c <= '9') {
            if (!afterDecimalPoint) {
                // Integer part
                integerPart = 10 * integerPart + digitVal;
            } else {
                // Fractional part
                fractionalPart = 10 * fractionalPart + digitVal;
                div *= 10;
            }
        } else if (c == '.') {
            afterDecimalPoint = true;
        } else {
            break;
        }
 
        str++;
 
        if (endPtr) {
            *endPtr = const_cast<char*>(str);
        }
    }
 
    return integerPart + fractionalPart / div;
}

testLuaExecString()

void testLuaExecString

(

const char *

script

)

Definition at line 508 of file lua.cpp.

                                           {
    auto ls = setupLuaState(myAlloc);
 
    if (!ls) {
        throw std::logic_error("Call to setupLuaState failed, returned null");
    }
 
    if (!loadScript(ls, script)) {
        throw std::logic_error("Call to loadScript failed");
    }
}

Here is the call graph for this function:

testLuaReturnsInteger()

int testLuaReturnsInteger

(

const char *

script

)

Definition at line 497 of file lua.cpp.

                                              {
    auto ls = runScript(script);
 
    // pop the return value;
    if (!lua_isinteger(ls, -1)) {
        throw std::logic_error("Returned value is not an integer");
    }
 
    return lua_tointeger(ls, -1);
}

Here is the call graph for this function:

testLuaReturnsNumber()

float testLuaReturnsNumber

(

const char *

script

)

Definition at line 485 of file lua.cpp.

                                               {
    auto ls = runScript(script);
 
    // check the return value
    if (!lua_isnumber(ls, -1)) {
        throw new std::logic_error("Returned value is not a number");
    }
 
    // pop the return value
    return lua_tonumber(ls, -1);
}

Here is the call graph for this function:

testLuaReturnsNumberOrNil()

expected<float> testLuaReturnsNumberOrNil

(

const char *

script

)

Definition at line 468 of file lua.cpp.

                                                              {
    auto ls = runScript(script);
 
    // check nil return first
    if (lua_isnil(ls, -1)) {
        return unexpected;
    }
 
    // If not nil, it should be a number
    if (!lua_isnumber(ls, -1)) {
        throw std::logic_error("Returned value is not a number");
    }
 
    // pop the return value
    return lua_tonumber(ls, -1);
}

Here is the call graph for this function:

userHeap()

static Heap userHeap ( luaUserHeap  )

static

Referenced by myAlloc(), printLuaMemoryInfo(), and startLua().

Here is the caller graph for this function:

Variable Documentation

interactiveCmd

char interactiveCmd[100]

static

Definition at line 226 of file lua.cpp.

Referenced by doInteractive(), and startLua().

interactivePending

bool interactivePending = false

static

Definition at line 225 of file lua.cpp.

Referenced by doInteractive(), and startLua().

LUA_HEAD_RAM_SECTION

char luaUserHeap [LUA_USER_HEAP] SDRAM_OPTIONAL LUA_HEAD_RAM_SECTION

static

Definition at line 29 of file lua.cpp.

luaThread

LuaThread luaThread

static

Definition at line 383 of file lua.cpp.

Referenced by startLua().

luaTickPeriodUs

int luaTickPeriodUs

static

Definition at line 145 of file lua.cpp.

Referenced by lua_setTickRate(), and runOneLua().

needsReset

bool needsReset = false

static

Definition at line 301 of file lua.cpp.

Referenced by runOneLua(), and startLua().

recentRxCount

int recentRxCount = 0

static

Definition at line 33 of file lua.cpp.

Referenced by runOneLua(), and startLua().

rxTime

int rxTime

static

Definition at line 35 of file lua.cpp.

Referenced by runOneLua(), and startLua().

totalRxCount

int totalRxCount = 0

static

Definition at line 34 of file lua.cpp.

Referenced by runOneLua(), and startLua().

Go to the source code of this file.