Bug#35046862 Need a MYSQL_ADD_CLIENT_PLUGIN cmake macro for libmysql plugins

We already have a cmake macro MYSQL_ADD_PLUGIN, which takes an option
CLIENT_ONLY.  Change it to not add compile definition
MYSQL_DYNAMIC_PLUGIN to CLIENT_ONLY plugins.

Add a new option NO_UNDEFINED to MYSQL_ADD_PLUGIN.  It will add linker
flags -Wl,--no-undefined on non-sanitizer Linux builds.  Turn it ON
for all CLIENT_ONLY plugins to ensure there are no missing symbols.

The cmake code for "custom" SASL library would previously disable
KERBEROS completely if the provided SASL library was built without
KERBEROS.  Change this to only disable KERBEROS for the LDAP client
authentication plugin.

Extend the cmake option WITH_CUSTOM_LIBRARIES to also look for
"custom" CURL library. This is for easier testing of custom
SSL/KERBEROS/SASL/LDAP/CURL, which must all be provided together in
order to have a consistent build.

Change-Id: Iafd674297d459268f7bb3afa1e3140ff4cfb0478
(cherry picked from commit fa80793793f1253b5a78d5ad104d6eef835d1353)

Author: Tor Didriksen

CMakeLists.txt

@@ -1757,10 +1757,11 @@ IF(WITH_CUSTOM_LIBRARIES)
   FILE(GLOB WITH_KERBEROS "${WITH_CUSTOM_LIBRARIES}/krb5*")
   FILE(GLOB WITH_SASL     "${WITH_CUSTOM_LIBRARIES}/cyrus-sasl*")
   FILE(GLOB WITH_LDAP     "${WITH_CUSTOM_LIBRARIES}/openldap*")
-  FOREACH(WITH_OPT WITH_SSL WITH_KERBEROS WITH_SASL WITH_LDAP)
+  FILE(GLOB WITH_CURL     "${WITH_CUSTOM_LIBRARIES}/curl*")
+  FOREACH(WITH_OPT WITH_SSL WITH_KERBEROS WITH_SASL WITH_LDAP WITH_CURL)
     IF(IS_DIRECTORY ${${WITH_OPT}})
       SET(${WITH_OPT} ${${WITH_OPT}} CACHE INTERNAL "" FORCE)
-      MESSAGE(STATUS "${WITH_OPT} ${${WITH_SSL}}")
+      MESSAGE(STATUS "${WITH_OPT} ${${WITH_OPT}}")
     ELSE()
       MESSAGE(WARNING "${WITH_OPT} not found") # This should be FATAL_ERROR
     ENDIF()

cmake/plugin.cmake

@@ -29,6 +29,7 @@ MACRO(MYSQL_ADD_PLUGIN plugin_arg)
     DEFAULT_LEGACY_ENGINE
     MANDATORY       # not actually a plugin, always builtin
     MODULE_ONLY     # build only as shared library
+    NO_UNDEFINED    # add -Wl,--no-undefined on Linux, relevant for MODULE_ONLY
     SKIP_INSTALL
     STATIC_ONLY
     STORAGE_ENGINE
@@ -190,13 +191,24 @@ MACRO(MYSQL_ADD_PLUGIN plugin_arg)
       MY_TARGET_LINK_OPTIONS(${target}
         "LINKER:--compress-debug-sections=zlib")
     ENDIF()
-    SET_TARGET_PROPERTIES (${target} PROPERTIES PREFIX ""
-      COMPILE_DEFINITIONS "MYSQL_DYNAMIC_PLUGIN")
+    SET_TARGET_PROPERTIES (${target} PROPERTIES PREFIX "")
+
+    # CLIENT_ONLY plugins should have no undefined symbols.
+    IF(ARG_CLIENT_ONLY)
+      SET(ARG_NO_UNDEFINED ON)
+    ENDIF()
+
+    IF(ARG_NO_UNDEFINED AND LINK_FLAG_NO_UNDEFINED)
+      MY_TARGET_LINK_OPTIONS(${target} "${LINK_FLAG_NO_UNDEFINED}")
+    ENDIF()
+
     IF(WIN32_CLANG AND WITH_ASAN)
       TARGET_LINK_LIBRARIES(${target}
         "${ASAN_LIB_DIR}/clang_rt.asan_dll_thunk-x86_64.lib")
     ENDIF()
     IF(NOT ARG_CLIENT_ONLY)
