PS-10007 feature: Implemented support for MySQL Server 8.4 series

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

Added support for binary log events generated by MySQL Server 8.4 LTS.
In particular:
* 'GTID TAGGED' binlog event (which is specific to 8.4 series) is now
  recognized and handled properly by the parser.
* Internal event class representing 'FORMAT DESCRIPTION' binlog event can now
  handle both 8.0 and 8.4 data. In particular in 8.4, the size of the 'common_header_length'
  array is increased by 1 because of the additional 'GTID TAGGED'.

'binsrv::event::reader_context' class constructor now takes one more parameter
'encoded_server_version' in order to be aware of 8.0/8.4 differences. The value
that is passeed as this 'encoded_server_version' argument is extracted from the
'easymysql::connection' object.

Added 'binsrv::event::server_version' class that helps parse / compose MySQL Server
version strings in the '<major>.<minor>.<patch>-<extra>' format.

Generalized MTR test cases so that they can be run on both 8.0 and 8.4 MySQL Servers.

Reference links updated to point to the 'mysql-8.0.43' code.
Added reference links to the 'mysql-8.4.6' code.

Author: percona-ysorokin

CMakeLists.txt

@@ -143,6 +143,10 @@ set(source_files
   src/binsrv/event/rotate_post_header_impl.hpp
   src/binsrv/event/rotate_post_header_impl.cpp
 
+  src/binsrv/event/server_version_fwd.hpp
+  src/binsrv/event/server_version.hpp
+  src/binsrv/event/server_version.cpp
+
   src/binsrv/event/stop_body_impl_fwd.hpp
   src/binsrv/event/stop_body_impl.hpp
 

mtr/binlog_streaming/include/v80_v84_compatibility_defines.inc

@@ -0,0 +1,24 @@
+--let $lts_series = unknown
+if (`SELECT VERSION() LIKE '8.0%'`)
+{
+  --let $lts_series = v80
+}
+if (`SELECT VERSION() LIKE '8.4%'`)
+{
+  --let $lts_series = v84
+}
+
+if ($lts_series == unknown)
+{
+  --die unsupported MySQL Server version
+}
+if ($lts_series == v80)
+{
+  --let $stmt_reset_binary_logs_and_gtids = RESET MASTER
+  --let $stmt_show_binary_log_status = SHOW MASTER STATUS
+}
+if ($lts_series == v84)
+{
+  --let $stmt_reset_binary_logs_and_gtids = RESET BINARY LOGS AND GTIDS
+  --let $stmt_show_binary_log_status = SHOW BINARY LOG STATUS
+}

mtr/binlog_streaming/r/binsrv.result

@@ -1,5 +1,4 @@
 *** Resetting replication at the very beginning of the test.
-RESET MASTER;
 
 *** Determining the first fresh binary log name.
 

mtr/binlog_streaming/r/pull_mode.result

@@ -1,5 +1,4 @@
 *** Resetting replication at the very beginning of the test.
-RESET MASTER;
 
 *** Generating a configuration file in JSON format for the Binlog
 *** Server utility.

mtr/binlog_streaming/t/binsrv.test

@@ -4,14 +4,18 @@ if (!$BINSRV) {
   --skip \$BINSRV environment variable must be set
 }
 
+--source ../include/v80_v84_compatibility_defines.inc
+
 # in case of --repeat=N, we need to start from a fresh binary log to make
 # this test deterministic
 --echo *** Resetting replication at the very beginning of the test.
-RESET MASTER;
+--disable_query_log
+eval $stmt_reset_binary_logs_and_gtids;
+--enable_query_log
 
 --echo
 --echo *** Determining the first fresh binary log name.
---let $first_binlog = query_get_value(SHOW MASTER STATUS, File, 1)
+--let $first_binlog = query_get_value($stmt_show_binary_log_status, File, 1)
 
 --echo
 --echo *** Creating a simple table and filling it with some data.
@@ -24,7 +28,7 @@ FLUSH BINARY LOGS;
 
 --echo
 --echo *** Determining the second binary log name.
---let $second_binlog = query_get_value(SHOW MASTER STATUS, File, 1)
+--let $second_binlog = query_get_value($stmt_show_binary_log_status, File, 1)
 
 --echo
 --echo *** Filling the table with some more data.

mtr/binlog_streaming/t/pull_mode.test

@@ -4,12 +4,16 @@ if (!$BINSRV) {
   --skip \$BINSRV environment variable must be set
 }
 
+--source ../include/v80_v84_compatibility_defines.inc
+
 --source include/count_sessions.inc
 
 # in case of --repeat=N, we need to start from a fresh binary log to make
 # this test deterministic
 --echo *** Resetting replication at the very beginning of the test.
-RESET MASTER;
+--disable_query_log
+eval $stmt_reset_binary_logs_and_gtids;
+--enable_query_log
 
 # identifying backend storage type ('file' or 's3')
 --source ../include/identify_storage_backend.inc
@@ -39,7 +43,7 @@ EOF
 
 --echo
 --echo *** Determining the first fresh binary log name.
---let $first_binlog = query_get_value(SHOW MASTER STATUS, File, 1)
+--let $first_binlog = query_get_value($stmt_show_binary_log_status, File, 1)
 
 --echo
 --echo *** Creating a simple table and filling it with some data.
@@ -57,7 +61,7 @@ INSERT INTO t1 VALUES(DEFAULT);
 
 --echo
 --echo *** Determining the second binary log name.
---let $second_binlog = query_get_value(SHOW MASTER STATUS, File, 1)
+--let $second_binlog = query_get_value($stmt_show_binary_log_status, File, 1)
 
 --echo
 --echo *** Filling the table with some more data.
@@ -74,7 +78,7 @@ INSERT INTO t1 VALUES(DEFAULT);
 
 --echo
 --echo *** Determining the third binary log name.
---let $third_binlog = query_get_value(SHOW MASTER STATUS, File, 1)
+--let $third_binlog = query_get_value($stmt_show_binary_log_status, File, 1)
 
 --echo
 --echo *** Filling the table with some more data again and dropping the table.
@@ -88,7 +92,7 @@ FLUSH BINARY LOGS;
 
 --echo
 --echo *** Determining the fourth binary log name.
---let $fourth_binlog = query_get_value(SHOW MASTER STATUS, File, 1)
+--let $fourth_binlog = query_get_value($stmt_show_binary_log_status, File, 1)
 
 --echo
 --echo *** Waiting till Binlog Server Utility starts processing the fourth

src/app.cpp

@@ -302,6 +302,7 @@ void receive_binlog_events(
   //       @source_binlog_checksum variable that we set in the
   //       'connection::switch_to_replication()'
   binsrv::event::reader_context context{
+      connection.get_server_version(),
       binsrv::event::checksum_algorithm_type::off};
 
   // if binlog is still open, there is no sense to close it and re-open

src/binsrv/event/checksum_algorithm_type.hpp

@@ -27,7 +27,8 @@ namespace binsrv::event {
 
 // NOLINTBEGIN(cppcoreguidelines-macro-usage)
 // Checksum algorithm type codes copied from
-// https://github.com/mysql/mysql-server/blob/mysql-8.0.37/libbinlogevents/include/binlog_event.h#L426
+// https://github.com/mysql/mysql-server/blob/mysql-8.0.43/libbinlogevents/include/binlog_event.h#L440
+// https://github.com/mysql/mysql-server/blob/mysql-8.4.6/libs/mysql/binlog/event/binlog_event.h#L462
 // clang-format off
 #define BINSRV_CHECKSUM_ALGORITHM_TYPE_XY_SEQUENCE() \
   BINSRV_CHECKSUM_ALGORITHM_TYPE_XY_MACRO(off  ,  0), \

src/binsrv/event/code_type.hpp

@@ -27,7 +27,8 @@ namespace binsrv::event {
 
 // NOLINTBEGIN(cppcoreguidelines-macro-usage)
 // Event type codes copied from
-// https://github.com/mysql/mysql-server/blob/mysql-8.0.37/libbinlogevents/include/binlog_event.h#L275
+// https://github.com/mysql/mysql-server/blob/mysql-8.0.43/libbinlogevents/include/binlog_event.h#L275
+// https://github.com/mysql/mysql-server/blob/mysql-8.4.6/libs/mysql/binlog/event/binlog_event.h#L286
 // clang-format off
 #define BINSRV_EVENT_CODE_TYPE_XY_SEQUENCE() \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(unknown            ,  0), \
@@ -36,16 +37,23 @@ namespace binsrv::event {
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(stop               ,  3), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(rotate             ,  4), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(intvar             ,  5), \
+  BINSRV_EVENT_CODE_TYPE_XY_MACRO(obsolete_6         ,  6), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(slave              ,  7), \
+  BINSRV_EVENT_CODE_TYPE_XY_MACRO(obsolete_8         ,  8), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(append_block       ,  9), \
+  BINSRV_EVENT_CODE_TYPE_XY_MACRO(obsolete_10        , 10), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(delete_file        , 11), \
+  BINSRV_EVENT_CODE_TYPE_XY_MACRO(obsolete_12        , 12), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(rand               , 13), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(user_var           , 14), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(format_description , 15), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(xid                , 16), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(begin_load_query   , 17), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(execute_load_query , 18), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(table_map          , 19), \
+  BINSRV_EVENT_CODE_TYPE_XY_MACRO(obsolete_20        , 20), \
+  BINSRV_EVENT_CODE_TYPE_XY_MACRO(obsolete_21        , 21), \
+  BINSRV_EVENT_CODE_TYPE_XY_MACRO(obsolete_22        , 22), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(write_rows_v1      , 23), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(update_rows_v1     , 24), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(delete_rows_v1     , 25), \
@@ -64,7 +72,8 @@ namespace binsrv::event {
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(xa_prepare_log     , 38), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(partial_update_rows, 39), \
   BINSRV_EVENT_CODE_TYPE_XY_MACRO(transaction_payload, 40), \
-  BINSRV_EVENT_CODE_TYPE_XY_MACRO(heartbeat_log_v2   , 41)
+  BINSRV_EVENT_CODE_TYPE_XY_MACRO(heartbeat_log_v2   , 41), \
+  BINSRV_EVENT_CODE_TYPE_XY_MACRO(gtid_tagged_log    , 42)
 // clang-format on
 
 #define BINSRV_EVENT_CODE_TYPE_XY_MACRO(X, Y) X = Y

src/binsrv/event/common_header.cpp

@@ -40,7 +40,8 @@ common_header::common_header(util::const_byte_span portion) {
   // TODO: rework with direct member initialization
 
   /*
-    https://github.com/mysql/mysql-server/blob/mysql-8.0.37/libbinlogevents/src/binlog_event.cpp#L198
+    https://github.com/mysql/mysql-server/blob/mysql-8.0.43/libbinlogevents/src/binlog_event.cpp#L198
+    https://github.com/mysql/mysql-server/blob/mysql-8.4.6/libs/mysql/binlog/event/binlog_event.cpp#L242
 
     The first 19 bytes in the header is as follows:
       +============================================+