WL#7440: Moving binlog decoding into separate package

Addressing review comments from Tor,
the comments on value.h/cpp still to be fixed.

Author: Neha Kumari

cmake/os/WindowsCache.cmake

@@ -127,6 +127,7 @@ SET(HAVE_SLEEP CACHE  INTERNAL "")
 SET(HAVE_STPCPY CACHE  INTERNAL "")
 SET(HAVE_STPNCPY CACHE  INTERNAL "")
 SET(HAVE_STRLCPY CACHE  INTERNAL "")
+SET(HAVE_STRNDUP CACHE  INTERNAL "") # Used by libbinlogevents
 SET(HAVE_STRNLEN 1 CACHE  INTERNAL "")
 SET(HAVE_STRLCAT CACHE  INTERNAL "")
 SET(HAVE_STRSIGNAL CACHE  INTERNAL "")

configure.cmake

@@ -457,7 +457,7 @@ CHECK_FUNCTION_EXISTS (sleep HAVE_SLEEP)
 CHECK_FUNCTION_EXISTS (stpcpy HAVE_STPCPY)
 CHECK_FUNCTION_EXISTS (stpncpy HAVE_STPNCPY)
 CHECK_FUNCTION_EXISTS (strlcpy HAVE_STRLCPY)
-CHECK_FUNCTION_EXISTS (strndup HAVE_STRNDUP)
+CHECK_FUNCTION_EXISTS (strndup HAVE_STRNDUP) # Used by libbinlogevents
 CHECK_FUNCTION_EXISTS (strnlen HAVE_STRNLEN)
 CHECK_FUNCTION_EXISTS (strlcat HAVE_STRLCAT)
 CHECK_FUNCTION_EXISTS (strsignal HAVE_STRSIGNAL)

libbinlogevents/include/binlog_event.h

@@ -88,43 +88,6 @@
 */
 #define BINLOG_VERSION    4
 