+      SET_TARGET_PROPERTIES (${target} PROPERTIES
+        COMPILE_DEFINITIONS "MYSQL_DYNAMIC_PLUGIN")
       TARGET_LINK_LIBRARIES (${target} mysqlservices)
     ENDIF()
 

cmake/sasl.cmake

@@ -281,18 +281,11 @@ MACRO(MYSQL_CHECK_SASL_DLLS)
     STRING(REPLACE ";" " " SASL_DEPENDS_ON "${SASL_DEPENDS_ON}")
     IF(NOT SASL_DEPENDS_ON MATCHES "libkrb5")
       MESSAGE(WARNING "This SASL library is built without KERBEROS")
+      MESSAGE(WARNING "DEPENDENCIES are ${SASL_DEPENDS_ON}")
+      # Disable KERBEROS for LDAP client authentication plugin.
       SET(SASL_WITHOUT_KERBEROS 1)
-      UNSET(KERBEROS_CUSTOM_LIBRARY CACHE)
-      UNSET(KERBEROS_CUSTOM_LIBRARY)
-      UNSET(KERBEROS_FOUND CACHE)
-      UNSET(KERBEROS_FOUND)
-      UNSET(KERBEROS_LIBRARIES CACHE)
-      UNSET(KERBEROS_LIBRARIES)
       UNSET(KERBEROS_LIB_CONFIGURED CACHE)
       UNSET(KERBEROS_LIB_CONFIGURED)
