Handle LuaErrors in Lua -> C++ calls on LuaJIT

minetest · Dec 18, 2013 · 49cec3f · 49cec3f
1 parent 38d1120
commit 49cec3f
Show file tree

Hide file tree

Showing 18 changed files with 113 additions and 134 deletions.
diff --git a/src/cmake_config.h.in b/src/cmake_config.h.in
@@ -12,6 +12,7 @@
 #define CMAKE_USE_FREETYPE @USE_FREETYPE@
 #define CMAKE_STATIC_SHAREDIR "@SHAREDIR@"
 #define CMAKE_USE_LEVELDB @USE_LEVELDB@
+#define CMAKE_USE_LUAJIT @USE_LUAJIT@
 
 #ifdef NDEBUG
 	#define CMAKE_BUILD_TYPE "Release"

diff --git a/src/config.h b/src/config.h
@@ -14,6 +14,7 @@
 #define USE_FREETYPE 0
 #define STATIC_SHAREDIR ""
 #define USE_LEVELDB 0
+#define USE_LUAJIT 0
 
 #ifdef USE_CMAKE_CONFIG_H
 	#include "cmake_config.h"
@@ -33,6 +34,8 @@
 	#define STATIC_SHAREDIR CMAKE_STATIC_SHAREDIR
 	#undef USE_LEVELDB
 	#define USE_LEVELDB CMAKE_USE_LEVELDB
+	#undef USE_LUAJIT
+	#define USE_LUAJIT CMAKE_USE_LUAJIT
 #endif
 
 #endif

diff --git a/src/exceptions.h b/src/exceptions.h
@@ -21,132 +21,99 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #define EXCEPTIONS_HEADER
 
 #include <exception>
+#include <string>
+
 
 class BaseException : public std::exception
 {
 public:
-	BaseException(const char *s)
+	BaseException(const std::string s) throw()
 	{
 		m_s = s;
 	}
+	~BaseException() throw() {}
 	virtual const char * what() const throw()
 	{
-		return m_s;
+		return m_s.c_str();
 	}
-	const char *m_s;
+protected:
+	std::string m_s;
 };
 