-/**
-  Check if jump value is within buffer limits.
-
-  @param jump         Number of positions we want to advance.
-  @param buf_start    Pointer to buffer start.
-  @param buf_current  Pointer to the current position on buffer.
-  @param buf_len      Buffer length.
-
-  @return             Number of bytes available on event buffer.
-*/
-template <class T> T available_buffer(const char* buf_start,
-                                      const char* buf_current,
-                                      T buf_len)
-{
-  return buf_len - (buf_current - buf_start);
-}
-
-
-/**
-  Check if jump value is within buffer limits.
-
-  @param jump         Number of positions we want to advance.
-  @param buf_start    Pointer to buffer start
-  @param buf_current  Pointer to the current position on buffer.
-  @param buf_len      Buffer length.
-
-  @retval      True   If jump value is within buffer limits.
-  @retval      False  Otherwise.
-*/
-template <class T> bool valid_buffer_range(T jump,
-                                           const char* buf_start,
-                                           const char* buf_current,
-                                           T buf_len)
-{
-  return (jump <= available_buffer(buf_start, buf_current, buf_len));
-}
-
 
 /**
   G_COMMIT_TS status variable stores the logical timestamp when the transaction
@@ -191,7 +154,7 @@ template <class T> bool valid_buffer_range(T jump,
 */
 namespace binary_log
 {
-/**
+/*
    This flag only makes sense for Format_description_event. It is set
    when the event is written, and *reset* when a binlog file is
    closed (yes, it's the only case when MySQL modifies an already written
@@ -462,8 +425,8 @@ class Log_event_footer
 {
 public:
 
-  enum_binlog_checksum_alg
-  static get_checksum_alg(const char* buf, unsigned long len);
+  static enum_binlog_checksum_alg get_checksum_alg(const char* buf,
+                                                   unsigned long len);
 
   static bool event_checksum_test(unsigned char* buf,
                                   unsigned long event_len,
@@ -801,7 +764,7 @@ class Binary_log_event
    */
   enum Log_event_type get_event_type() const
   {
-    return (enum Log_event_type) m_header.type_code;
+    return  m_header.type_code;
   }
 
   /**

libbinlogevents/include/control_events.h

@@ -129,7 +129,8 @@ class Rotate_event: public Binary_log_event
 
     @param buf                Contains the serialized event.
     @param length             Length of the serialized event.
-    @param description_event  An FDE event, used to get the following information
+    @param description_event  An FDE event, used to get the
+                              following information
                               -binlog_version
                               -server_version
                               -post_header_len
@@ -260,7 +261,8 @@ class Start_event_v3: public Binary_log_event
     </pre>
 
     @param buf                Contains the serialized event.
-    @param description_event  An FDE event, used to get the following information
+    @param description_event  An FDE event, used to get the
+                              following information
                               -binlog_version
                               -server_version
                               -post_header_len
@@ -344,7 +346,7 @@ class Format_description_event: public virtual Start_event_v3
    The list of post-headers' lengths followed
    by the checksum alg decription byte
   */
-  uint8_t *post_header_len;
+  std::vector<uint8_t> post_header_len;
   unsigned char server_version_split[ST_SERVER_VER_SPLIT_LEN];
   /**
    In some previous version > 5.1 GA event types are assigned
@@ -391,7 +393,8 @@ class Format_description_event: public virtual Start_event_v3
     </pre>
     @param buf                Contains the serialized event.
     @param length             Length of the serialized event.
-    @param description_event  An FDE event, used to get the following information
+    @param description_event  An FDE event, used to get the
+                              following information
                               -binlog_version
                               -server_version
                               -post_header_len
@@ -447,7 +450,8 @@ class Stop_event: public Binary_log_event
     -  A slave writes the event to the relay log when it shuts down or when a
        RESET SLAVE statement is executed
     @param buf                Contains the serialized event.
-    @param description_event  An FDE event, used to get the following information
+    @param description_event  An FDE event, used to get the
+                              following information
                               -binlog_version
                               -server_version
                               -post_header_len
@@ -557,7 +561,8 @@ class Incident_event: public Binary_log_event
 
     @param buf                Contains the serialized event.
     @param length             Length of the serialized event.
-    @param description_event  An FDE event, used to get the following information
+    @param description_event  An FDE event, used to get the
+                              following information
                               -binlog_version
                               -server_version
                               -post_header_len
@@ -610,8 +615,9 @@ class Xid_event: public Binary_log_event
 {
 public:
   /**
-   The minimal constructor of Xid_event, it initializes the instance variable xid
-   and set the type_code as XID_EVENT in the header object in Binary_log_event
+    The minimal constructor of Xid_event, it initializes the instance variable
+    xid and set the type_code as XID_EVENT in the header object in
+    Binary_log_event
   */
   explicit Xid_event(uint64_t xid_arg)
     : Binary_log_event(XID_EVENT),
@@ -623,7 +629,8 @@ class Xid_event: public Binary_log_event
     An XID event is generated for a commit of a transaction that modifies one or
     more tables of an XA-capable storage engine
     @param buf                Contains the serialized event.
-    @param description_event  An FDE event, used to get the following information
+    @param description_event  An FDE event, used to get the
+                              following information
                               -binlog_version
                               -server_version
                               -post_header_len
@@ -639,97 +646,6 @@ class Xid_event: public Binary_log_event
 #endif
 };
 
