BUG#36381815 step 5: Move binlog/event/compression/buffer to new library containers

Part of: Bug#36381815: Factor out generic functionality from the mysql_binlog_event library

The contents of binlog/event/compression/buffer is generic and does
not depend on binlog events.  Move it to the subdirectory "buffers" of
the new library "containers".

This commit was produced using:
./libs/scripts/create library containers
./libs/scripts/move --force directory \
  binlog/event/compression/buffer containers/buffers
sed --in-place 's/mysql_gtid/mysql_containers\n  mysql_gtid/' \
  plugin/group_replication/CMakeLists.txt \
  libs/mysql/binlog/event/CMakeLists.txt
sed --in-place 's/ buffer::/ /' \
  libs/mysql/containers/buffers/managed_buffer.h \
  unittest/gunit/binlogevents/managed_buffer-t.cc \
  unittest/gunit/binlogevents/managed_buffer_sequence-t.cc \
  libs/mysql/containers/buffers/buffer_sequence_view.h \
  libs/mysql/containers/buffers/managed_buffer_sequence.h \
  libs/mysql/containers/buffers/rw_buffer_sequence.h \
  libs/mysql/containers/buffers/buffer_view.h \
And then auto-reformatting.

Change-Id: Id7416b7466b8f9bafc70c843f4b1835f4db04984

Author: Sven Sandberg

client/mysqlbinlog.cc

