Bug #16021844: ABI CHECK NOT IMPLEMENTED ON WINDOWS

Implement ABI check run on windows using WSL (gcc and sed).

RB#27025

Author: Daniel Blanchard

Diff for: cmake/abi_check.cmake

@@ -18,78 +18,93 @@
 #
 # 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 
- 
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
+
 #
 # Headers which need to be checked for abi/api compatibility are in
 # API_PREPROCESSOR_HEADER. plugin.h is tested implicitly via
 # plugin_audit.h and plugin_ftparser.h.
 #
-# We use gcc specific preprocessing command and sed/diff, so it will 
-# only be run  on Unix and only if gcc is used. On some Unixes,
-# (Solaris) sed or diff might act differently from GNU, so we run only 
+# We use gcc specific preprocessing command and sed/diff, so it will
+# only be run on Unix and only if gcc is used. On some Unixes,
+# (Solaris) sed or diff might act differently from GNU, so we run only
 # on systems we can trust.
+# On Windows we use the Windows subsystem for Linux and gcc and sed
+# installed in it, if available.
 IF(LINUX)
   SET(RUN_ABI_CHECK 1)
+ELSEIF(WIN32)
+  FIND_PROGRAM(WSL_EXECUTABLE wsl HINTS C:/Windows/Sysnative)
+  IF (WSL_EXECUTABLE)
+    SET (COMPILER "gcc")
+    SET(RUN_ABI_CHECK 1)
+    MESSAGE(STATUS "Will do ABI check using ${WSL_EXECUTABLE} (gcc/sed)")
+  ELSE()
+    SET(RUN_ABI_CHECK 0)
+  ENDIF()
 ELSE()
   SET(RUN_ABI_CHECK 0)
 ENDIF()
 
-IF(MY_COMPILER_IS_GNU AND RUN_ABI_CHECK)
+SET(API_PREPROCESSOR_HEADER
+  ${CMAKE_SOURCE_DIR}/include/mysql/plugin_audit.h
+  ${CMAKE_SOURCE_DIR}/include/mysql/plugin_ftparser.h
+  ${CMAKE_SOURCE_DIR}/include/mysql.h
+  ${CMAKE_SOURCE_DIR}/include/mysql/client_plugin.h
+  ${CMAKE_SOURCE_DIR}/include/mysql/plugin_auth.h
+  ${CMAKE_SOURCE_DIR}/include/mysql/plugin_keyring.h
+)
+IF(NOT WITHOUT_SERVER)
+  SET(API_PREPROCESSOR_HEADER
+    ${API_PREPROCESSOR_HEADER}
+    ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_thread_v1.h
+    ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_mutex_v1.h
+    ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_rwlock_v1.h
+    ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_cond_v1.h
+    ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_file_v1.h
+    ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_socket_v1.h
+    ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_table_v1.h
+    ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_mdl_v1.h
+    ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_idle_v1.h
+    ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_stage_v1.h
+    ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_statement_v1.h
+    ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_transaction_v1.h
+    ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_memory_v1.h
+    ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_error_v1.h
+    ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_system_v1.h
+    ${CMAKE_SOURCE_DIR}/include/mysql/services.h
+  )
+ENDIF()
+
+IF(MY_COMPILER_IS_GNU)
   IF(CMAKE_C_COMPILER MATCHES "ccache$")
     SET(COMPILER ${CMAKE_C_COMPILER_ARG1})
     STRING(REGEX REPLACE "^ " "" COMPILER ${COMPILER})
   ELSE()
     SET(COMPILER ${CMAKE_C_COMPILER})
   ENDIF()
-  SET(API_PREPROCESSOR_HEADER
-    ${CMAKE_SOURCE_DIR}/include/mysql/plugin_audit.h
-    ${CMAKE_SOURCE_DIR}/include/mysql/plugin_ftparser.h
-    ${CMAKE_SOURCE_DIR}/include/mysql.h
-    ${CMAKE_SOURCE_DIR}/include/mysql/client_plugin.h
-    ${CMAKE_SOURCE_DIR}/include/mysql/plugin_auth.h
-    ${CMAKE_SOURCE_DIR}/include/mysql/plugin_keyring.h
-  )
-  IF(NOT WITHOUT_SERVER)
-    SET(API_PREPROCESSOR_HEADER
-      ${API_PREPROCESSOR_HEADER}
-      ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_thread_v1.h
-      ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_mutex_v1.h
-      ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_rwlock_v1.h
-      ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_cond_v1.h
-      ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_file_v1.h
-      ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_socket_v1.h
-      ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_table_v1.h
-      ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_mdl_v1.h
-      ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_idle_v1.h
-      ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_stage_v1.h
-      ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_statement_v1.h
-      ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_transaction_v1.h
-      ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_memory_v1.h
-      ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_error_v1.h
-      ${CMAKE_SOURCE_DIR}/include/mysql/psi/psi_abi_system_v1.h
-      ${CMAKE_SOURCE_DIR}/include/mysql/services.h
-    )
-  ENDIF()
+ENDIF()
 
