/* Copyright (c) 2013 Microsoft Corporation. All rights reserved. Released under Apache 2.0 license as described in the file LICENSE. Author: Leonardo de Moura */ #include #include #include #include #include #include #include "util/debug.h" #include "util/exception.h" #include "util/memory.h" #include "util/buffer.h" #include "util/interrupt.h" #include "library/state.h" #include "bindings/lua/leanlua_state.h" #include "bindings/lua/util.h" #include "bindings/lua/name.h" #include "bindings/lua/splay_map.h" #include "bindings/lua/numerics.h" #include "bindings/lua/options.h" #include "bindings/lua/sexpr.h" #include "bindings/lua/format.h" #include "bindings/lua/formatter.h" #include "bindings/lua/level.h" #include "bindings/lua/local_context.h" #include "bindings/lua/expr.h" #include "bindings/lua/context.h" #include "bindings/lua/object.h" #include "bindings/lua/environment.h" #include "bindings/lua/justification.h" #include "bindings/lua/metavar_env.h" #include "bindings/lua/state.h" #include "bindings/lua/type_inferer.h" #include "bindings/lua/frontend_lean.h" #include "bindings/lua/lean.lua" extern "C" void * lua_realloc(void *, void * q, size_t, size_t new_size) { return lean::realloc(q, new_size); } namespace lean { static void open_patch(lua_State * L); static void open_state(lua_State * L); static void open_thread(lua_State * L); static void open_interrupt(lua_State * L); environment & to_environment(lua_State * L, int idx); static int writer(lua_State *, void const * p, size_t sz, void * buf) { buffer & _buf = *static_cast*>(buf); char const * in = static_cast(p); for (size_t i = 0; i < sz; i++) _buf.push_back(in[i]); return 0; } struct reader_data { buffer & m_buffer; bool m_done; reader_data(buffer & b):m_buffer(b), m_done(false) {} }; static char const * reader(lua_State *, void * data, size_t * sz) { reader_data & _data = *static_cast(data); if (_data.m_done) { *sz = 0; return nullptr; } else { *sz = _data.m_buffer.size(); _data.m_done = true; return _data.m_buffer.data(); } } static void copy_values(lua_State * src, int first, int last, lua_State * tgt) { for (int i = first; i <= last; i++) { switch (lua_type(src, i)) { case LUA_TNUMBER: lua_pushnumber(tgt, lua_tonumber(src, i)); break; case LUA_TSTRING: lua_pushstring(tgt, lua_tostring(src, i)); break; case LUA_TNIL: lua_pushnil(tgt); break; case LUA_TBOOLEAN: lua_pushboolean(tgt, lua_toboolean(src, i)); break; case LUA_TFUNCTION: { lua_pushvalue(src, i); // copy function to the top of the stack buffer buffer; if (lua_dump(src, writer, &buffer) != 0) throw exception("falied to copy function between State objects"); lua_pop(src, 1); // remove function from the top of the stack reader_data data(buffer); if (load(tgt, reader, &data, "temporary buffer for moving functions between states") != 0) throw exception("falied to copy function between State objects"); // copy upvalues int j = 1; while (true) { char const * name = lua_getupvalue(src, i, j); if (name == nullptr) break; copy_values(src, lua_gettop(src), lua_gettop(src), tgt); // copy upvalue to tgt stack lua_pop(src, 1); // remove upvalue from src stack lua_setupvalue(tgt, -2, j); j++; } break; } case LUA_TUSERDATA: if (is_expr(src, i)) { push_expr(tgt, to_expr(src, i)); } else if (is_context(src, i)) { push_context(tgt, to_context(src, i)); } else if (is_environment(src, i)) { push_environment(tgt, to_environment(src, i)); } else if (is_name(src, i)) { push_name(tgt, to_name(src, i)); } else if (is_mpz(src, i)) { push_mpz(tgt, to_mpz(src, i)); } else if (is_mpq(src, i)) { push_mpq(tgt, to_mpq(src, i)); } else if (is_options(src, i)) { push_options(tgt, to_options(src, i)); } else if (is_sexpr(src, i)) { push_sexpr(tgt, to_sexpr(src, i)); } else if (is_format(src, i)) { push_format(tgt, to_format(src, i)); } else if (is_context_entry(src, i)) { push_context_entry(tgt, to_context_entry(src, i)); } else if (is_local_context(src, i)) { push_local_context(tgt, to_local_context(src, i)); } else if (is_local_entry(src, i)) { push_local_entry(tgt, to_local_entry(src, i)); } else { throw exception("unsupported value type for inter-State call"); } break; default: throw exception("unsupported value type for inter-State call"); } } } static char g_weak_ptr_key; // key for Lua registry (used at get_weak_ptr and save_weak_ptr) struct leanlua_state::imp { lua_State * m_state; std::recursive_mutex m_mutex; static std::weak_ptr * get_weak_ptr(lua_State * L) { lua_pushlightuserdata(L, static_cast(&g_weak_ptr_key)); lua_gettable(L, LUA_REGISTRYINDEX); std::weak_ptr * ptr = static_cast*>(lua_touserdata(L, -1)); lua_pop(L, 1); return ptr; } void save_weak_ptr(std::shared_ptr & ptr) { lua_pushlightuserdata(m_state, static_cast(&g_weak_ptr_key)); void * mem = lua_newuserdata(m_state, sizeof(std::weak_ptr)); new (mem) std::weak_ptr(ptr); lua_settable(m_state, LUA_REGISTRYINDEX); } imp() { // TODO(Leo) investigate why TCMALLOC + lua_realloc do not work together // #ifdef LEAN_USE_LUA_NEWSTATE #if 0 m_state = lua_newstate(lua_realloc, nullptr); #else m_state = luaL_newstate(); #endif if (m_state == nullptr) throw exception("fail to create Lua interpreter"); luaL_openlibs(m_state); open_patch(m_state); open_name(m_state); open_splay_map(m_state); open_mpz(m_state); open_mpq(m_state); open_options(m_state); open_sexpr(m_state); open_format(m_state); open_formatter(m_state); open_level(m_state); open_local_context(m_state); open_expr(m_state); open_context(m_state); open_object(m_state); open_environment(m_state); open_justification(m_state); open_metavar_env(m_state); open_state(m_state); open_type_inferer(m_state); open_frontend_lean(m_state); open_thread(m_state); open_interrupt(m_state); dostring(g_leanlua_extra); } ~imp() { typedef std::weak_ptr wptr; wptr * ptr = get_weak_ptr(m_state); ptr->~wptr(); // destruct weak pointer lua_close(m_state); } void dofile(char const * fname) { std::lock_guard lock(m_mutex); ::lean::dofile(m_state, fname); } void dostring(char const * str) { std::lock_guard lock(m_mutex); ::lean::dostring(m_state, str); } void dostring(char const * str, environment & env, state & st) { set_state set1(m_state, st); set_environment set2(m_state, env); dostring(str); } }; leanlua_state to_leanlua_state(lua_State * L) { return leanlua_state(*leanlua_state::imp::get_weak_ptr(L)); } leanlua_state::leanlua_state(): m_ptr(new imp()) { m_ptr->save_weak_ptr(m_ptr); } leanlua_state::leanlua_state(std::weak_ptr const & ptr):m_ptr(ptr.lock()) { lean_assert(m_ptr); } leanlua_state::~leanlua_state() { } void leanlua_state::dofile(char const * fname) { m_ptr->dofile(fname); } void leanlua_state::dostring(char const * str) { m_ptr->dostring(str); } void leanlua_state::dostring(char const * str, environment & env, state & st) { m_ptr->dostring(str, env, st); } static std::mutex g_print_mutex; /** \brief Thread safe version of print function */ static int print(lua_State * L) { state * S = get_state(L); int n = lua_gettop(L); int i; lua_getglobal(L, "tostring"); std::lock_guard lock(g_print_mutex); for (i = 1; i <= n; i++) { char const * s; size_t l; lua_pushvalue(L, -1); lua_pushvalue(L, i); lua_call(L, 1, 1); s = lua_tolstring(L, -1, &l); if (s == NULL) throw exception("'to_string' must return a string to 'print'"); if (i > 1) { if (S) regular(*S) << "\t"; else std::cout << "\t"; } if (S) regular(*S) << s; else std::cout << s; lua_pop(L, 1); } if (S) regular(*S) << endl; else std::cout << std::endl; return 0; } /** \brief Redefine some functions from the Lua library */ static void open_patch(lua_State * L) { SET_GLOBAL_FUN(print, "print"); } constexpr char const * state_mt = "luastate.mt"; bool is_state(lua_State * L, int idx) { return testudata(L, idx, state_mt); } leanlua_state & to_state(lua_State * L, int idx) { return *static_cast(luaL_checkudata(L, idx, state_mt)); } int push_state(lua_State * L, leanlua_state const & s) { void * mem = lua_newuserdata(L, sizeof(leanlua_state)); new (mem) leanlua_state(s); luaL_getmetatable(L, state_mt); lua_setmetatable(L, -2); return 1; } static int mk_state(lua_State * L) { leanlua_state r; return push_state(L, r); } static int state_gc(lua_State * L) { to_state(L, 1).~leanlua_state(); return 0; } int state_dostring(lua_State * L) { auto S = to_state(L, 1).m_ptr; char const * script = luaL_checkstring(L, 2); int first = 3; int last = lua_gettop(L); std::lock_guard lock(S->m_mutex); int sz_before = lua_gettop(S->m_state); int result = luaL_loadstring(S->m_state, script); if (result) throw lua_exception(lua_tostring(S->m_state, -1)); copy_values(L, first, last, S->m_state); pcall(S->m_state, first > last ? 0 : last - first + 1, LUA_MULTRET, 0); int sz_after = lua_gettop(S->m_state); if (sz_after > sz_before) { copy_values(S->m_state, sz_before + 1, sz_after, L); lua_pop(S->m_state, sz_after - sz_before); } return sz_after - sz_before; } int state_set_global(lua_State * L) { auto S = to_state(L, 1).m_ptr; char const * name = luaL_checkstring(L, 2); std::lock_guard lock(S->m_mutex); copy_values(L, 3, 3, S->m_state); lua_setglobal(S->m_state, name); return 0; } static int state_pred(lua_State * L) { lua_pushboolean(L, is_state(L, 1)); return 1; } static const struct luaL_Reg state_m[] = { {"__gc", state_gc}, {"dostring", safe_function}, {"eval", safe_function}, {"set", safe_function}, {0, 0} }; static void open_state(lua_State * L) { luaL_newmetatable(L, state_mt); lua_pushvalue(L, -1); lua_setfield(L, -2, "__index"); setfuncs(L, state_m, 0); SET_GLOBAL_FUN(mk_state, "State"); SET_GLOBAL_FUN(state_pred, "is_State"); } // TODO(Leo): allow the user to change it? #define SMALL_DELAY 10 // in ms std::chrono::milliseconds g_small_delay(SMALL_DELAY); /** \brief Channel for communicating with thread objects in the Lua API */ class data_channel { // We use a lua_State to implement the channel. This is quite hackish, // but it is a convenient storage for Lua objects sent from one state to // another. leanlua_state m_channel; int m_ini; std::mutex m_mutex; std::condition_variable m_cv; public: data_channel() { lua_State * channel = m_channel.m_ptr->m_state; m_ini = lua_gettop(channel); } /** \brief Copy elements from positions [first, last] from src stack to the channel. */ void write(lua_State * src, int first, int last) { // write the object on the top of the stack of src to the table // on m_channel. if (last < first) return; std::lock_guard lock(m_mutex); lua_State * channel = m_channel.m_ptr->m_state; bool was_empty = lua_gettop(channel) == m_ini; copy_values(src, first, last, channel); if (was_empty) m_cv.notify_one(); } /** \brief Retrieve one element from the channel. It will block the execution of \c tgt if the channel is empty. */ int read(lua_State * tgt, int i) { std::unique_lock lock(m_mutex); lua_State * channel = m_channel.m_ptr->m_state; if (i > 0) { // i is the position of the timeout argument std::chrono::milliseconds dura(luaL_checkinteger(tgt, i)); if (lua_gettop(channel) == m_ini) m_cv.wait_for(lock, dura); if (lua_gettop(channel) == m_ini) { // timeout... lua_pushboolean(tgt, false); lua_pushnil(tgt); return 2; } else { lua_pushboolean(tgt, true); copy_values(channel, m_ini + 1, m_ini + 1, tgt); lua_remove(channel, m_ini + 1); return 2; } } else { while (lua_gettop(channel) == m_ini) { check_interrupted(); m_cv.wait_for(lock, g_small_delay); } copy_values(channel, m_ini + 1, m_ini + 1, tgt); lua_remove(channel, m_ini + 1); return 1; } } }; /** \brief We want the channels to be lazily created. */ class data_channel_ref { std::unique_ptr m_channel; std::mutex m_mutex; public: data_channel & get() { std::lock_guard lock(m_mutex); if (!m_channel) m_channel.reset(new data_channel()); lean_assert(m_channel); return *m_channel; } }; data_channel_ref g_in_channel; data_channel_ref g_out_channel; int channel_read(lua_State * L) { return g_in_channel.get().read(L, lua_gettop(L)); } int channel_write(lua_State * L) { g_out_channel.get().write(L, 1, lua_gettop(L)); return 0; } class leanlua_thread { leanlua_state m_state; int m_sz_before; bool m_error; std::string m_error_msg; std::atomic m_in_channel_addr; std::atomic m_out_channel_addr; interruptible_thread m_thread; public: leanlua_thread(leanlua_state const & st, int sz_before, int num_args): m_state(st), m_sz_before(sz_before), m_error(false), m_in_channel_addr(0), m_out_channel_addr(0), m_thread([=]() { m_in_channel_addr.store(&g_in_channel); m_out_channel_addr.store(&g_out_channel); auto S = m_state.m_ptr; std::lock_guard lock(S->m_mutex); int result = lua_pcall(S->m_state, num_args, LUA_MULTRET, 0); if (result) { m_error = true; m_error_msg = lua_tostring(S->m_state, -1); return; } }) { } ~leanlua_thread() { if (m_thread.joinable()) m_thread.join(); } int wait(lua_State * src) { m_thread.join(); if (m_error) throw lua_exception(m_error_msg.c_str()); auto S = m_state.m_ptr; int sz_after = lua_gettop(S->m_state); if (sz_after > m_sz_before) { copy_values(S->m_state, m_sz_before + 1, sz_after, src); lua_pop(S->m_state, sz_after - m_sz_before); } return sz_after - m_sz_before; } void request_interrupt() { while (!m_thread.request_interrupt()) { check_interrupted(); std::this_thread::sleep_for(g_small_delay); } } void write(lua_State * src, int first, int last) { while (!m_in_channel_addr) { check_interrupted(); std::this_thread::sleep_for(g_small_delay); } data_channel & in = m_in_channel_addr.load()->get(); in.write(src, first, last); } int read(lua_State * src) { if (!m_out_channel_addr) { check_interrupted(); std::this_thread::sleep_for(g_small_delay); } data_channel & out = m_out_channel_addr.load()->get(); int nargs = lua_gettop(src); return out.read(src, nargs == 1 ? 0 : 2); } bool started() { return m_in_channel_addr && m_out_channel_addr; } }; constexpr char const * thread_mt = "thread.mt"; bool is_thread(lua_State * L, int idx) { return testudata(L, idx, thread_mt); } leanlua_thread & to_thread(lua_State * L, int idx) { return *static_cast(luaL_checkudata(L, idx, thread_mt)); } int mk_thread(lua_State * L) { check_threadsafe(); leanlua_state & st = to_state(L, 1); char const * script = luaL_checkstring(L, 2); int first = 3; int last = lua_gettop(L); int nargs = first > last ? 0 : last - first + 1; int sz_before; auto S = st.m_ptr; { std::lock_guard lock(S->m_mutex); sz_before = lua_gettop(S->m_state); int result = luaL_loadstring(S->m_state, script); if (result) throw lua_exception(lua_tostring(S->m_state, -1)); copy_values(L, first, last, S->m_state); } void * mem = lua_newuserdata(L, sizeof(leanlua_thread)); new (mem) leanlua_thread(st, sz_before, nargs); luaL_getmetatable(L, thread_mt); lua_setmetatable(L, -2); return 1; } static int thread_gc(lua_State * L) { to_thread(L, 1).~leanlua_thread(); return 0; } static int thread_pred(lua_State * L) { lua_pushboolean(L, is_thread(L, 1)); return 1; } static int thread_write(lua_State * L) { to_thread(L, 1).write(L, 2, lua_gettop(L)); return 0; } static int thread_read(lua_State * L) { return to_thread(L, 1).read(L); } static int thread_interrupt(lua_State * L) { to_thread(L, 1).request_interrupt(); return 0; } int thread_wait(lua_State * L) { return to_thread(L, 1).wait(L); } static const struct luaL_Reg thread_m[] = { {"__gc", thread_gc}, {"wait", safe_function}, {"interrupt", safe_function}, {"write", safe_function}, {"read", safe_function}, {0, 0} }; static void open_thread(lua_State * L) { luaL_newmetatable(L, thread_mt); lua_pushvalue(L, -1); lua_setfield(L, -2, "__index"); setfuncs(L, thread_m, 0); SET_GLOBAL_FUN(mk_thread, "thread"); SET_GLOBAL_FUN(thread_pred, "is_thread"); } static int check_interrupted(lua_State *) { // NOLINT check_interrupted(); return 0; } static int sleep(lua_State * L) { std::chrono::milliseconds dura(luaL_checkinteger(L, 1)); std::this_thread::sleep_for(dura); return 0; } static void open_interrupt(lua_State * L) { SET_GLOBAL_FUN(check_interrupted, "check_interrupted"); SET_GLOBAL_FUN(sleep, "sleep"); SET_GLOBAL_FUN(channel_read, "read"); SET_GLOBAL_FUN(channel_write, "write"); } }