PS-9181: Add caching of dictionary table for component_masking_functions #5302

oleksandr-kachan · 2024-05-30T14:31:06Z

https://perconadev.atlassian.net/browse/PS-9181

Added caching of mysql.masking_dictionaries table content.
Implemented masking_dictionaries_flush() UDF which flushes data from the masking dictionaries table to the memory ache.
Added component_masking.dictionaries_flush_interval_seconds system variable.
Added actual flusher thread. It periodically rereads content of dictionary table and updates in-memory cache.

github-actions

⚠️ Clang-Tidy found issue(s) with the introduced code (1/3)

github-actions · 2024-05-30T14:39:04Z

components/masking_functions/src/masking_functions/query_cache.cpp

+
+#include <mysql/components/services/log_builtins.h>
+#include <mysql/psi/mysql_thread.h>
+#include <mysqld_error.h>


⚠️ clang-diagnostic-error ⚠️
mysqld_error.h file not found

github-actions · 2024-05-30T14:39:04Z

components/masking_functions/include/masking_functions/query_cache.hpp

+  std::mutex flusher_mutex_;
+  std::condition_variable flusher_condition_var_;
+
+  PSI_thread_key psi_flusher_thread_key_;


⚠️ cppcoreguidelines-pro-type-member-init ⚠️
constructor does not initialize these fields: psi_flusher_thread_key_, flusher_thread_attr_

Suggested change

PSI_thread_key psi_flusher_thread_key_;

PSI_thread_key psi_flusher_thread_key_{};

github-actions · 2024-05-30T14:39:05Z

components/masking_functions/include/masking_functions/query_cache.hpp

+
+  PSI_thread_key psi_flusher_thread_key_;
+  my_thread_handle flusher_thread_;
+  my_thread_attr_t flusher_thread_attr_;


⚠️ cppcoreguidelines-pro-type-member-init ⚠️
constructor does not initialize these fields: psi_flusher_thread_key_, flusher_thread_attr_

Suggested change

my_thread_attr_t flusher_thread_attr_;

my_thread_attr_t flusher_thread_attr_{};

github-actions · 2024-05-30T14:39:05Z

components/masking_functions/include/masking_functions/query_cache.hpp

+  bool contains(const std::string &dictionary_name,
+                const std::string &term) const;


⚠️ readability-convert-member-functions-to-static ⚠️
method contains can be made static

Suggested change

bool contains(const std::string &dictionary_name,

const std::string &term) const;

static bool contains(const std::string &dictionary_name,

const std::string &term) ;

github-actions · 2024-05-30T14:39:05Z

components/masking_functions/src/masking_functions/query_cache.cpp

+}
+
+bool query_cache::contains(const std::string &dictionary_name,
+                           const std::string &term) const {


⚠️ readability-convert-member-functions-to-static ⚠️
method contains can be made static

Suggested change

const std::string &term) const {

const std::string &term) {

github-actions · 2024-05-30T14:39:05Z

components/masking_functions/include/masking_functions/query_cache.hpp

+                const std::string &term) const;
+  // returns a copy of the string to avoid race conditions
+  // an empty string is returned if the dictionary does not exist
+  std::string get_random(const std::string &dictionary_name) const;


⚠️ readability-convert-member-functions-to-static ⚠️
method get_random can be made static

Suggested change

std::string get_random(const std::string &dictionary_name) const;

static std::string get_random(const std::string &dictionary_name) ;

github-actions · 2024-05-30T14:39:05Z

components/masking_functions/src/masking_functions/query_cache.cpp