@@ -176,7 +176,7 @@ class Database_rewrite {
       using Compress_status_t =
           mysql::binlog::event::compression::Compress_status;
       using Managed_buffer_sequence_t =
-          mysql::binlog::event::compression::buffer::Managed_buffer_sequence<>;
+          mysql::containers::buffers::Managed_buffer_sequence<>;
       using Char_t = Managed_buffer_sequence_t::Char_t;
       Managed_buffer_sequence_t managed_buffer_sequence;
       auto compressor =

libs/mysql/CMakeLists.txt

@@ -22,6 +22,7 @@
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
 
 ADD_SUBDIRECTORY(allocators)
+ADD_SUBDIRECTORY(containers)
 ADD_SUBDIRECTORY(utils)
 ADD_SUBDIRECTORY(serialization)
 ADD_SUBDIRECTORY(gtid)

libs/mysql/binlog/event/CMakeLists.txt

@@ -24,6 +24,7 @@
 SET(LINK_LIBRARIES
   ext::zstd
   ext::zlib
+  mysql_containers
   mysql_gtid
   mysql_serialization
 )
@@ -78,9 +79,6 @@ SET(TARGET_SRCS
   compression/payload_event_buffer_istream.cpp
   compression/zstd_comp.cpp
   compression/zstd_dec.cpp
-  compression/buffer/grow_calculator.cpp
-  compression/buffer/grow_constraint.cpp
-  compression/buffer/grow_status.cpp
 )
 
 ADD_WSHADOW_WARNING()

libs/mysql/binlog/event/compression/compressor.h

@@ -26,16 +26,16 @@
 
 #include <cstddef>
 #include <tuple>
-#include "mysql/binlog/event/compression/base.h"                    // type
-#include "mysql/binlog/event/compression/buffer/grow_constraint.h"  // Grow_constraint
-#include "mysql/binlog/event/compression/buffer/managed_buffer_sequence.h"  // Managed_buffer_sequence
-#include "mysql/utils/nodiscard.h"  // NODISCARD
+#include "mysql/binlog/event/compression/base.h"       // type
+#include "mysql/containers/buffers/grow_constraint.h"  // Grow_constraint
+#include "mysql/containers/buffers/managed_buffer_sequence.h"  // Managed_buffer_sequence
+#include "mysql/utils/nodiscard.h"                             // NODISCARD
 
 #include <limits>  // std::numeric_limits
 
 namespace mysql::binlog::event::compression {
 
-using Compress_status = mysql::binlog::event::compression::buffer::Grow_status;
+using Compress_status = mysql::containers::buffers::Grow_status;
 
 /// Abstract base class for compressors.
 ///
@@ -75,16 +75,15 @@ using Compress_status = mysql::binlog::event::compression::buffer::Grow_status;
 /// above procedure as many times as needed.
 ///
 /// This class requires that the user provides a @c
-/// mysql::binlog::event::compression::buffer::Managed_buffer_sequence to
+/// mysql::containers::buffers::Managed_buffer_sequence to
 /// store output.
 class Compressor {
  public:
   using Managed_buffer_sequence_t =
-      mysql::binlog::event::compression::buffer::Managed_buffer_sequence<>;
+      mysql::containers::buffers::Managed_buffer_sequence<>;
   using Char_t = Managed_buffer_sequence_t::Char_t;
   using Size_t = Managed_buffer_sequence_t::Size_t;
-  using Grow_constraint_t =
-      mysql::binlog::event::compression::buffer::Grow_constraint;
+  using Grow_constraint_t = mysql::containers::buffers::Grow_constraint;
   static constexpr Size_t pledged_input_size_unset =
       std::numeric_limits<Size_t>::max();
 

libs/mysql/binlog/event/compression/decompressor.h

@@ -24,11 +24,11 @@
 #ifndef MYSQL_BINLOG_EVENT_COMPRESSION_DECOMPRESSOR_H
 #define MYSQL_BINLOG_EVENT_COMPRESSION_DECOMPRESSOR_H
 
-#include "mysql/binlog/event/compression/base.h"                    // type
-#include "mysql/binlog/event/compression/buffer/grow_constraint.h"  // Grow_constraint
-#include "mysql/binlog/event/compression/buffer/managed_buffer.h"  // Managed_buffer
+#include "mysql/binlog/event/compression/base.h"               // type
 #include "mysql/binlog/event/compression/decompress_status.h"  // Decompress_status
-#include "mysql/utils/nodiscard.h"                             // NODISCARD
+#include "mysql/containers/buffers/grow_constraint.h"  // Grow_constraint
+#include "mysql/containers/buffers/managed_buffer.h"   // Managed_buffer
+#include "mysql/utils/nodiscard.h"                     // NODISCARD
 
 namespace mysql::binlog::event::compression {
 
@@ -57,15 +57,12 @@ namespace mysql::binlog::event::compression {
 class Decompressor {
  public:
   using Char_t = unsigned char;
-  using Size_t =
-      mysql::binlog::event::compression::buffer::Buffer_view<Char_t>::Size_t;
-  using Managed_buffer_t =
-      mysql::binlog::event::compression::buffer::Managed_buffer<Char_t>;
-  using Grow_constraint_t =
-      mysql::binlog::event::compression::buffer::Grow_constraint;
+  using Size_t = mysql::containers::buffers::Buffer_view<Char_t>::Size_t;
+  using Managed_buffer_t = mysql::containers::buffers::Managed_buffer<Char_t>;
+  using Grow_constraint_t = mysql::containers::buffers::Grow_constraint;
 
  private:
-  using Grow_status_t = mysql::binlog::event::compression::buffer::Grow_status;
+  using Grow_status_t = mysql::containers::buffers::Grow_status;
 
  public:
   Decompressor() = default;

libs/mysql/binlog/event/compression/payload_event_buffer_istream.h

@@ -27,12 +27,12 @@
 #include <memory>
 #include <string>
 
-#include "mysql/binlog/event/compression/buffer/managed_buffer.h"  // mysql::binlog::event::compression::buffer::Managed_buffer
 #include "mysql/binlog/event/compression/decompressor.h"  // mysqlns::compression::Decompressor
 #include "mysql/binlog/event/compression/factory.h"  // mysqlns::compression::Factory
 #include "mysql/binlog/event/control_events.h"  // Transaction_payload_event
 #include "mysql/binlog/event/event_reader.h"    // Event_reader
-#include "mysql/utils/nodiscard.h"              // NODISCARD
+#include "mysql/containers/buffers/managed_buffer.h"  // mysql::containers::buffers::Managed_buffer
+#include "mysql/utils/nodiscard.h"  // NODISCARD
 
 /// @addtogroup GroupLibsMysqlBinlogEvent
 /// @{
@@ -59,12 +59,9 @@ namespace mysql::binlog::event::compression {
 class Payload_event_buffer_istream {
  public:
   using Char_t = unsigned char;
-  using Size_t =
-      mysql::binlog::event::compression::buffer::Buffer_view<Char_t>::Size_t;
-  using Grow_calculator_t =
-      mysql::binlog::event::compression::buffer::Grow_calculator;
-  using Managed_buffer_t =
-      mysql::binlog::event::compression::buffer::Managed_buffer<Char_t>;
+  using Size_t = mysql::containers::buffers::Buffer_view<Char_t>::Size_t;
+  using Grow_calculator_t = mysql::containers::buffers::Grow_calculator;
+  using Managed_buffer_t = mysql::containers::buffers::Managed_buffer<Char_t>;
   using Decompressor_t = Decompressor;
   using Status_t = Decompress_status;
   using Factory_t = Factory;

libs/mysql/binlog/event/compression/zstd_comp.h

@@ -28,8 +28,8 @@
 #include <zstd.h>
 
 #include "mysql/allocators/memory_resource.h"  // Memory_resource
-#include "mysql/binlog/event/compression/buffer/buffer_sequence_view.h"
 #include "mysql/binlog/event/compression/compressor.h"
+#include "mysql/containers/buffers/buffer_sequence_view.h"
 #include "mysql/utils/nodiscard.h"
 
 struct ZSTD_outBuffer_s;

libs/mysql/binlog/event/control_events.h

@@ -42,7 +42,7 @@
 
 #include "mysql/binlog/event/binlog_event.h"
 #include "mysql/binlog/event/compression/base.h"  // mysql::binlog::event::compression::type
-#include "mysql/binlog/event/compression/buffer/buffer_sequence_view.h"  // Buffer_sequence_view
+#include "mysql/containers/buffers/buffer_sequence_view.h"  // Buffer_sequence_view
 #include "mysql/gtid/gtid_constants.h"
 #include "mysql/gtid/tsid.h"
 #include "mysql/gtid/uuid.h"
@@ -735,7 +735,7 @@ struct gtid_info {
 class Transaction_payload_event : public Binary_log_event {
  public:
   using Buffer_sequence_view_t =
-      mysql::binlog::event::compression::buffer::Buffer_sequence_view<>;
+      mysql::containers::buffers::Buffer_sequence_view<>;
 
  private:
   Transaction_payload_event &operator=(const Transaction_payload_event &) =

libs/mysql/containers/CMakeLists.txt

@@ -0,0 +1,35 @@
+# Copyright (c) 2024, Oracle and/or its affiliates.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 2.0,
+# as published by the Free Software Foundation.
+#
+# This program is also distributed with certain software (including
+# but not limited to OpenSSL) that is licensed under separate terms,
+# as designated in a particular file or component or in included license
+# documentation.  The authors of MySQL hereby grant you an additional
+# permission to link the program and your derivative works with the
+# separately licensed software that they have included with MySQL.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License, version 2.0, for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
+
+SET(TARGET_HEADERS
+)
+
+SET(TARGET_SRCS
+  buffers/grow_calculator.cpp
+  buffers/grow_constraint.cpp
+  buffers/grow_status.cpp
+)
+
+LIBS_MYSQL_CREATE_LIBRARY(mysql_containers
+  TARGET_SRCS ${TARGET_SRCS}
+  TARGET_HEADERS ${TARGET_HEADERS}
+)

libs/mysql/binlog/event/compression/buffer/buffer_sequence_view.h renamed to libs/mysql/containers/buffers/buffer_sequence_view.h

@@ -26,8 +26,8 @@
 /// Container class that provides a sequence of buffers to the caller.
 /// This is intended for capturing the output from compressors.
 
-#ifndef MYSQL_BINLOG_EVENT_COMPRESSION_BUFFER_BUFFER_SEQUENCE_VIEW_H
-#define MYSQL_BINLOG_EVENT_COMPRESSION_BUFFER_BUFFER_SEQUENCE_VIEW_H
+#ifndef MYSQL_CONTAINERS_BUFFERS_BUFFER_SEQUENCE_VIEW_H
+#define MYSQL_CONTAINERS_BUFFERS_BUFFER_SEQUENCE_VIEW_H
 
 #include <algorithm>                     // std::min
 #include <cassert>                       // assert
@@ -38,17 +38,17 @@
 #include <vector>                        // std::vector
 #include "mysql/allocators/allocator.h"  // mysql::allocators::Allocator
 
-#include "mysql/binlog/event/compression/buffer/buffer_view.h"  // buffer::Buffer_view
-#include "mysql/binlog/event/compression/buffer/grow_calculator.h"  // buffer::Grow_calculator
-#include "mysql/binlog/event/compression/buffer/grow_status.h"  // buffer::Grow_status
-#include "mysql/utils/nodiscard.h"                              // NODISCARD
+#include "mysql/containers/buffers/buffer_view.h"      // Buffer_view
+#include "mysql/containers/buffers/grow_calculator.h"  // Grow_calculator
+#include "mysql/containers/buffers/grow_status.h"      // Grow_status
+#include "mysql/utils/nodiscard.h"                     // NODISCARD
 
 #include "mysql/binlog/event/wrapper_functions.h"  // BAPI_TRACE
 
-/// @addtogroup GroupLibsMysqlBinlogEvent
+/// @addtogroup GroupLibsMysqlContainers
 /// @{
 
-namespace mysql::binlog::event::compression::buffer {
+namespace mysql::containers::buffers {
 
 /// Sequence of memory buffers.
 ///
@@ -231,8 +231,8 @@ class Buffer_sequence_view {
   mutable Size_t m_size;
 };
 
-}  // namespace mysql::binlog::event::compression::buffer
+}  // namespace mysql::containers::buffers
 
 /// @}
 
-#endif  // MYSQL_BINLOG_EVENT_COMPRESSION_BUFFER_BUFFER_SEQUENCE_VIEW_H
+#endif  // MYSQL_CONTAINERS_BUFFERS_BUFFER_SEQUENCE_VIEW_H

libs/mysql/binlog/event/compression/buffer/buffer_view.h renamed to libs/mysql/containers/buffers/buffer_view.h

@@ -26,19 +26,19 @@
 /// Class that groups a pointer+size as one object, without managing
 /// the memory for it.
 
-#ifndef MYSQL_BINLOG_EVENT_COMPRESSION_BUFFER_BUFFER_VIEW_H
-#define MYSQL_BINLOG_EVENT_COMPRESSION_BUFFER_BUFFER_VIEW_H
+#ifndef MYSQL_CONTAINERS_BUFFERS_BUFFER_VIEW_H
+#define MYSQL_CONTAINERS_BUFFERS_BUFFER_VIEW_H
 
 #include <cassert>  // assert
 #include <string>   // std::string
 #ifndef NDEBUG
 #include <sstream>  // std::ostringstream
 #endif
 
-/// @addtogroup GroupLibsMysqlBinlogEvent
+/// @addtogroup GroupLibsMysqlContainers
 /// @{
 
-namespace mysql::binlog::event::compression::buffer {
+namespace mysql::containers::buffers {
 
 /// Non-owning view of a memory buffer with a fixed size.
 ///
@@ -51,7 +51,7 @@ class Buffer_view {
  public:
   using Char_t = Char_tp;
   /// The 'size' type.  Keep this equal to
-  /// buffer::Grow_calculator::Size_t
+  /// Grow_calculator::Size_t
   using Size_t = std::size_t;
   using Iterator_t = Char_t *;
   using Const_iterator_t = const Char_t *;
@@ -152,8 +152,8 @@ class Buffer_view {
   Size_t m_size{0};
 };
 
-}  // namespace mysql::binlog::event::compression::buffer
+}  // namespace mysql::containers::buffers
 
 /// @}
 
-#endif  // MYSQL_BINLOG_EVENT_COMPRESSION_BUFFER_BUFFER_VIEW_H
+#endif  // MYSQL_CONTAINERS_BUFFERS_BUFFER_VIEW_H

libs/mysql/binlog/event/compression/buffer/grow_calculator.cpp renamed to libs/mysql/containers/buffers/grow_calculator.cpp

@@ -21,13 +21,13 @@
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
 
-#include "mysql/binlog/event/compression/buffer/grow_calculator.h"
+#include "mysql/containers/buffers/grow_calculator.h"
 #include "mysql/binlog/event/math/math.h"          // add_bounded
 #include "mysql/binlog/event/wrapper_functions.h"  // BAPI_TRACE
 
 #include <cassert>
 
-namespace mysql::binlog::event::compression::buffer {
+namespace mysql::containers::buffers {
 
 Grow_calculator::Grow_calculator() {
   set_max_size(default_max_size);
@@ -68,4 +68,4 @@ Grow_calculator::Result_t Grow_calculator::compute_new_size(
   return Result_t(false, new_size);
 }
 
-}  // namespace mysql::binlog::event::compression::buffer
+}  // namespace mysql::containers::buffers

libs/mysql/binlog/event/compression/buffer/grow_calculator.h renamed to libs/mysql/containers/buffers/grow_calculator.h

@@ -23,10 +23,10 @@
 
 /// @file grow_calculator.h
 
-#ifndef MYSQL_BINLOG_EVENT_COMPRESSION_BUFFER_GROW_CALCULATOR_H
-#define MYSQL_BINLOG_EVENT_COMPRESSION_BUFFER_GROW_CALCULATOR_H
+#ifndef MYSQL_CONTAINERS_BUFFERS_GROW_CALCULATOR_H
+#define MYSQL_CONTAINERS_BUFFERS_GROW_CALCULATOR_H
 
-#include "mysql/binlog/event/compression/buffer/grow_constraint.h"  // Grow_constraint
+#include "mysql/containers/buffers/grow_constraint.h"  // Grow_constraint
 
 #include <algorithm>  // std::min
 #include <limits>     // std::numeric_limits
@@ -35,10 +35,10 @@
 #include <sstream>  // std::stringstream
 #endif
 
-/// @addtogroup GroupLibsMysqlBinlogEvent
+/// @addtogroup GroupLibsMysqlContainers
 /// @{
 
-namespace mysql::binlog::event::compression::buffer {
+namespace mysql::containers::buffers {
 
 /// Description of a heuristic to determine how much memory to allocate.
 ///
@@ -115,8 +115,8 @@ class Grow_calculator : public Grow_constraint {
   Result_t compute_new_size(Size_t old_size, Size_t requested_size) const;
 };
 
-}  // namespace mysql::binlog::event::compression::buffer
+}  // namespace mysql::containers::buffers
 
 /// @}
 
-#endif /* MYSQL_BINLOG_EVENT_COMPRESSION_BUFFER_GROW_CALCULATOR_H */
+#endif /* MYSQL_CONTAINERS_BUFFERS_GROW_CALCULATOR_H */

libs/mysql/binlog/event/compression/buffer/grow_constraint.cpp renamed to libs/mysql/containers/buffers/grow_constraint.cpp

@@ -21,11 +21,11 @@
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
 
-#include "mysql/binlog/event/compression/buffer/grow_constraint.h"
+#include "mysql/containers/buffers/grow_constraint.h"
 
 #include <cassert>
 
-namespace mysql::binlog::event::compression::buffer {
+namespace mysql::containers::buffers {
 
 void Grow_constraint::set_max_size(Size_t max_size) { m_max_size = max_size; }
 
@@ -57,4 +57,4 @@ Grow_constraint::Size_t Grow_constraint::get_block_size() const {
   return m_block_size;
 }
 
-}  // namespace mysql::binlog::event::compression::buffer
+}  // namespace mysql::containers::buffers