+IF(RUN_ABI_CHECK)
   ADD_CUSTOM_TARGET(abi_check ALL
-  COMMAND ${CMAKE_COMMAND} 
+  COMMAND ${CMAKE_COMMAND}
     -DCOMPILER=${COMPILER}
     -DSOURCE_DIR=${CMAKE_SOURCE_DIR}
     -DBINARY_DIR=${CMAKE_BINARY_DIR}
+    -DWSL_EXECUTABLE=${WSL_EXECUTABLE}
     "-DABI_HEADERS=${API_PREPROCESSOR_HEADER}"
     -P ${CMAKE_SOURCE_DIR}/cmake/do_abi_check.cmake
     VERBATIM
   )
 
   ADD_CUSTOM_TARGET(abi_check_all
-  COMMAND ${CMAKE_COMMAND} 
-    -DCOMPILER=${COMPILER} 
+  COMMAND ${CMAKE_COMMAND}
+    -DCOMPILER=${COMPILER}
     -DSOURCE_DIR=${CMAKE_SOURCE_DIR}
     -DBINARY_DIR=${CMAKE_BINARY_DIR}
+    -DWSL_EXECUTABLE=${WSL_EXECUTABLE}
     "-DABI_HEADERS=${API_PREPROCESSOR_HEADER}"
     -P ${CMAKE_SOURCE_DIR}/cmake/do_abi_check.cmake
     VERBATIM
   )
 ENDIF()
-

Diff for: cmake/do_abi_check.cmake

@@ -1,5 +1,5 @@
 # Copyright (c) 2009, 2021, 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.
@@ -18,7 +18,7 @@
 #
 # 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 
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
 
 #
 # Rules for checking that the abi/api has not changed.
@@ -31,7 +31,7 @@
 #    results in messages in stderr saying that these headers
 #    were not found. Redirect the stderr output to /dev/null
 #    to prevent seeing these messages.
-# 2) sed the output to 
+# 2) sed the output to
 #    2.1) remove blank lines and lines that begin with "# "
 #    2.2) When gcc -E is run on the Mac OS  and solaris sparc platforms it
 #         introduces a line of output that shows up as a difference between
@@ -53,25 +53,45 @@
 # leave a <build directory>/abi_check.out file.
 #
 # A developer with a justified API change will then do a
-# mv <build directory>/abi_check.out include/mysql/plugin.pp 
+# mv <build directory>/abi_check.out include/mysql/plugin.pp
 # to replace the old canons with the new ones.
 #
 
 SET(abi_check_out ${BINARY_DIR}/abi_check.out)
 
+
+SET(ABI_SOURCE_DIR ${SOURCE_DIR})
+SET(ABI_BINARY_DIR ${BINARY_DIR})
+
+# If we're using WSL on Windows, we have to translate paths using wslpath
+IF(WSL_EXECUTABLE)
+  EXECUTE_PROCESS(
+    COMMAND ${WSL_EXECUTABLE} wslpath ${ABI_SOURCE_DIR}
+    OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_VARIABLE ABI_SOURCE_DIR)
+  EXECUTE_PROCESS(
+    COMMAND ${WSL_EXECUTABLE} wslpath ${ABI_BINARY_DIR}
+    OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_VARIABLE ABI_BINARY_DIR)
+ENDIF()
+
 FOREACH(file ${ABI_HEADERS})
   GET_FILENAME_COMPONENT(header_basename ${file} NAME)
   SET(tmpfile ${BINARY_DIR}/${header_basename}.pp.tmp)