+  return acquired_dict_cache.contains(dictionary_name, term);
+}
+
+std::string query_cache::get_random(const std::string &dictionary_name) const {


⚠️ readability-convert-member-functions-to-static ⚠️
method get_random can be made static

Suggested change

std::string query_cache::get_random(const std::string &dictionary_name) const {

std::string query_cache::get_random(const std::string &dictionary_name) {

github-actions · 2024-05-30T14:39:05Z

components/masking_functions/src/masking_functions/query_cache.cpp

+}
+
+void query_cache::init_thd() noexcept {
+  auto *thd = new THD;


⚠️ cppcoreguidelines-owning-memory ⚠️
initializing non-owner THD * with a newly created gsl::owner<>

github-actions · 2024-05-30T14:39:05Z

components/masking_functions/src/masking_functions/query_cache.cpp

+}
+
+void query_cache::init_thd() noexcept {
+  auto *thd = new THD;


⚠️ bugprone-unhandled-exception-at-new ⚠️
missing exception handler for allocation failure at new

github-actions · 2024-05-30T14:39:05Z

components/masking_functions/include/masking_functions/query_cache.hpp

+  std::unique_ptr<THD> flusher_thd_;
+
+  void init_thd() noexcept;
+  void release_thd() noexcept;


⚠️ readability-convert-member-functions-to-static ⚠️
method release_thd can be made static

Suggested change

void release_thd() noexcept;

static void release_thd() noexcept;

github-actions

⚠️ Clang-Tidy found issue(s) with the introduced code (2/3)

github-actions · 2024-05-30T14:39:17Z

components/masking_functions/src/masking_functions/query_cache.cpp

+    masking_functions::sql_context sql_ctx{global_command_services::instance()};
+    auto query{dict_query_builder_->select_all_from_dictionary()};
+    auto local_dict_cache{std::make_unique<bookshelf>()};
+    sql_context::row_callback<2> result_inserter{[&terms = *local_dict_cache](


⚠️ cppcoreguidelines-init-variables ⚠️
variable result_inserter is not initialized

Suggested change

sql_context::row_callback<2> result_inserter{[&terms = *local_dict_cache](

sql_context::row_callback<2> result_inserter = 0{[&terms = *local_dict_cache](

github-actions · 2024-05-30T14:39:17Z

components/masking_functions/src/component.cpp

@@ -33,9 +35,13 @@
 #include <mysqld_error.h>


⚠️ clang-diagnostic-error ⚠️
mysqld_error.h file not found

github-actions · 2024-05-30T14:39:17Z

components/masking_functions/src/component.cpp

+    return 1;
+  }
+
+  std::string check_error_message;


⚠️ cppcoreguidelines-init-variables ⚠️
variable check_error_message is not initialized

Suggested change

std::string check_error_message;

std::string check_error_message = 0;

github-actions · 2024-05-30T14:39:17Z

components/masking_functions/src/component.cpp

@@ -174,8 +225,11 @@
  REQUIRES_SERVICE(mysql_string_substr),
  REQUIRES_SERVICE(mysql_string_compare),

+  REQUIRES_PSI_THREAD_SERVICE,


⚠️ cppcoreguidelines-pro-type-const-cast ⚠️
do not use const_cast

github-actions · 2024-05-30T14:39:17Z

components/masking_functions/src/component.cpp

  REQUIRES_SERVICE(mysql_command_query),
  REQUIRES_SERVICE(mysql_command_query_result),
+  REQUIRES_SERVICE(mysql_command_field_info),


⚠️ cppcoreguidelines-pro-type-const-cast ⚠️
do not use const_cast

github-actions · 2024-05-30T14:39:17Z

components/masking_functions/src/component.cpp

@@ -187,6 +241,8 @@
  REQUIRES_SERVICE(mysql_current_thread_reader),
  REQUIRES_SERVICE(mysql_thd_security_context),
  REQUIRES_SERVICE(global_grants_check),
+  REQUIRES_SERVICE(component_sys_variable_register),


⚠️ cppcoreguidelines-pro-type-const-cast ⚠️
do not use const_cast

github-actions · 2024-05-30T14:39:17Z

components/masking_functions/src/component.cpp

@@ -187,6 +241,8 @@
  REQUIRES_SERVICE(mysql_current_thread_reader),
  REQUIRES_SERVICE(mysql_thd_security_context),
  REQUIRES_SERVICE(global_grants_check),
+  REQUIRES_SERVICE(component_sys_variable_register),
+  REQUIRES_SERVICE(component_sys_variable_unregister),


⚠️ cppcoreguidelines-pro-type-const-cast ⚠️
do not use const_cast

github-actions · 2024-05-30T14:39:17Z

components/masking_functions/include/masking_functions/bookshelf.hpp

+
+namespace masking_functions {
+
+class bookshelf {


⚠️ cppcoreguidelines-special-member-functions ⚠️
class bookshelf defines a non-default destructor, a copy assignment operator, a move constructor and a move assignment operator but does not define a copy constructor

github-actions · 2024-05-30T14:39:18Z

components/masking_functions/src/masking_functions/sys_vars.cpp

+#include <mysql/components/services/component_sys_var_service.h>
+#include <mysql/components/services/log_builtins.h>
+
+#include <mysqld_error.h>


⚠️ clang-diagnostic-error ⚠️
mysqld_error.h file not found

github-actions · 2024-05-30T14:39:18Z

components/masking_functions/src/masking_functions/sql_context.cpp

+    throw std::runtime_error{"Error while executing SQL select query"};
+  }
+
+  unsigned int actual_number_of_fields;


⚠️ cppcoreguidelines-init-variables ⚠️
variable actual_number_of_fields is not initialized

Suggested change

unsigned int actual_number_of_fields;

unsigned int actual_number_of_fields = 0;

github-actions

⚠️ Clang-Tidy found issue(s) with the introduced code (3/3)

github-actions · 2024-05-30T14:39:29Z

components/masking_functions/src/masking_functions/registration_routines.cpp

@@ -1229,6 +1247,7 @@ DECLARE_STRING_UDF_AUTO(mask_uk_nin)
 DECLARE_STRING_UDF_AUTO(mask_uuid)
 DECLARE_STRING_UDF_AUTO(gen_blocklist)
 DECLARE_STRING_UDF_AUTO(gen_dictionary)
+DECLARE_STRING_UDF_AUTO(masking_dictionaries_flush)


⚠️ cppcoreguidelines-init-variables ⚠️
variable initid is not initialized

github-actions · 2024-05-30T14:39:29Z

components/masking_functions/src/masking_functions/registration_routines.cpp

@@ -1229,6 +1247,7 @@
 DECLARE_STRING_UDF_AUTO(mask_uuid)
 DECLARE_STRING_UDF_AUTO(gen_blocklist)
 DECLARE_STRING_UDF_AUTO(gen_dictionary)
+DECLARE_STRING_UDF_AUTO(masking_dictionaries_flush)


⚠️ misc-unused-parameters ⚠️
parameter initid is unused

github-actions · 2024-05-30T14:39:29Z

components/masking_functions/src/masking_functions/dictionary.cpp

+
+bool dictionary::contains(const std::string &term) const noexcept {
+  // TODO: in c++20 change to terms_.contains(term)
+  return terms_.count(term) > 0U;


⚠️ readability-container-contains ⚠️
use contains to check for membership

Suggested change

return terms_.count(term) > 0U;

return terms_.contains(term)U;

https://perconadev.atlassian.net/browse/PS-9148 - Added caching of mysql.masking_dictionaries table content. - Implemented masking_dictionaries_flush() UDF which flushes data from the masking dictionaries table to the memory cache.

https://perconadev.atlassian.net/browse/PS-9148 The masking_functions.masking_database system variable for the masking_functions component specifies database used for data masking dictionaries.

https://perconadev.atlassian.net/browse/PS-9148 - Added component_masking.dictionaries_flush_interval_seconds system variable. - Added actual flusher thread. It periodically rereads content of dictionary table and updates in-memory cache.

https://perconadev.atlassian.net/browse/PS-9148 Introduced 'dictionary' and 'bookshelf' classes for storing terms on per-dictionary level. Reworked 'query_cache' to utilize these two new classes.

https://perconadev.atlassian.net/browse/PS-9148 Introduced 'component_sys_variable_service_tuple' class for groupping comonent system variable registration services (supposed to be used with 'primitive_singleton' class template). 'query_cache' now expects 'query_builder' and 'flusher_interval_seconds' as its constructor's parameters. Eliminates custom MySQL types (like 'ulonglong') and its includes (like 'my_inttypes.h') from the publicly facing headers. 'query_cache' is now explicitly initialized / deinitialized in the component's 'init()'' / 'deinit()'' functions via 'primitive_singleton' interface. 'query_cache' helper thread-related methods made private.

https://perconadev.atlassian.net/browse/PS-9148 As std::string_view::data() is not guaranteed to be null-terminated, it is not safe to use it in old c-functions accepting 'const char *'. Some constants converted to arrays of char 'const char buffer[]{"value"}'.

https://perconadev.atlassian.net/browse/PS-9148 'command_service_tuple' struct extended with one more member - 'field_info' service. Reworked 'query_cache' class: instead of loading terms from the database in constructor, this operation is now performed in first attempt to access one of the dictionary methods ('contains()' / 'get_random()' / 'remove()' / 'insert()'). This is done in order to overcome a limitation that does not allow 'mysql_command_query' service to be used from inside the componment initialization function. Fixed problem with 'm_dict_cache' shared pointer updated concurrently from different threads. Exceptions thrown from the cache loading function no longer escape the flusher thread. De-coupled 'sql_context' and 'bookshelf' classes: 'sql_context' now accepts a generic insertion callback that can be used to populate any type of containers. 'component_masking_functions.dictionary_operations' MTR test case extended with additional checks for flushed / unflushed dictionary cache.

https://perconadev.atlassian.net/browse/PS-9148 Both 'dictionary' and 'bookshelf' classes no longer include their own 'std::shared_mutex' to protect data. Instead, we now have a single 'std::shared_mutex' at the 'query_cache' level. The return value of the 'get_random()' method in both 'dictionary' and 'bookshelf' classes changed from 'optional_string' to 'std::string_view'. Empty (default constructed) 'std::string_view' is used as an indicator of an unsuccessful operation. 'get_random()' method in the 'query_cache' class still returns a string by value to avoid race conditions. Changed the behaviour of the 'sql_context::execute_dml()' method - it now throws when SQL errors (like "no table found", etc.) occur.

https://perconadev.atlassian.net/browse/PS-9148 Added missing my_thread_attr_t initialization.

github-actions bot reviewed May 30, 2024

View reviewed changes

oleksandr-kachan force-pushed the PS-9181-release-8.4.0 branch from d2f716d to 242221d Compare May 31, 2024 07:52

oleksandr-kachan force-pushed the PS-9181-release-8.4.0 branch from 242221d to 457882e Compare June 21, 2024 19:57

oleksandr-kachan and others added 9 commits August 5, 2024 17:45

PS-9148: Add masking_functions.masking_database sys var support

f00a636

https://perconadev.atlassian.net/browse/PS-9148 The masking_functions.masking_database system variable for the masking_functions component specifies database used for data masking dictionaries.

PS-9148: Implemented hierarchical storage for dictionaries and terms

d9d6146

https://perconadev.atlassian.net/browse/PS-9148 Introduced 'dictionary' and 'bookshelf' classes for storing terms on per-dictionary level. Reworked 'query_cache' to utilize these two new classes.

PS-9148: Fix masking functions flusher thread intialization

7940e2e

https://perconadev.atlassian.net/browse/PS-9148 Added missing my_thread_attr_t initialization.

oleksandr-kachan force-pushed the PS-9181-release-8.4.0 branch from 457882e to 7940e2e Compare August 6, 2024 14:39

oleksandr-kachan closed this Aug 12, 2024

oleksandr-kachan deleted the PS-9181-release-8.4.0 branch August 12, 2024 14:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PS-9181: Add caching of dictionary table for component_masking_functions #5302

PS-9181: Add caching of dictionary table for component_masking_functions #5302

oleksandr-kachan commented May 30, 2024

github-actions bot left a comment

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot left a comment

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot left a comment

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

	PSI_thread_key psi_flusher_thread_key_;
	PSI_thread_key psi_flusher_thread_key_{};

	my_thread_attr_t flusher_thread_attr_;
	my_thread_attr_t flusher_thread_attr_{};

		bool contains(const std::string &dictionary_name,
		const std::string &term) const;

	std::string get_random(const std::string &dictionary_name) const;
	static std::string get_random(const std::string &dictionary_name) ;

	std::string query_cache::get_random(const std::string &dictionary_name) const {
	std::string query_cache::get_random(const std::string &dictionary_name) {

	void release_thd() noexcept;
	static void release_thd() noexcept;

	sql_context::row_callback<2> result_inserter{[&terms = *local_dict_cache](
	sql_context::row_callback<2> result_inserter = 0{[&terms = *local_dict_cache](

	std::string check_error_message;
	std::string check_error_message = 0;

	unsigned int actual_number_of_fields;
	unsigned int actual_number_of_fields = 0;

	return terms_.count(term) > 0U;
	return terms_.contains(term)U;

PS-9181: Add caching of dictionary table for component_masking_functions #5302

PS-9181: Add caching of dictionary table for component_masking_functions #5302

Conversation

oleksandr-kachan commented May 30, 2024

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment