/* * Copyright (C) OpenTX * * Based on code named * th9x - http://code.google.com/p/th9x * er9x - http://code.google.com/p/er9x * gruvin9x - http://code.google.com/p/gruvin9x * * License GPLv2: http://www.gnu.org/licenses/gpl-2.0.html * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License version 2 as * published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. */ /** @file Main interface layer handler for Lua API. */ #include #include #include "opentx.h" #include "bin_allocator.h" #include "lua/lua_api.h" #include "sdcard.h" extern "C" { #include } #define PERMANENT_SCRIPTS_MAX_INSTRUCTIONS (10000/100) #define MANUAL_SCRIPTS_MAX_INSTRUCTIONS (20000/100) #define LUA_WARNING_INFO_LEN 64 lua_State *lsScripts = NULL; uint8_t luaState = 0; uint8_t luaScriptsCount = 0; ScriptInternalData scriptInternalData[MAX_SCRIPTS]; ScriptInputsOutputs scriptInputsOutputs[MAX_SCRIPTS]; ScriptInternalData standaloneScript; uint16_t maxLuaInterval = 0; uint16_t maxLuaDuration = 0; bool luaLcdAllowed; int instructionsPercent = 0; char lua_warning_info[LUA_WARNING_INFO_LEN+1]; struct our_longjmp * global_lj = 0; /* custom panic handler */ int custom_lua_atpanic(lua_State * L) { TRACE("PANIC: unprotected error in call to Lua API (%s)\n", lua_tostring(L, -1)); if (global_lj) { longjmp(global_lj->b, 1); /* will never return */ } return 0; } void luaHook(lua_State * L, lua_Debug *ar) { instructionsPercent++; if (instructionsPercent > 100) { // From now on, as soon as a line is executed, error // keep erroring until you're script reaches the top lua_sethook(L, luaHook, LUA_MASKLINE, 0); luaL_error(L, ""); } } void luaSetInstructionsLimit(lua_State * L, int count) { instructionsPercent=0; lua_sethook(L, luaHook, LUA_MASKCOUNT, count); } int luaGetInputs(lua_State * L, ScriptInputsOutputs & sid) { if (!lua_istable(L, -1)) return -1; sid.inputsCount = 0; for (lua_pushnil(L); lua_next(L, -2); lua_pop(L, 1)) { luaL_checktype(L, -2, LUA_TNUMBER); // key is number luaL_checktype(L, -1, LUA_TTABLE); // value is table if (sid.inputsCountfdate/ftime @param stripDebug This is passed directly to luaU_dump() 1 = remove debug info from bytecode (smaller but errors are less informative) 0 = keep debug info */ static void luaDumpState(lua_State * L, const char * filename, const FILINFO * finfo, int stripDebug) { FIL D; if (f_open(&D, filename, FA_WRITE | FA_CREATE_ALWAYS) == FR_OK) { lua_lock(L); luaU_dump(L, getproto(L->top - 1), luaDumpWriter, &D, stripDebug); lua_unlock(L); if (f_close(&D) == FR_OK) { if (finfo != NULL) f_utime(filename, finfo); // set the file mod time TRACE("luaDumpState(%s): Saved bytecode to file.", filename); } } else TRACE_ERROR("luaDumpState(%s): Error: Could not open output file.", filename); } #endif // LUA_COMPILER /** @fn luaLoadScriptFileToState(lua_State * L, const char * filename, const char * mode) Load a Lua script file into a given lua_State (stack). May use OpenTx's optional pre-compilation feature to save memory and time during load. @param L (lua_State) the Lua stack to load into. @param filename (string) full path and file name of script. @param mode (string) controls whether the file can be text or binary (that is, a pre-compiled file). Possible values are: "b" only binary. "t" only text. "T" (default on simulator) prefer text but load binary if that is the only version available. "bt" (default on radio) either binary or text, whichever is newer (binary preferred when timestamps are equal). Add "x" to avoid automatic compilation of source file to .luac version. Eg: "tx", "bx", or "btx". Add "c" to force compilation of source file to .luac version (even if existing version is newer than source file). Eg: "tc" or "btc" (forces "t", overrides "x"). Add "d" to keep extra debug info in the compiled binary. Eg: "td", "btd", or "tcd" (no effect with just "b" or with "x"). @retval (int) SCRIPT_OK on success (LUA_OK) SCRIPT_NOFILE if file wasn't found for specified mode or Lua could not open file (LUA_ERRFILE) SCRIPT_SYNTAX_ERROR if Lua returned a syntax error during pre/de-compilation (LUA_ERRSYNTAX) SCRIPT_PANIC for Lua memory errors (LUA_ERRMEM or LUA_ERRGCMM) */ int luaLoadScriptFileToState(lua_State * L, const char * filename, const char * mode) { if (luaState == INTERPRETER_PANIC) { return SCRIPT_PANIC; } else if (filename == NULL) { return SCRIPT_NOFILE; } int lstatus; char lmode[6] = "bt"; uint8_t ret = SCRIPT_NOFILE; if (mode != NULL) { strncpy(lmode, mode, sizeof(lmode)-1); lmode[sizeof(lmode)-1] = '\0'; } #if defined(LUA_COMPILER) uint16_t fnamelen; uint8_t extlen; char filenameFull[LEN_FILE_PATH_MAX + _MAX_LFN + 1] = "\0"; FILINFO fnoLuaS, fnoLuaC; FRESULT frLuaS, frLuaC; bool scriptNeedsCompile = false; uint8_t loadFileType = 0; // 1=text, 2=binary memset(&fnoLuaS, 0, sizeof(FILINFO)); memset(&fnoLuaC, 0, sizeof(FILINFO)); fnamelen = strlen(filename); // check if file extension is already in the file name and strip it getFileExtension(filename, fnamelen, 0, NULL, &extlen); fnamelen -= extlen; if (fnamelen > sizeof(filenameFull) - sizeof(SCRIPT_BIN_EXT)) { TRACE_ERROR("luaLoadScriptFileToState(%s, %s): Error loading script: filename buffer overflow.\n", filename, lmode); return ret; } strncat(filenameFull, filename, fnamelen); // check if binary version exists strcpy(filenameFull + fnamelen, SCRIPT_BIN_EXT); frLuaC = f_stat(filenameFull, &fnoLuaC); // check if text version exists strcpy(filenameFull + fnamelen, SCRIPT_EXT); frLuaS = f_stat(filenameFull, &fnoLuaS); // decide which version to load, text or binary if (frLuaC != FR_OK && frLuaS == FR_OK) { // only text version exists loadFileType = 1; scriptNeedsCompile = true; } else if (frLuaC == FR_OK && frLuaS != FR_OK) { // only binary version exists loadFileType = 2; } else if (frLuaS == FR_OK) { // both versions exist, compare them if (strchr(lmode, 'c') || (uint32_t)((fnoLuaC.fdate << 16) + fnoLuaC.ftime) < (uint32_t)((fnoLuaS.fdate << 16) + fnoLuaS.ftime)) { // text version is newer than binary or forced by "c" mode flag, rebuild it scriptNeedsCompile = true; } if (scriptNeedsCompile || !strchr(lmode, 'b')) { // text version needs compilation or forced by mode loadFileType = 1; } else { // use binary file loadFileType = 2; } } // else both versions are missing // skip compilation based on mode flags? ("c" overrides "x") if (scriptNeedsCompile && strchr(lmode, 'x') && !strchr(lmode, 'c')) { scriptNeedsCompile = false; } if (loadFileType == 2) { // change file extension to binary version strcpy(filenameFull + fnamelen, SCRIPT_BIN_EXT); } // TRACE_DEBUG("luaLoadScriptFileToState(%s, %s):\n", filename, lmode); // TRACE_DEBUG("\tldfile='%s'; ldtype=%u; compile=%u;\n", filenameFull, loadFileType, scriptNeedsCompile); // TRACE_DEBUG("\t%-5s: %s; mtime: %04X%04X = %u/%02u/%02u %02u:%02u:%02u;\n", SCRIPT_EXT, (frLuaS == FR_OK ? "ok" : "nf"), fnoLuaS.fdate, fnoLuaS.ftime, // (fnoLuaS.fdate >> 9) + 1980, (fnoLuaS.fdate >> 5) & 15, fnoLuaS.fdate & 31, fnoLuaS.ftime >> 11, (fnoLuaS.ftime >> 5) & 63, (fnoLuaS.ftime & 31) * 2); // TRACE_DEBUG("\t%-5s: %s; mtime: %04X%04X = %u/%02u/%02u %02u:%02u:%02u;\n", SCRIPT_BIN_EXT, (frLuaC == FR_OK ? "ok" : "nf"), fnoLuaC.fdate, fnoLuaC.ftime, // (fnoLuaC.fdate >> 9) + 1980, (fnoLuaC.fdate >> 5) & 15, fnoLuaC.fdate & 31, fnoLuaC.ftime >> 11, (fnoLuaC.ftime >> 5) & 63, (fnoLuaC.ftime & 31) * 2); // final check that file exists and is allowed by mode flags if (!loadFileType || (loadFileType == 1 && !strpbrk(lmode, "tTc")) || (loadFileType == 2 && !strpbrk(lmode, "bT"))) { TRACE_ERROR("luaLoadScriptFileToState(%s, %s): Error loading script: file not found.\n", filename, lmode); return SCRIPT_NOFILE; } #else // !defined(LUA_COMPILER) // use passed file name as-is const char *filenameFull = filename; #endif TRACE("luaLoadScriptFileToState(%s, %s): loading %s", filename, lmode, filenameFull); // we don't pass on to loadfilex() because we want lua to load whatever file we specify, regardless of content lstatus = luaL_loadfilex(L, filenameFull, NULL); #if defined(LUA_COMPILER) // Check for bytecode encoding problem, eg. compiled for x64. Unfortunately Lua doesn't provide a unique error code for this. See Lua/src/lundump.c. if (lstatus == LUA_ERRSYNTAX && loadFileType == 2 && frLuaS == FR_OK && strstr(lua_tostring(L, -1), "precompiled")) { loadFileType = 1; scriptNeedsCompile = true; strcpy(filenameFull + fnamelen, SCRIPT_EXT); TRACE_ERROR("luaLoadScriptFileToState(%s, %s): Error loading script: %s\n\tRetrying with %s\n", filename, lmode, lua_tostring(L, -1), filenameFull); lstatus = luaL_loadfilex(L, filenameFull, NULL); } if (lstatus == LUA_OK) { if (scriptNeedsCompile && loadFileType == 1) { strcpy(filenameFull + fnamelen, SCRIPT_BIN_EXT); luaDumpState(L, filenameFull, &fnoLuaS, (strchr(lmode, 'd') ? 0 : 1)); } ret = SCRIPT_OK; } #else if (lstatus == LUA_OK) { ret = SCRIPT_OK; } #endif else { TRACE_ERROR("luaLoadScriptFileToState(%s, %s): Error loading script: %s\n", filename, lmode, lua_tostring(L, -1)); if (lstatus == LUA_ERRFILE) { ret = SCRIPT_NOFILE; } else if (lstatus == LUA_ERRSYNTAX) { ret = SCRIPT_SYNTAX_ERROR; } else { // LUA_ERRMEM or LUA_ERRGCMM ret = SCRIPT_PANIC; } } return ret; } static int luaLoad(lua_State * L, const char * filename, ScriptInternalData & sid, ScriptInputsOutputs * sio=NULL) { int init = 0; int lstatus = 0; sid.instructions = 0; sid.state = SCRIPT_OK; if (luaState == INTERPRETER_PANIC) { return SCRIPT_PANIC; } luaSetInstructionsLimit(L, MANUAL_SCRIPTS_MAX_INSTRUCTIONS); PROTECT_LUA() { sid.state = luaLoadScriptFileToState(L, filename, LUA_SCRIPT_LOAD_MODE); if (sid.state == SCRIPT_OK && (lstatus = lua_pcall(L, 0, 1, 0)) == LUA_OK && lua_istable(L, -1)) { for (lua_pushnil(L); lua_next(L, -2); lua_pop(L, 1)) { const char * key = lua_tostring(L, -2); if (!strcmp(key, "init")) { init = luaL_ref(L, LUA_REGISTRYINDEX); lua_pushnil(L); } else if (!strcmp(key, "run")) { sid.run = luaL_ref(L, LUA_REGISTRYINDEX); lua_pushnil(L); } else if (!strcmp(key, "background")) { sid.background = luaL_ref(L, LUA_REGISTRYINDEX); lua_pushnil(L); } else if (sio && !strcmp(key, "input")) { luaGetInputs(L, *sio); } else if (sio && !strcmp(key, "output")) { luaGetOutputs(L, *sio); } } if (init) { lua_rawgeti(L, LUA_REGISTRYINDEX, init); if (lua_pcall(L, 0, 0, 0) != 0) { TRACE_ERROR("luaLoad(%s): Error in script init(): %s\n", filename, lua_tostring(L, -1)); sid.state = SCRIPT_SYNTAX_ERROR; } luaL_unref(L, LUA_REGISTRYINDEX, init); lua_gc(L, LUA_GCCOLLECT, 0); } } else if (sid.state == SCRIPT_OK) { TRACE_ERROR("luaLoad(%s): Error parsing script (%d): %s\n", filename, lstatus, lua_tostring(L, -1)); sid.state = SCRIPT_SYNTAX_ERROR; } } else { luaDisable(); return SCRIPT_PANIC; } UNPROTECT_LUA(); if (sid.state != SCRIPT_OK) { luaFree(L, sid); } luaDoGc(L); return sid.state; } bool luaLoadMixScript(uint8_t index) { ScriptData & sd = g_model.scriptsData[index]; if (ZEXIST(sd.file)) { ScriptInternalData & sid = scriptInternalData[luaScriptsCount++]; ScriptInputsOutputs * sio = &scriptInputsOutputs[index]; sid.reference = SCRIPT_MIX_FIRST+index; sid.state = SCRIPT_NOFILE; char filename[sizeof(SCRIPTS_MIXES_PATH)+sizeof(sd.file)+sizeof(SCRIPT_EXT)] = SCRIPTS_MIXES_PATH "/"; strncpy(filename+sizeof(SCRIPTS_MIXES_PATH), sd.file, sizeof(sd.file)); filename[sizeof(SCRIPTS_MIXES_PATH)+sizeof(sd.file)] = '\0'; strcat(filename+sizeof(SCRIPTS_MIXES_PATH), SCRIPT_EXT); if (luaLoad(lsScripts, filename, sid, sio) == SCRIPT_PANIC) { return false; } } return true; } bool luaLoadFunctionScript(uint8_t index) { CustomFunctionData & fn = g_model.customFn[index]; if (fn.func == FUNC_PLAY_SCRIPT && ZEXIST(fn.play.name)) { if (luaScriptsCount < MAX_SCRIPTS) { ScriptInternalData & sid = scriptInternalData[luaScriptsCount++]; sid.reference = SCRIPT_FUNC_FIRST+index; sid.state = SCRIPT_NOFILE; char filename[sizeof(SCRIPTS_FUNCS_PATH)+sizeof(fn.play.name)+sizeof(SCRIPT_EXT)] = SCRIPTS_FUNCS_PATH "/"; strncpy(filename+sizeof(SCRIPTS_FUNCS_PATH), fn.play.name, sizeof(fn.play.name)); filename[sizeof(SCRIPTS_FUNCS_PATH)+sizeof(fn.play.name)] = '\0'; strcat(filename+sizeof(SCRIPTS_FUNCS_PATH), SCRIPT_EXT); if (luaLoad(lsScripts, filename, sid) == SCRIPT_PANIC) { return false; } } else { POPUP_WARNING(STR_TOO_MANY_LUA_SCRIPTS); return false; } } return true; } #if defined(PCBTARANIS) bool luaLoadTelemetryScript(uint8_t index) { TelemetryScreenType screenType = TELEMETRY_SCREEN_TYPE(index); if (screenType == TELEMETRY_SCREEN_TYPE_SCRIPT) { TelemetryScriptData & script = g_model.frsky.screens[index].script; if (ZEXIST(script.file)) { if (luaScriptsCount < MAX_SCRIPTS) { ScriptInternalData & sid = scriptInternalData[luaScriptsCount++]; sid.reference = SCRIPT_TELEMETRY_FIRST+index; sid.state = SCRIPT_NOFILE; char filename[sizeof(SCRIPTS_TELEM_PATH)+sizeof(script.file)+sizeof(SCRIPT_EXT)] = SCRIPTS_TELEM_PATH "/"; strncpy(filename+sizeof(SCRIPTS_TELEM_PATH), script.file, sizeof(script.file)); filename[sizeof(SCRIPTS_TELEM_PATH)+sizeof(script.file)] = '\0'; strcat(filename+sizeof(SCRIPTS_TELEM_PATH), SCRIPT_EXT); if (luaLoad(lsScripts, filename, sid) == SCRIPT_PANIC) { return false; } } else { POPUP_WARNING(STR_TOO_MANY_LUA_SCRIPTS); return false; } } } return true; } #endif uint8_t isTelemetryScriptAvailable(uint8_t index) { for (int i=0; i 100) { TRACE("Script killed"); standaloneScript.state = SCRIPT_KILLED; luaState = INTERPRETER_RELOAD_PERMANENT_SCRIPTS; } else if (lua_isstring(lsScripts, -1)) { char nextScript[_MAX_LFN+1]; strncpy(nextScript, lua_tostring(lsScripts, -1), _MAX_LFN); nextScript[_MAX_LFN] = '\0'; luaExec(nextScript); } else { TRACE("Script run function returned unexpected value"); standaloneScript.state = SCRIPT_SYNTAX_ERROR; luaState = INTERPRETER_RELOAD_PERMANENT_SCRIPTS; } } else { int scriptResult = lua_tointeger(lsScripts, -1); lua_pop(lsScripts, 1); /* pop returned value */ if (scriptResult != 0) { TRACE("Script finished with status %d", scriptResult); standaloneScript.state = SCRIPT_NOFILE; luaState = INTERPRETER_RELOAD_PERMANENT_SCRIPTS; return; } else if (luaDisplayStatistics) { #if defined(COLORLCD) #else lcdDrawSolidHorizontalLine(0, 7*FH-1, lcdLastPos+6, ERASE); lcdDrawText(0, 7*FH, "GV Use: "); lcdDrawNumber(lcdLastPos, 7*FH, luaGetMemUsed(lsScripts), LEFT); lcdDrawChar(lcdLastPos, 7*FH, 'b'); lcdDrawSolidHorizontalLine(0, 7*FH-2, lcdLastPos+6, FORCE); lcdDrawVerticalLine(lcdLastPos+6, 7*FH-2, FH+2, SOLID, FORCE); #endif } } } else { TRACE("Script error: %s", lua_tostring(lsScripts, -1)); standaloneScript.state = (instructionsPercent > 100 ? SCRIPT_KILLED : SCRIPT_SYNTAX_ERROR); luaState = INTERPRETER_RELOAD_PERMANENT_SCRIPTS; } if (standaloneScript.state != SCRIPT_OK) { luaError(lsScripts, standaloneScript.state); luaState = INTERPRETER_RELOAD_PERMANENT_SCRIPTS; } if (evt == EVT_KEY_LONG(KEY_EXIT)) { TRACE("Script force exit"); killEvents(evt); standaloneScript.state = SCRIPT_NOFILE; luaState = INTERPRETER_RELOAD_PERMANENT_SCRIPTS; } #if !defined(PCBHORUS) // TODO find another key and add a #define else if (evt == EVT_KEY_LONG(KEY_MENU)) { killEvents(evt); luaDisplayStatistics = !luaDisplayStatistics; } #endif } else { TRACE("Script run method missing"); standaloneScript.state = SCRIPT_SYNTAX_ERROR; luaState = INTERPRETER_RELOAD_PERMANENT_SCRIPTS; } } bool luaDoOneRunPermanentScript(event_t evt, int i, uint32_t scriptType) { ScriptInternalData & sid = scriptInternalData[i]; if (sid.state != SCRIPT_OK) return false; luaSetInstructionsLimit(lsScripts, PERMANENT_SCRIPTS_MAX_INSTRUCTIONS); int inputsCount = 0; #if defined(SIMU) || defined(DEBUG) const char *filename; #endif ScriptInputsOutputs * sio = NULL; #if SCRIPT_MIX_FIRST > 0 if ((scriptType & RUN_MIX_SCRIPT) && (sid.reference >= SCRIPT_MIX_FIRST && sid.reference <= SCRIPT_MIX_LAST)) { #else if ((scriptType & RUN_MIX_SCRIPT) && (sid.reference <= SCRIPT_MIX_LAST)) { #endif ScriptData & sd = g_model.scriptsData[sid.reference-SCRIPT_MIX_FIRST]; sio = &scriptInputsOutputs[sid.reference-SCRIPT_MIX_FIRST]; inputsCount = sio->inputsCount; #if defined(SIMU) || defined(DEBUG) filename = sd.file; #endif lua_rawgeti(lsScripts, LUA_REGISTRYINDEX, sid.run); for (int j=0; jinputsCount; j++) { if (sio->inputs[j].type == 1) luaGetValueAndPush(lsScripts, (uint8_t)sd.inputs[j]); else lua_pushinteger(lsScripts, sd.inputs[j] + sio->inputs[j].def); } } else if ((scriptType & RUN_FUNC_SCRIPT) && (sid.reference >= SCRIPT_FUNC_FIRST && sid.reference <= SCRIPT_FUNC_LAST)) { CustomFunctionData & fn = g_model.customFn[sid.reference-SCRIPT_FUNC_FIRST]; #if defined(SIMU) || defined(DEBUG) filename = fn.play.name; #endif if (getSwitch(fn.swtch)) lua_rawgeti(lsScripts, LUA_REGISTRYINDEX, sid.run); else if (sid.background) lua_rawgeti(lsScripts, LUA_REGISTRYINDEX, sid.background); else return false; } else { #if defined(PCBTARANIS) #if defined(SIMU) || defined(DEBUG) TelemetryScriptData & script = g_model.frsky.screens[sid.reference-SCRIPT_TELEMETRY_FIRST].script; filename = script.file; #endif if ((scriptType & RUN_TELEM_FG_SCRIPT) && (menuHandlers[0]==menuViewTelemetryFrsky && sid.reference==SCRIPT_TELEMETRY_FIRST+s_frsky_view)) { lua_rawgeti(lsScripts, LUA_REGISTRYINDEX, sid.run); lua_pushunsigned(lsScripts, evt); inputsCount = 1; } else if ((scriptType & RUN_TELEM_BG_SCRIPT) && (sid.background)) { lua_rawgeti(lsScripts, LUA_REGISTRYINDEX, sid.background); } else { return false; } #else return false; #endif } if (lua_pcall(lsScripts, inputsCount, sio ? sio->outputsCount : 0, 0) == 0) { if (sio) { for (int j=sio->outputsCount-1; j>=0; j--) { if (!lua_isnumber(lsScripts, -1)) { sid.state = (instructionsPercent > 100 ? SCRIPT_KILLED : SCRIPT_SYNTAX_ERROR); TRACE("Script %8s disabled", filename); break; } sio->outputs[j].value = lua_tointeger(lsScripts, -1); lua_pop(lsScripts, 1); } } } else { if (instructionsPercent > 100) { TRACE("Script %8s killed", filename); sid.state = SCRIPT_KILLED; } else { TRACE("Script %8s error: %s", filename, lua_tostring(lsScripts, -1)); sid.state = SCRIPT_SYNTAX_ERROR; } } if (sid.state != SCRIPT_OK) { luaFree(lsScripts, sid); } else { if (instructionsPercent > sid.instructions) { sid.instructions = instructionsPercent; } } return true; } bool luaTask(event_t evt, uint8_t scriptType, bool allowLcdUsage) { if (luaState == INTERPRETER_PANIC) return false; luaLcdAllowed = allowLcdUsage; bool scriptWasRun = false; // we run either standalone script or permanent scripts if (luaState & INTERPRETER_RUNNING_STANDALONE_SCRIPT) { // run standalone script if ((scriptType & RUN_STNDAL_SCRIPT) == 0) return false; PROTECT_LUA() { luaDoOneRunStandalone(evt); scriptWasRun = true; } else { luaDisable(); return false; } UNPROTECT_LUA(); } else { // run permanent scripts if (luaState & INTERPRETER_RELOAD_PERMANENT_SCRIPTS) { luaState = 0; luaInit(); if (luaState == INTERPRETER_PANIC) return false; luaLoadPermanentScripts(); if (luaState == INTERPRETER_PANIC) return false; } for (int i=0; i