+  SET(abi_file ${file})
+  IF(WSL_EXECUTABLE)
+    EXECUTE_PROCESS(
+      COMMAND ${WSL_EXECUTABLE} wslpath ${abi_file}
+      OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_VARIABLE abi_file)
+  ENDIF()
 
   EXECUTE_PROCESS(
-    COMMAND ${COMPILER} 
-      -E -nostdinc -dI -DMYSQL_ABI_CHECK -I${SOURCE_DIR}/include
-      -I${BINARY_DIR}/include -I${SOURCE_DIR}/include/mysql -I${SOURCE_DIR}/sql
-      -I${SOURCE_DIR}/libbinlogevents/export
-      ${file} 
+    COMMAND ${WSL_EXECUTABLE} ${COMPILER}
+      -E -nostdinc -dI -DMYSQL_ABI_CHECK -I${ABI_SOURCE_DIR}/include
+      -I${ABI_BINARY_DIR}/include -I${ABI_SOURCE_DIR}/include/mysql
+      -I${ABI_SOURCE_DIR}/sql -I${ABI_SOURCE_DIR}/libbinlogevents/export
+      ${abi_file}
       ERROR_QUIET OUTPUT_FILE ${tmpfile})
   EXECUTE_PROCESS(
-    COMMAND sed -e "/^# /d"
+    COMMAND ${WSL_EXECUTABLE} sed -e "/^# /d"
                 -e "/^[	]*$/d"
                 -e "/^#pragma GCC set_debug_pwd/d"
                 -e "/^#ident/d"
@@ -83,9 +103,8 @@ FOREACH(file ${ABI_HEADERS})
   EXECUTE_PROCESS(
     COMMAND diff -w ${file}.pp ${abi_check_out} RESULT_VARIABLE result)
   IF(NOT ${result} EQUAL 0)
-    MESSAGE(FATAL_ERROR 
+    MESSAGE(FATAL_ERROR
       "ABI check found difference between ${file}.pp and ${abi_check_out}")
   ENDIF()
   FILE(REMOVE ${abi_check_out})
 ENDFOREACH()
-

Diff for: include/my_inttypes.h

@@ -39,12 +39,12 @@
 #include <sys/types.h>
 #endif
 
-#ifdef _WIN32
+#if defined(_WIN32) && !defined(MYSQL_ABI_CHECK)
 #include <BaseTsd.h>
 typedef unsigned int uint;
 typedef unsigned short ushort;
 #endif
-#if !defined(HAVE_ULONG)
+#if !defined(HAVE_ULONG) && !defined(MYSQL_ABI_CHECK)
 typedef unsigned long ulong; /* Short for unsigned long */
 #endif
 
@@ -101,15 +101,15 @@ typedef int myf; /* Type of MyFlags in my_funcs */
 /* Length of decimal number represented by INT64. */
 #define MY_INT64_NUM_DECIMAL_DIGITS 21U
 
-#ifdef _WIN32
+#if defined(_WIN32) && !defined(MYSQL_ABI_CHECK)
 typedef SSIZE_T ssize_t;
 #endif
 
 /*
   This doesn't really belong here, but it was the only reasonable place
   at the time.
 */
-#ifdef _WIN32
+#if defined(_WIN32) && !defined(MYSQL_ABI_CHECK)
 typedef int sigset_t;
 #endif
 

Diff for: include/mysql.h

@@ -54,21 +54,21 @@ typedef uint64_t my_ulonglong;
 
 #ifndef my_socket_defined
 #define my_socket_defined
-#ifdef _WIN32
+#if defined(_WIN32) && !defined(MYSQL_ABI_CHECK)
 #include <windows.h>
 #ifdef WIN32_LEAN_AND_MEAN
 #include <winsock2.h>
 #endif
 #define my_socket SOCKET
 #else
 typedef int my_socket;
-#endif /* _WIN32 */
+#endif /* _WIN32 && ! MYSQL_ABI_CHECK */
 #endif /* my_socket_defined */
 
 // Small extra definition to avoid pulling in my_compiler.h in client code.
 // IWYU pragma: no_include "my_compiler.h"
 #ifndef MY_COMPILER_INCLUDED
-#if !defined(_WIN32)
+#if !defined(_WIN32) || defined(MYSQL_ABI_CHECK)
 #define STDCALL
 #else
 #define STDCALL __stdcall

Diff for: include/mysql/components/services/my_io_bits.h

@@ -28,7 +28,7 @@
   Types to make file and socket I/O compatible.
 */
 
-#ifdef _WIN32
+#if defined(_WIN32) && !defined(MYSQL_ABI_CHECK)
 /* Include common headers.*/
 #include <io.h> /* access(), chmod() */
 #ifdef WIN32_LEAN_AND_MEAN
@@ -48,7 +48,7 @@
 #endif
 
 typedef int File; /* File descriptor */
-#ifdef _WIN32
+#if defined(_WIN32) && !defined(MYSQL_ABI_CHECK)
 typedef int MY_MODE;
 typedef int mode_t;
 typedef int socket_len_t;

Diff for: include/mysql/components/services/my_thread_bits.h

@@ -37,7 +37,7 @@
 #endif
 #endif /* MYSQL_ABI_CHECK */
 
-#ifdef _WIN32
+#if defined(_WIN32) && !defined(MYSQL_ABI_CHECK)
 typedef DWORD my_thread_t;
 typedef struct thread_attr {
   DWORD dwStackSize;
@@ -50,7 +50,7 @@ typedef pthread_attr_t my_thread_attr_t;
 
 struct my_thread_handle {
   my_thread_t thread{0};
-#ifdef _WIN32
+#if defined(_WIN32) && !defined(MYSQL_ABI_CHECK)
   HANDLE handle{INVALID_HANDLE_VALUE};
 #endif
 };

Diff for: include/mysql/plugin_auth_common.h

@@ -110,7 +110,7 @@ authenticated_as when proxy mapping should be done by the server.
   We need HANDLE definition if on Windows. Define WIN32_LEAN_AND_MEAN (if
   not already done) to minimize amount of imported declarations.
 */
-#ifdef _WIN32
+#if defined(_WIN32) && !defined(MYSQL_ABI_CHECK)
 #ifndef WIN32_LEAN_AND_MEAN
 #define WIN32_LEAN_AND_MEAN
 #endif
@@ -126,7 +126,7 @@ struct MYSQL_PLUGIN_VIO_INFO {
     MYSQL_VIO_MEMORY
   } protocol;
   int socket; /**< it's set, if the protocol is SOCKET or TCP */
-#ifdef _WIN32
+#if defined(_WIN32) && !defined(MYSQL_ABI_CHECK)
   HANDLE handle; /**< it's set, if the protocol is PIPE or MEMORY */
 #endif
 };