-class AsyncQueuedException : public BaseException
-{
+class AsyncQueuedException : public BaseException {
 public:
-	AsyncQueuedException(const char *s):
-		BaseException(s)
-	{}
+	AsyncQueuedException(std::string s): BaseException(s) {}
 };
 
-class NotImplementedException : public BaseException
-{
+class NotImplementedException : public BaseException {
 public:
-	NotImplementedException(const char *s):
-		BaseException(s)
-	{}
+	NotImplementedException(std::string s): BaseException(s) {}
 };
 
-class AlreadyExistsException : public BaseException
-{
+class AlreadyExistsException : public BaseException {
 public:
-	AlreadyExistsException(const char *s):
-		BaseException(s)
-	{}
+	AlreadyExistsException(std::string s): BaseException(s) {}
 };
 
-class VersionMismatchException : public BaseException
-{
+class VersionMismatchException : public BaseException {
 public:
-	VersionMismatchException(const char *s):
-		BaseException(s)
-	{}
+	VersionMismatchException(std::string s): BaseException(s) {}
 };
 
-class FileNotGoodException : public BaseException
-{
+class FileNotGoodException : public BaseException {
 public:
-	FileNotGoodException(const char *s):
-		BaseException(s)
-	{}
+	FileNotGoodException(std::string s): BaseException(s) {}
 };
 
-class SerializationError : public BaseException
-{
+class SerializationError : public BaseException {
 public:
-	SerializationError(const char *s):
-		BaseException(s)
-	{}
+	SerializationError(std::string s): BaseException(s) {}
 };
 
-class LoadError : public BaseException
-{
+class LoadError : public BaseException {
 public:
-	LoadError(const char *s):
-		BaseException(s)
-	{}
+	LoadError(std::string s): BaseException(s) {}
 };
 
-class ContainerFullException : public BaseException
-{
+class ContainerFullException : public BaseException {
 public:
-	ContainerFullException(const char *s):
-		BaseException(s)
-	{}
+	ContainerFullException(std::string s): BaseException(s) {}
 };
 
-class SettingNotFoundException : public BaseException
-{
+class SettingNotFoundException : public BaseException {
 public:
-	SettingNotFoundException(const char *s):
-		BaseException(s)
-	{}
+	SettingNotFoundException(std::string s): BaseException(s) {}
 };
 
-class InvalidFilenameException : public BaseException
-{
+class InvalidFilenameException : public BaseException {
 public:
-	InvalidFilenameException(const char *s):
-		BaseException(s)
-	{}
+	InvalidFilenameException(std::string s): BaseException(s) {}
 };
 
-class ProcessingLimitException : public BaseException
-{
+class ProcessingLimitException : public BaseException {
 public:
-	ProcessingLimitException(const char *s):
-		BaseException(s)
-	{}
+	ProcessingLimitException(std::string s): BaseException(s) {}
 };
 
-class CommandLineError : public BaseException
-{
+class CommandLineError : public BaseException {
 public:
-	CommandLineError(const char *s):
-		BaseException(s)
-	{}
+	CommandLineError(std::string s): BaseException(s) {}
 };
 
-class ItemNotFoundException : public BaseException
-{
+class ItemNotFoundException : public BaseException {
 public:
-	ItemNotFoundException(const char *s):
-		BaseException(s)
-	{}
+	ItemNotFoundException(std::string s): BaseException(s) {}
+};
+
+class ServerError : public BaseException {
+public:
+	ServerError(std::string s): BaseException(s) {}
 };
 
 // Only used on Windows (SEH)
-class FatalSystemException : public BaseException
-{
+class FatalSystemException : public BaseException {
 public:
-	FatalSystemException(const char *s):
-		BaseException(s)
-	{}
+	FatalSystemException(std::string s): BaseException(s) {}
 };
 
 /*
@@ -159,7 +126,7 @@ class InvalidPositionException : public BaseException
 	InvalidPositionException():
 		BaseException("Somebody tried to get/set something in a nonexistent position.")
 	{}
-	InvalidPositionException(const char *s):
+	InvalidPositionException(std::string s):
 		BaseException(s)
 	{}
 };

diff --git a/src/game.cpp b/src/game.cpp
@@ -3438,14 +3438,12 @@ void the_game(
 				L" running a different version of Minetest.";
 		errorstream<<wide_to_narrow(error_message)<<std::endl;
 	}
-	catch(ServerError &e)
-	{
+	catch(ServerError &e) {
 		error_message = narrow_to_wide(e.what());
-		errorstream<<wide_to_narrow(error_message)<<std::endl;
+		errorstream << "ServerError: " << e.what() << std::endl;
 	}
-	catch(ModError &e)
-	{
-		errorstream<<e.what()<<std::endl;
+	catch(ModError &e) {
+		errorstream << "ModError: " << e.what() << std::endl;
 		error_message = narrow_to_wide(e.what()) + wgettext("\nCheck debug.txt for details.");
 	}
 

diff --git a/src/script/common/c_content.cpp b/src/script/common/c_content.cpp
@@ -653,7 +653,7 @@ ItemStack read_item(lua_State* L, int index,Server* srv)
 	}
 	else
 	{
-		throw LuaError(L, "Expecting itemstack, itemstring, table or nil");
+		throw LuaError(NULL, "Expecting itemstack, itemstring, table or nil");
 	}
 }
 

diff --git a/src/script/common/c_internal.cpp b/src/script/common/c_internal.cpp
@@ -55,6 +55,18 @@ int script_error_handler(lua_State *L) {
 	return 1;
 }
 
+int script_exception_wrapper(lua_State *L, lua_CFunction f)
+{
+	try {
+		return f(L);  // Call wrapped function and return result.
+	} catch (const char *s) {  // Catch and convert exceptions.
+		lua_pushstring(L, s);
+	} catch (LuaError& e) {
+		lua_pushstring(L, e.what());
+	}
+	return lua_error(L);  // Rethrow as a Lua error.
+}
+
 void script_error(lua_State *L)
 {
 	const char *s = lua_tostring(L, -1);

diff --git a/src/script/common/c_internal.h b/src/script/common/c_internal.h
@@ -66,6 +66,7 @@ enum RunCallbacksMode
 
 std::string script_get_backtrace(lua_State *L);
 int script_error_handler(lua_State *L);
+int script_exception_wrapper(lua_State *L, lua_CFunction f);
 void script_error(lua_State *L);
 void script_run_callbacks(lua_State *L, int nargs,
 		RunCallbacksMode mode);

diff --git a/src/script/common/c_types.cpp b/src/script/common/c_types.cpp
@@ -23,10 +23,12 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "common/c_internal.h"
 #include "itemdef.h"
 
-LuaError::LuaError(lua_State *L, const std::string &s)
+LuaError::LuaError(lua_State *L, const std::string &s) :
+	ServerError(s)
 {
-	m_s = "LuaError: " + s;
-	if (L) m_s += '\n' + script_get_backtrace(L);
+	if (L) {
+		m_s += '\n' + script_get_backtrace(L);
+	}
 }
 
 struct EnumString es_ItemType[] =

diff --git a/src/script/common/c_types.h b/src/script/common/c_types.h
@@ -26,6 +26,8 @@ extern "C" {
 
 #include <iostream>
 
+#include "exceptions.h"
+
 struct EnumString
 {
 	int num;
@@ -50,7 +52,7 @@ class StackUnroller
 	}
 };
 
-class LuaError : public std::exception
+class LuaError : public ServerError
 {
 public:
 	LuaError(lua_State *L, const std::string &s);
@@ -61,7 +63,6 @@ class LuaError : public std::exception
 	{
 		return m_s.c_str();
 	}
-	std::string m_s;
 };
 
 

diff --git a/src/script/cpp_api/s_base.cpp b/src/script/cpp_api/s_base.cpp
@@ -29,6 +29,9 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 
 extern "C" {
 #include "lualib.h"
+#if USE_LUAJIT
+	#include "luajit.h"
+#endif
 }
 
 #include <stdio.h>
@@ -73,6 +76,14 @@ ScriptApiBase::ScriptApiBase()
 	lua_pushlightuserdata(m_luastack, this);
 	lua_setfield(m_luastack, LUA_REGISTRYINDEX, "scriptapi");
 
+	// If we are using LuaJIT add a C++ wrapper function to catch
+	// exceptions thrown in Lua -> C++ calls
+#if USE_LUAJIT
+	lua_pushlightuserdata(m_luastack, (void*) script_exception_wrapper);
+	luaJIT_setmode(m_luastack, -1, LUAJIT_MODE_WRAPCFUNC | LUAJIT_MODE_ON);
+	lua_pop(m_luastack, 1);
+#endif
+
 	m_server = 0;
 	m_environment = 0;
 	m_guiengine = 0;

diff --git a/src/script/cpp_api/s_inventory.cpp b/src/script/cpp_api/s_inventory.cpp
@@ -54,7 +54,7 @@ int ScriptApiDetached::detached_inventory_AllowMove(
 	if(lua_pcall(L, 7, 1, errorhandler))
 		scriptError();
 	if(!lua_isnumber(L, -1))
-		throw LuaError(L, "allow_move should return a number");
+		throw LuaError(NULL, "allow_move should return a number");
 	int ret = luaL_checkinteger(L, -1);
 	lua_pop(L, 2); // Pop integer and error handler
 	return ret;
@@ -86,7 +86,7 @@ int ScriptApiDetached::detached_inventory_AllowPut(
 	if(lua_pcall(L, 5, 1, errorhandler))
 		scriptError();
 	if(!lua_isnumber(L, -1))
-		throw LuaError(L, "allow_put should return a number");
+		throw LuaError(NULL, "allow_put should return a number");
 	int ret = luaL_checkinteger(L, -1);
 	lua_pop(L, 2); // Pop integer and error handler
 	return ret;
@@ -118,7 +118,7 @@ int ScriptApiDetached::detached_inventory_AllowTake(
 	if(lua_pcall(L, 5, 1, errorhandler))
 		scriptError();
 	if(!lua_isnumber(L, -1))
-		throw LuaError(L, "allow_take should return a number");
+		throw LuaError(NULL, "allow_take should return a number");
 	int ret = luaL_checkinteger(L, -1);
 	lua_pop(L, 2); // Pop integer and error handler
 	return ret;

diff --git a/src/script/cpp_api/s_nodemeta.cpp b/src/script/cpp_api/s_nodemeta.cpp
@@ -61,7 +61,7 @@ int ScriptApiNodemeta::nodemeta_inventory_AllowMove(v3s16 p,
 		scriptError();
 	lua_remove(L, errorhandler); // Remove error handler
 	if(!lua_isnumber(L, -1))
-		throw LuaError(L, "allow_metadata_inventory_move should return a number");
+		throw LuaError(NULL, "allow_metadata_inventory_move should return a number");
 	int num = luaL_checkinteger(L, -1);
 	lua_pop(L, 1); // Pop integer
 	return num;
@@ -99,7 +99,7 @@ int ScriptApiNodemeta::nodemeta_inventory_AllowPut(v3s16 p,
 		scriptError();
 	lua_remove(L, errorhandler); // Remove error handler
 	if(!lua_isnumber(L, -1))
-		throw LuaError(L, "allow_metadata_inventory_put should return a number");
+		throw LuaError(NULL, "allow_metadata_inventory_put should return a number");
 	int num = luaL_checkinteger(L, -1);
 	lua_pop(L, 1); // Pop integer
 	return num;
@@ -137,7 +137,7 @@ int ScriptApiNodemeta::nodemeta_inventory_AllowTake(v3s16 p,
 		scriptError();
 	lua_remove(L, errorhandler); // Remove error handler
 	if(!lua_isnumber(L, -1))
-		throw LuaError(L, "allow_metadata_inventory_take should return a number");
+		throw LuaError(NULL, "allow_metadata_inventory_take should return a number");
 	int num = luaL_checkinteger(L, -1);
 	lua_pop(L, 1); // Pop integer
 	return num;