-      UNSET(KERBEROS_SYSTEM_LIBRARY CACHE)
-      UNSET(KERBEROS_SYSTEM_LIBRARY)
-      SET(WITH_KERBEROS "none" CACHE STRING "" FORCE)
     ENDIF()
 
     COPY_CUSTOM_SHARED_LIBRARY("${SASL_CUSTOM_LIBRARY}" ""

libmysql/authentication_kerberos/CMakeLists.txt

@@ -51,8 +51,8 @@ IF((KERBEROS_INCLUDE_DIR AND GSSAPI_INCLUDE_DIR))
   SET(AUTH_CLIENT "gssapi_authentication_client.cc")
   SET(UTILITY "gssapi_utility.cc")
   SET(CORE "kerberos_core.cc")
-  SET(KERBEROS_LIB "${GSSAPI_LIBRARIES}")
-  LIST(APPEND KERBEROS_LIB "${KERBEROS_LIBRARIES}")
+  SET(KERBEROS_LIB ${GSSAPI_LIBRARIES})
+  LIST(APPEND KERBEROS_LIB ${KERBEROS_LIBRARIES})
   MESSAGE(STATUS "Using Kerberos libraries: ${KERBEROS_LIB}")
 ELSE()
   MESSAGE(WARNING
@@ -78,8 +78,6 @@ MYSQL_ADD_PLUGIN(authentication_kerberos_client
   ${CORE}
   ${UTILITY}
   LINK_LIBRARIES
-  # Uncomment to verify that all symbols are found.
-  # ${LINK_FLAG_NO_UNDEFINED}
   ${KERBEROS_LIB}
   ${SSL_LIBRARIES}
   ${LIBDL}

libmysql/authentication_kerberos/auth_kerberos_client_plugin.cc

@@ -23,25 +23,10 @@
 #include "my_config.h"
 
 /*
-  In case of kerberos authentication we need to fill user name as kerberos user
-  name if it is empty. We need to fill user name inside mysql->user, clients
-  uses my_strdup directly to create new string. To use MySQL alloc functions we
-  need to include "/mysql/service_mysql_alloc.h". Inside service_mysql_alloc.h
-  there is #define which forces all dynamic plugins to use MySQL malloc function
-  via services. Client side plugin cannot use any services as of now.   Code
-  check in service_mysql_alloc.h #ifdef MYSQL_DYNAMIC_PLUGIN #define my_strdup
-  mysql_malloc_service->my_strdup #else extern char *my_strdup(PSI_memory_key
-  key, const char *from, myf_t flags); #endif Client authentication plugin
-  defines MYSQL_DYNAMIC_PLUGIN. And this forces to use always my_strdup via
-  services. To use native direct my_strdup, we need to undefine
-  MYSQL_DYNAMIC_PLUGIN. And again define MYSQL_DYNAMIC_PLUGIN once correct
-  my_strdup are declared. service_mysql_alloc.h should provide proper fix like
-  Instead of #ifdef MYSQL_DYNAMIC_PLUGIN
-  #ifdef  MYSQL_DYNAMIC_PLUGIN  &&   ! MYSQL_CLIENT_PLUGIN
+  This is a CLIENT_ONLY plugin, so allocation functions are my_malloc,
+  my_free etc.
 */
-#undef MYSQL_DYNAMIC_PLUGIN
 #include <mysql/service_mysql_alloc.h>
-#define MYSQL_DYNAMIC_PLUGIN
 
 #include "auth_kerberos_client_plugin.h"
 

libmysql/authentication_ldap/CMakeLists.txt

@@ -54,7 +54,12 @@ ENDIF()
 
 DISABLE_MISSING_PROFILE_WARNING()
 
-IF(KERBEROS_FOUND AND (NOT WIN32))
+IF(SASL_WITHOUT_KERBEROS)
+  MESSAGE(WARNING "Bad custom SASL library")
+  MESSAGE(STATUS
+    "Building authentication_ldap_sasl_client WITHOUT Kerberos")
+  UNSET(LDAP_KERBEROS_LIBS)
+ELSEIF(KERBEROS_FOUND AND (NOT WIN32))
   MESSAGE(STATUS
     "Building authentication_ldap_sasl_client with Kerberos")
   IF(KERBEROS_INCLUDE_DIR)
@@ -79,8 +84,6 @@ MYSQL_ADD_PLUGIN(authentication_ldap_sasl_client
   log_client.cc
   LINK_LIBRARIES
   ${SASL_LIBRARY}
-  # Uncomment to verify that all symbols are found.
-  # ${LINK_FLAG_NO_UNDEFINED}
   ${LDAP_KERBEROS_LIBS}
   ${SSL_LIBRARIES}
   ${LIBDL}

libmysql/authentication_ldap/auth_ldap_sasl_client.cc

@@ -23,26 +23,11 @@
 #include "my_config.h"
 
 /*
-  In case of Kerberos authentication we need to fill user name as Kerberos user
-  name if it is empty. We need to fill user name inside mysql->user, clients
-  uses my_strdup directly to create new string. To use MySQL alloc functions we
-  need to include "/mysql/service_mysql_alloc.h". Inside service_mysql_alloc.h
-  there is #define which forces all dynamic plugins to use MySQL malloc function
-  via services. Client side plugin cannot use any services as of now.   Code
-  check in service_mysql_alloc.h #ifdef MYSQL_DYNAMIC_PLUGIN #define my_strdup
-  mysql_malloc_service->my_strdup #else extern char *my_strdup(PSI_memory_key
-  key, const char *from, myf_t flags); #endif Client authentication plugin
-  defines MYSQL_DYNAMIC_PLUGIN. And this forces to use always my_strdup via
-  services. To use native direct my_strdup, we need to undefine
-  MYSQL_DYNAMIC_PLUGIN. And again define MYSQL_DYNAMIC_PLUGIN once correct
-  my_strdup are declared. service_mysql_alloc.h should provide proper fix like
-  Instead of #ifdef MYSQL_DYNAMIC_PLUGIN
-  #ifdef  MYSQL_DYNAMIC_PLUGIN  &&   ! MYSQL_CLIENT_PLUGIN
+  This is a CLIENT_ONLY plugin, so allocation functions are my_malloc,
+  my_free etc.
 */
 #if defined(KERBEROS_LIB_CONFIGURED)
-#undef MYSQL_DYNAMIC_PLUGIN
 #include <mysql/service_mysql_alloc.h>
-#define MYSQL_DYNAMIC_PLUGIN
 #endif
 
 #include <stdio.h>