forked from facebook/rocksdb
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce Lua Extension: RocksLuaCompactionFilter
Summary: This diff includes an implementation of CompactionFilter that allows users to write CompactionFilter in Lua. With this ability, users can dynamically change compaction filter logic without requiring building the rocksdb binary and restarting the database. To compile, WITH_LUA_PATH must be specified to the base directory of lua. Closes facebook#1478 Differential Revision: D4150138 Pulled By: yhchiang fbshipit-source-id: ed84222
- Loading branch information
Showing
14 changed files
with
1,077 additions
and
2 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
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
187 changes: 187 additions & 0 deletions
187
include/rocksdb/utilities/lua/rocks_lua_compaction_filter.h
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,187 @@ | ||
| // Copyright (c) 2016, Facebook, Inc. All rights reserved. | ||
| // This source code is licensed under the BSD-style license found in the | ||
| // LICENSE file in the root directory of this source tree. An additional grant | ||
| // of patent rights can be found in the PATENTS file in the same directory. | ||
|
|
||
| #pragma once | ||
|
|
||
| #if defined(LUA) && !defined(ROCKSDB_LITE) | ||
| // lua headers | ||
| extern "C" { | ||
| #include <lauxlib.h> | ||
| #include <lua.h> | ||
| #include <lualib.h> | ||
| } | ||
|
|
||
| #include <mutex> | ||
| #include <string> | ||
| #include <vector> | ||
|
|
||
| #include "rocksdb/compaction_filter.h" | ||
| #include "rocksdb/env.h" | ||
| #include "rocksdb/slice.h" | ||
| #include "rocksdb/utilities/lua/rocks_lua_custom_library.h" | ||
| #include "rocksdb/utilities/lua/rocks_lua_util.h" | ||
|
|
||
| namespace rocksdb { | ||
| namespace lua { | ||
|
|
||
| struct RocksLuaCompactionFilterOptions { | ||
| // The lua script in string that implements all necessary CompactionFilter | ||
| // virtual functions. The specified lua_script must implement the following | ||
| // functions, which are Name and Filter, as described below. | ||
| // | ||
| // 0. The Name function simply returns a string representing the name of | ||
| // the lua script. If there's any erorr in the Name function, an | ||
| // empty string will be used. | ||
| // --- Example | ||
| // function Name() | ||
| // return "DefaultLuaCompactionFilter" | ||
| // end | ||
| // | ||
| // | ||
| // 1. The script must contains a function called Filter, which implements | ||
| // CompactionFilter::Filter() , takes three input arguments, and returns | ||
| // three values as the following API: | ||
| // | ||
| // function Filter(level, key, existing_value) | ||
| // ... | ||
| // return is_filtered, is_changed, new_value | ||
| // end | ||
| // | ||
| // Note that if ignore_value is set to true, then Filter should implement | ||
| // the following API: | ||
| // | ||
| // function Filter(level, key) | ||
| // ... | ||
| // return is_filtered | ||
| // end | ||
| // | ||
| // If there're any error in the Filter() function, then it will keep | ||
| // the input key / value pair. | ||
| // | ||
| // -- Input | ||
| // The function must take three arguments (integer, string, string), | ||
| // which map to "level", "key", and "existing_value" passed from | ||
| // RocksDB. | ||
| // | ||
| // -- Output | ||
| // The function must return three values (boolean, boolean, string). | ||
| // - is_filtered: if the first return value is true, then it indicates | ||
| // the input key / value pair should be filtered. | ||
| // - is_changed: if the second return value is true, then it indicates | ||
| // the existing_value needs to be changed, and the resulting value | ||
| // is stored in the third return value. | ||
| // - new_value: if the second return value is true, then this third | ||
| // return value stores the new value of the input key / value pair. | ||
| // | ||
| // -- Examples | ||
| // -- a filter that keeps all key-value pairs | ||
| // function Filter(level, key, existing_value) | ||
| // return false, false, "" | ||
| // end | ||
| // | ||
| // -- a filter that keeps all keys and change their values to "Rocks" | ||
| // function Filter(level, key, existing_value) | ||
| // return false, true, "Rocks" | ||
| // end | ||
|
|
||
| std::string lua_script; | ||
|
|
||
| // If set to true, then existing_value will not be passed to the Filter | ||
| // function, and the Filter function only needs to return a single boolean | ||
| // flag indicating whether to filter out this key or not. | ||
| // | ||
| // function Filter(level, key) | ||
| // ... | ||
| // return is_filtered | ||
| // end | ||
| bool ignore_value = false; | ||
|
|
||
| // A boolean flag to determine whether to ignore snapshots. | ||
| bool ignore_snapshots = false; | ||
|
|
||
| // When specified a non-null pointer, the first "error_limit_per_filter" | ||
| // errors of each CompactionFilter that is lua related will be included | ||
| // in this log. | ||
| std::shared_ptr<Logger> error_log; | ||
|
|
||
| // The number of errors per CompactionFilter will be printed | ||
| // to error_log. | ||
| int error_limit_per_filter = 1; | ||
|
|
||
| // A string to luaL_reg array map that allows the Lua CompactionFilter | ||
| // to use custom C library. The string will be used as the library | ||
| // name in Lua. | ||
| std::vector<std::shared_ptr<RocksLuaCustomLibrary>> libraries; | ||
|
|
||
| /////////////////////////////////////////////////////////////////////////// | ||
| // NOT YET SUPPORTED | ||
| // The name of the Lua function in "lua_script" that implements | ||
| // CompactionFilter::FilterMergeOperand(). The function must take | ||
| // three input arguments (integer, string, string), which map to "level", | ||
| // "key", and "operand" passed from the RocksDB. In addition, the | ||
| // function must return a single boolean value, indicating whether | ||
| // to filter the input key / operand. | ||
| // | ||
| // DEFAULT: the default implementation always returns false. | ||
| // @see CompactionFilter::FilterMergeOperand | ||
| }; | ||
|
|
||
| class RocksLuaCompactionFilterFactory : public CompactionFilterFactory { | ||
| public: | ||
| explicit RocksLuaCompactionFilterFactory( | ||
| const RocksLuaCompactionFilterOptions opt); | ||
|
|
||
| virtual ~RocksLuaCompactionFilterFactory() {} | ||
|
|
||
| std::unique_ptr<CompactionFilter> CreateCompactionFilter( | ||
| const CompactionFilter::Context& context) override; | ||
|
|
||
| // Change the Lua script so that the next compaction after this | ||
| // function call will use the new Lua script. | ||
| void SetScript(const std::string& new_script); | ||
|
|
||
| // Obtain the current Lua script | ||
| std::string GetScript(); | ||
|
|
||
| const char* Name() const override; | ||
|
|
||
| private: | ||
| RocksLuaCompactionFilterOptions opt_; | ||
| std::string name_; | ||
| // A lock to protect "opt_" to make it dynamically changeable. | ||
| std::mutex opt_mutex_; | ||
| }; | ||
|
|
||
| // A wrapper class that invokes Lua script to perform CompactionFilter | ||
| // functions. | ||
| class RocksLuaCompactionFilter : public rocksdb::CompactionFilter { | ||
| public: | ||
| explicit RocksLuaCompactionFilter(const RocksLuaCompactionFilterOptions& opt) | ||
| : options_(opt), | ||
| lua_state_wrapper_(opt.lua_script, opt.libraries), | ||
| error_count_(0) {} | ||
|
|
||
| virtual bool Filter(int level, const Slice& key, const Slice& existing_value, | ||
| std::string* new_value, | ||
| bool* value_changed) const override; | ||
| // Not yet supported | ||
| virtual bool FilterMergeOperand(int level, const Slice& key, | ||
| const Slice& operand) const override { | ||
| return false; | ||
| } | ||
| virtual bool IgnoreSnapshots() const override; | ||
| virtual const char* Name() const override; | ||
|
|
||
| protected: | ||
| void LogLuaError(const char* format, ...) const; | ||
|
|
||
| RocksLuaCompactionFilterOptions options_; | ||
| LuaStateWrapper lua_state_wrapper_; | ||
| mutable int error_count_; | ||
| }; | ||
|
|
||
| } // namespace lua | ||
| } // namespace rocksdb | ||
| #endif // defined(LUA) && !defined(ROCKSDB_LITE) |
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,43 @@ | ||
| // Copyright (c) 2016, Facebook, Inc. All rights reserved. | ||
| // This source code is licensed under the BSD-style license found in the | ||
| // LICENSE file in the root directory of this source tree. An additional grant | ||
| // of patent rights can be found in the PATENTS file in the same directory. | ||
|
|
||
| #pragma once | ||
| #ifdef LUA | ||
|
|
||
| // lua headers | ||
| extern "C" { | ||
| #include <lauxlib.h> | ||
| #include <lua.h> | ||
| #include <lualib.h> | ||
| } | ||
|
|
||
| namespace rocksdb { | ||
| namespace lua { | ||
| // A class that used to define custom C Library that is callable | ||
| // from Lua script | ||
| class RocksLuaCustomLibrary { | ||
| public: | ||
| virtual ~RocksLuaCustomLibrary() {} | ||
| // The name of the C library. This name will also be used as the table | ||
| // (namespace) in Lua that contains the C library. | ||
| virtual const char* Name() const = 0; | ||
|
|
||
| // Returns a "static const struct luaL_Reg[]", which includes a list of | ||
| // C functions. Note that the last entry of this static array must be | ||
| // {nullptr, nullptr} as required by Lua. | ||
| // | ||
| // More details about how to implement Lua C libraries can be found | ||
| // in the official Lua document http://www.lua.org/pil/26.2.html | ||
| virtual const struct luaL_Reg* Lib() const = 0; | ||
|
|
||
| // A function that will be called right after the library has been created | ||
| // and pushed on the top of the lua_State. This custom setup function | ||
| // allows developers to put additional table or constant values inside | ||
| // the same table / namespace. | ||
| virtual void CustomSetup(lua_State* L) const {} | ||
| }; | ||
| } // namespace lua | ||
| } // namespace rocksdb | ||
| #endif // LUA |
Oops, something went wrong.