-
-/**
-  @class Rand_event
-
-  Logs random seed used by the next RAND(), and by PASSWORD() in 4.1.0.
-  4.1.1 does not need it (it's repeatable again) so this event needn't be
-  written in 4.1.1 for PASSWORD() (but the fact that it is written is just a
-  waste, it does not cause bugs).
-
-  The state of the random number generation consists of 128 bits,
-  which are stored internally as two 64-bit numbers.
-
-  @section Rand_event_binary_format Binary Format
-
-  The Post-Header for this event type is empty.  The Body has two
-  components:
-
-  <table>
-  <caption>Body for Rand_event</caption>
-
-  <tr>
-    <th>Name</th>
-    <th>Format</th>
-    <th>Description</th>
-  </tr>
-
-  <tr>
-    <td>seed1</td>
-    <td>8 byte unsigned integer</td>
-    <td>64 bit random seed1.</td>
-  </tr>
-
-  <tr>
-    <td>seed2</td>
-    <td>8 byte unsigned integer</td>
-    <td>64 bit random seed2.</td>
-  </tr>
-  </table>
-*/
-class Rand_event: public Binary_log_event
-{
-public:
-  unsigned long long seed1;
-  unsigned long long seed2;
-  enum Rand_event_data
-  {
-    RAND_SEED1_OFFSET= 0,
-    RAND_SEED2_OFFSET= 8
-  };
-
-  /**
-    This will initialize the instance variables seed1 & seed2, and set the
-    type_code as RAND_EVENT in the header object in Binary_log_event
-  */
-  Rand_event(unsigned long long seed1_arg, unsigned long long seed2_arg)
-    : Binary_log_event(RAND_EVENT)
-  {
-    seed1= seed1_arg;
-    seed2= seed2_arg;
-  }
-
-  /**
-    Written every time a statement uses the RAND() function; precedes other
-    events for the statement. Indicates the seed values to use for generating a
-    random number with RAND() in the next statement. This is written only before
-    a QUERY_EVENT and is not used with row-based logging
-
-    <pre>
-    The buffer layout for variable part is as follows:
-    +----------------------------------------------+
-    | value for first seed | value for second seed |
-    +----------------------------------------------+
-    </pre>
-    @param buf                Contains the serialized event.
-    @param description_event  An FDE event, used to get the following information
-                              -binlog_version
-                              -server_version
-                              -post_header_len
-                              -common_header_len
-                              The content of this object
-                              depends on the binlog-version currently in use.
-  */
-  Rand_event(const char* buf,
-             const Format_description_event *description_event);
-#ifndef HAVE_MYSYS
-  void print_event_info(std::ostream& info);
-  void print_long_info(std::ostream& info);
-#endif
-};
-
-
 /**
   @class Ignorable_event
 
@@ -767,7 +683,8 @@ class Ignorable_event: public Binary_log_event
   {}
   /*
    @param buf                Contains the serialized event.
-   @param description_event  An FDE event, used to get the following information
+   @param description_event  An FDE event, used to get the
+                             following information
                              -binlog_version
                              -server_version
                              -post_header_len
@@ -845,7 +762,10 @@ struct Uuid
    /// Set to all zeros.
   void clear() { memset(bytes, 0, BYTE_LENGTH); }
    /// Copies the given 16-byte data to this UUID.
-  void copy_from(const unsigned char *data) { memcpy(bytes, data, BYTE_LENGTH);}
+  void copy_from(const unsigned char *data)
+  {
+    memcpy(bytes, data, BYTE_LENGTH);
+  }
   /// Copies the given UUID object to this UUID.
   void copy_from(const Uuid &data) { copy_from((unsigned char *)data.bytes); }
   /// Copies the given UUID object to this UUID.
@@ -968,7 +888,8 @@ class Gtid_event: public Binary_log_event
 
     @param buffer             Contains the serialized event.
     @param event_len          Length of the serialized event.
-    @param description_event  An FDE event, used to get the following information
+    @param description_event  An FDE event, used to get the
+                              following information
                               -binlog_version
                               -server_version
                               -post_header_len
@@ -986,8 +907,8 @@ class Gtid_event: public Binary_log_event
     : commit_flag(commit_flag_arg)
   {}
 #ifndef HAVE_MYSYS
-  //TODO(WL#7684): Implement the method print_event_info and print_long_info for
-  //            all the events supported  in  MySQL Binlog
+  //TODO(WL#7684): Implement the method print_event_info and print_long_info
+  //               for all the events supported  in  MySQL Binlog
   void print_event_info(std::ostream& info) { }
   void print_long_info(std::ostream& info) { }
 #endif
@@ -1057,7 +978,8 @@ class Previous_gtids_event : public Binary_log_event
     </pre>
     @param buffer             Contains the serialized event.
     @param event_len          Length of the serialized event.
-    @param description_event  An FDE event, used to get the following information
+    @param description_event  An FDE event, used to get the
+                              following information
                               -binlog_version
                               -server_version
                               -post_header_len
@@ -1076,8 +998,8 @@ class Previous_gtids_event : public Binary_log_event
     : Binary_log_event(PREVIOUS_GTIDS_LOG_EVENT)
   {}
 #ifndef HAVE_MYSYS
-  //TODO(WL#7684): Implement the method print_event_info and print_long_info for
-  //            all the events supported  in  MySQL Binlog
+  //TODO(WL#7684): Implement the method print_event_info and print_long_info
+  //               for all the events supported  in  MySQL Binlog
   void print_event_info(std::ostream& info) { }
   void print_long_info(std::ostream& info) { }
 #endif
@@ -1133,7 +1055,8 @@ class Heartbeat_event: public Binary_log_event
 
     @param buf                Contains the serialized event.
     @param event_len          Length of the serialized event.
-    @param description_event  An FDE event, used to get the following information
+    @param description_event  An FDE event, used to get the
+                              following information
                               -binlog_version
                               -server_version
                               -post_header_len