-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request ceph#42779 from Matan-B/lua-rgw-map
rgw: Lua scripting global map feature Reviwed-by: dang, cbodley, yuvalif, anthonyeleven, tchaikov, mattbenjamin, batrick
- Loading branch information
Showing
19 changed files
with
679 additions
and
128 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,6 +15,7 @@ namespace rgw::lua { | |
| enum class context { | ||
| preRequest, | ||
| postRequest, | ||
| background, | ||
| none | ||
| }; | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| #include "rgw_lua_background.h" | ||
| #include "rgw_lua.h" | ||
| #include "rgw_lua_utils.h" | ||
| #include "rgw_perf_counters.h" | ||
| #include "include/ceph_assert.h" | ||
| #include <lua.hpp> | ||
|
|
||
| #define dout_subsys ceph_subsys_rgw | ||
|
|
||
| namespace rgw::lua { | ||
|
|
||
| Background::Background(rgw::sal::Store* store, | ||
| CephContext* cct, | ||
| const std::string& luarocks_path, | ||
| int execute_interval) : | ||
| execute_interval(execute_interval), | ||
| dp(cct, dout_subsys, "lua background: "), | ||
| store(store), | ||
| cct(cct), | ||
| luarocks_path(luarocks_path) {} | ||
|
|
||
| void Background::shutdown(){ | ||
| stopped = true; | ||
| cond.notify_all(); | ||
| if (runner.joinable()) { | ||
| runner.join(); | ||
| } | ||
| started = false; | ||
| stopped = false; | ||
| } | ||
|
|
||
| void Background::start() { | ||
| if (started) { | ||
| // start the thread only once | ||
| return; | ||
| } | ||
| started = true; | ||
| runner = std::thread(&Background::run, this); | ||
| const auto rc = ceph_pthread_setname(runner.native_handle(), | ||
| "lua_background"); | ||
| ceph_assert(rc == 0); | ||
| } | ||
|
|
||
| void Background::pause() { | ||
| { | ||
| std::unique_lock cond_lock(pause_mutex); | ||
| paused = true; | ||
| } | ||
| cond.notify_all(); | ||
| } | ||
|
|
||
| void Background::resume(rgw::sal::Store* _store) { | ||
| store = _store; | ||
| paused = false; | ||
| cond.notify_all(); | ||
| } | ||
|
|
||
| int Background::read_script() { | ||
| std::unique_lock cond_lock(pause_mutex); | ||
| if (paused) { | ||
| return -EAGAIN; | ||
| } | ||
| std::string tenant; | ||
| return rgw::lua::read_script(&dp, store, tenant, null_yield, rgw::lua::context::background, rgw_script); | ||
| } | ||
|
|
||
| const std::string Background::empty_table_value; | ||
|
|
||
| const std::string& Background::get_table_value(const std::string& key) const { | ||
| std::unique_lock cond_lock(table_mutex); | ||
| const auto it = rgw_map.find(key); | ||
| if (it == rgw_map.end()) { | ||
| return empty_table_value; | ||
| } | ||
| return it->second; | ||
| } | ||
|
|
||
| void Background::put_table_value(const std::string& key, const std::string& value) { | ||
| std::unique_lock cond_lock(table_mutex); | ||
| rgw_map[key] = value; | ||
| } | ||
|
|
||
| //(1) Loads the script from the object if not paused | ||
| //(2) Executes the script | ||
| //(3) Sleep (configurable) | ||
| void Background::run() { | ||
| lua_State* const L = luaL_newstate(); | ||
| rgw::lua::lua_state_guard lguard(L); | ||
| open_standard_libs(L); | ||
| set_package_path(L, luarocks_path); | ||
| create_debug_action(L, cct); | ||
| create_background_metatable(L); | ||
| const DoutPrefixProvider* const dpp = &dp; | ||
|
|
||
| while (!stopped) { | ||
| if (paused) { | ||
| ldpp_dout(dpp, 10) << "Lua background thread paused" << dendl; | ||
| std::unique_lock cond_lock(cond_mutex); | ||
| cond.wait(cond_lock, [this]{return !paused || stopped;}); | ||
| if (stopped) { | ||
| ldpp_dout(dpp, 10) << "Lua background thread stopped" << dendl; | ||
| return; | ||
| } | ||
| ldpp_dout(dpp, 10) << "Lua background thread resumed" << dendl; | ||
| } | ||
| const auto rc = read_script(); | ||
| if (rc == -ENOENT || rc == -EAGAIN) { | ||
| // either no script or paused, nothing to do | ||
| } else if (rc < 0) { | ||
| ldpp_dout(dpp, 1) << "WARNING: failed to read background script. error " << rc << dendl; | ||
| } else { | ||
| auto failed = false; | ||
| try { | ||
| //execute the background lua script | ||
| if (luaL_dostring(L, rgw_script.c_str()) != LUA_OK) { | ||
| const std::string err(lua_tostring(L, -1)); | ||
| ldpp_dout(dpp, 1) << "Lua ERROR: " << err << dendl; | ||
| failed = true; | ||
| } | ||
| } catch (const std::exception& e) { | ||
| ldpp_dout(dpp, 1) << "Lua ERROR: " << e.what() << dendl; | ||
| failed = true; | ||
| } | ||
| if (perfcounter) { | ||
| perfcounter->inc((failed ? l_rgw_lua_script_fail : l_rgw_lua_script_ok), 1); | ||
| } | ||
| } | ||
| std::unique_lock cond_lock(cond_mutex); | ||
| cond.wait_for(cond_lock, std::chrono::seconds(execute_interval), [this]{return stopped;}); | ||
| } | ||
| ldpp_dout(dpp, 10) << "Lua background thread stopped" << dendl; | ||
| } | ||
|
|
||
| void Background::create_background_metatable(lua_State* L) { | ||
| create_metatable<rgw::lua::RGWTable>(L, true, &rgw_map, &table_mutex); | ||
| } | ||
|
|
||
| } //namespace lua | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| #pragma once | ||
| #include "common/dout.h" | ||
| #include "rgw_common.h" | ||
| #include <string> | ||
| #include "rgw_lua_utils.h" | ||
| #include "rgw_realm_reloader.h" | ||
|
|
||
| namespace rgw::lua { | ||
|
|
||
| //Interval between each execution of the script is set to 5 seconds | ||
| constexpr const int INIT_EXECUTE_INTERVAL = 5; | ||
|
|
||
| //Writeable meta table named RGW with mutex protection | ||
| using BackgroundMap = std::unordered_map<std::string, std::string>; | ||
| struct RGWTable : StringMapMetaTable<BackgroundMap, | ||
| StringMapWriteableNewIndex<BackgroundMap>> { | ||
| static std::string TableName() {return "RGW";} | ||
| static std::string Name() {return TableName() + "Meta";} | ||
| static int IndexClosure(lua_State* L) { | ||
| auto& mtx = *reinterpret_cast<std::mutex*>(lua_touserdata(L, lua_upvalueindex(2))); | ||
| std::lock_guard l(mtx); | ||
| return StringMapMetaTable::IndexClosure(L); | ||
| } | ||
| static int LenClosure(lua_State* L) { | ||
| auto& mtx = *reinterpret_cast<std::mutex*>(lua_touserdata(L, lua_upvalueindex(2))); | ||
| std::lock_guard l(mtx); | ||
| return StringMapMetaTable::LenClosure(L); | ||
| } | ||
| static int NewIndexClosure(lua_State* L) { | ||
| auto& mtx = *reinterpret_cast<std::mutex*>(lua_touserdata(L, lua_upvalueindex(2))); | ||
| std::lock_guard l(mtx); | ||
| return StringMapMetaTable::NewIndexClosure(L); | ||
| } | ||
| }; | ||
|
|
||
| class Background : public RGWRealmReloader::Pauser { | ||
|
|
||
| private: | ||
| BackgroundMap rgw_map; | ||
| bool stopped = false; | ||
| bool started = false; | ||
| bool paused = false; | ||
| int execute_interval; | ||
| const DoutPrefix dp; | ||
| rgw::sal::Store* store; | ||
| CephContext* const cct; | ||
| const std::string luarocks_path; | ||
| std::thread runner; | ||
| mutable std::mutex table_mutex; | ||
| std::mutex cond_mutex; | ||
| std::mutex pause_mutex; | ||
| std::condition_variable cond; | ||
| static const std::string empty_table_value; | ||
|
|
||
| void run(); | ||
|
|
||
| protected: | ||
| std::string rgw_script; | ||
| virtual int read_script(); | ||
|
|
||
| public: | ||
| Background(rgw::sal::Store* store, | ||
| CephContext* cct, | ||
| const std::string& luarocks_path, | ||
| int execute_interval = INIT_EXECUTE_INTERVAL); | ||
|
|
||
| virtual ~Background() = default; | ||
| void start(); | ||
| void shutdown(); | ||
| void create_background_metatable(lua_State* L); | ||
| const std::string& get_table_value(const std::string& key) const; | ||
| void put_table_value(const std::string& key, const std::string& value); | ||
|
|
||
| void pause() override; | ||
| void resume(rgw::sal::Store* _store) override; | ||
| }; | ||
|
|
||
| } //namepsace lua | ||
|
|
Oops, something went wrong.