Bug#36452427 add Windows versioninfo resource to Router binaries

On windows all shared libraries and executables are expected to contain

- version-info
- product-name
- copyright notice

For the server this is implemented via a resource-file which is added
via ADD_VERSION_INFO() in cmake.

As Router is its own product, it needs its own resource-file to be
linked into all shared libraries, plugins and executables.

Change
======

- added extra argument to ADD_VERSION_INFO() select resource-files
  per cmake-COMPONENT
- added ROUTER_ADD_SHARED_LIBRARY() as wrapper around
  ADD_SHARED_LIBRARY()
- added NAMELINK_SKIP to ADD_SHARED_LIBRARY()
- refactored all router's shared libraries to use
  MYSQL_ADD_SHARED_LIBRARY() to simplify creating libraries and add
  version-info to all shared libs
- renamed harness-library.ddl to mysqlharness.dll

Change-Id: I8d700c22ec1522d9aaae80685eed3de3d490a12d

Author: weigon

cmake/component.cmake

@@ -73,7 +73,7 @@ MACRO(MYSQL_ADD_COMPONENT component_arg)
     MESSAGE(FATAL_ERROR "Unknown component type ${target}")
   ENDIF()
 
-  ADD_VERSION_INFO(${target} ${kind} SOURCES)
+  ADD_VERSION_INFO(${target} ${kind} SOURCES "")
   ADD_LIBRARY(${target} ${kind} ${SOURCES})
 
   TARGET_COMPILE_DEFINITIONS(${target} PUBLIC MYSQL_COMPONENT)

cmake/libutils.cmake

@@ -315,7 +315,7 @@ MACRO(MERGE_LIBRARIES_SHARED TARGET_ARG)
   ENDIF()
 
   IF(NOT ARG_SKIP_INSTALL)
-    ADD_VERSION_INFO(${TARGET} SHARED SRC)
+    ADD_VERSION_INFO(${TARGET} SHARED SRC "")
   ENDIF()
   ADD_LIBRARY(${TARGET} SHARED ${SRC})
 
@@ -582,6 +582,7 @@ FUNCTION(ADD_SHARED_LIBRARY TARGET_ARG)
     EXCLUDE_FROM_ALL
     NO_UNDEFINED
     SKIP_INSTALL
+    NAMELINK_SKIP
   )
   SET(LIBRARY_ONE_VALUE_KW
     COMPONENT
@@ -610,6 +611,11 @@ FUNCTION(ADD_SHARED_LIBRARY TARGET_ARG)
   SET(TARGET ${TARGET_ARG})
   SET(SOURCES ${ARG_UNPARSED_ARGUMENTS})
 
+  IF(NOT ARG_SKIP_INSTALL AND ARG_COMPONENT STREQUAL "Router")
+    # add the version-info resource file to SOURCES
+    ADD_VERSION_INFO(${TARGET} SHARED SOURCES Router)
+  ENDIF()
+
   ADD_LIBRARY(${TARGET} SHARED ${SOURCES})
   TARGET_COMPILE_FEATURES(${TARGET} PUBLIC cxx_std_20)
 
@@ -643,8 +649,11 @@ FUNCTION(ADD_SHARED_LIBRARY TARGET_ARG)
     ELSE()
       SET(COMP COMPONENT SharedLibraries)
     ENDIF()
-    MYSQL_INSTALL_TARGET(
-      ${TARGET} DESTINATION "${DESTINATION}" ${COMP})
+    IF(ARG_NAMELINK_SKIP)
+      SET(INSTALL_ARGS NAMELINK_SKIP)
+    ENDIF()
+    MYSQL_INSTALL_TARGET(${TARGET} DESTINATION "${DESTINATION}" ${COMP}
+      ${INSTALL_ARGS})
   ENDIF()
 
   IF(ARG_COMPILE_DEFINITIONS)

cmake/mysql_add_executable.cmake

@@ -123,7 +123,11 @@ FUNCTION(MYSQL_ADD_EXECUTABLE target_arg)
       ${CMAKE_BINARY_DIR}/runtime_output_directory)
   ENDIF()
 
-  ADD_VERSION_INFO(${target} EXECUTABLE sources)
+  IF(ARG_COMPONENT)
+    ADD_VERSION_INFO(${target} EXECUTABLE sources "${ARG_COMPONENT}")
+  ELSE()
+    ADD_VERSION_INFO(${target} EXECUTABLE sources "")
+  ENDIF()
 
   ADD_EXECUTABLE(${target} ${sources})
   TARGET_COMPILE_FEATURES(${target} PUBLIC cxx_std_20)

cmake/package_name.cmake

@@ -181,15 +181,39 @@ IF(MSVC)
   CONFIGURE_FILE(${MYSQL_CMAKE_SCRIPT_DIR}/versioninfo.rc.in
     ${CMAKE_BINARY_DIR}/versioninfo_dll.rc)
 
-  FUNCTION(ADD_VERSION_INFO target target_type sources_var)
+  SET(VINFO_PRODUCT_NAME "MySQL Router")
+
+  SET(FILETYPE VFT_APP)
+  CONFIGURE_FILE(${MYSQL_CMAKE_SCRIPT_DIR}/versioninfo.rc.in
+    ${CMAKE_BINARY_DIR}/router_versioninfo_exe.rc)
+
+  SET(FILETYPE VFT_DLL)
+  CONFIGURE_FILE(${MYSQL_CMAKE_SCRIPT_DIR}/versioninfo.rc.in
+    ${CMAKE_BINARY_DIR}/router_versioninfo_dll.rc)
+
+  # ADD_VERSION_INFO: add version info the executables/shared libraries on windows
+  #
+  # @param target       targetname [ignored]
+  # @param target_type  type of the target: SHARED|MODULE|EXE
+  # @param sources_var  caller's variable name to append the rc-files to
+  # @param component    component name
+  #
+  FUNCTION(ADD_VERSION_INFO target target_type sources_var component)
+    IF(component STREQUAL "Router")
+      SET(exe_rc_file ${CMAKE_BINARY_DIR}/router_versioninfo_exe.rc)
+      SET(dll_rc_file ${CMAKE_BINARY_DIR}/router_versioninfo_dll.rc)
+    ELSE()
+      SET(exe_rc_file ${CMAKE_BINARY_DIR}/versioninfo_exe.rc)
+      SET(dll_rc_file ${CMAKE_BINARY_DIR}/versioninfo_dll.rc)
+    ENDIF()
+
     IF("${target_type}" MATCHES "SHARED" OR "${target_type}" MATCHES "MODULE")
-      SET(rcfile ${CMAKE_BINARY_DIR}/versioninfo_dll.rc)
+      SET(rcfile ${dll_rc_file})
     ELSEIF("${target_type}" MATCHES "EXE")
-      SET(rcfile ${CMAKE_BINARY_DIR}/versioninfo_exe.rc)
+      SET(rcfile ${exe_rc_file})
     ENDIF()
     SET(${sources_var} ${${sources_var}} ${rcfile} PARENT_SCOPE)
   ENDFUNCTION()
-
 ELSE()
   FUNCTION(ADD_VERSION_INFO)
   ENDFUNCTION()

cmake/plugin.cmake

@@ -191,7 +191,7 @@ MACRO(MYSQL_ADD_PLUGIN plugin_arg)
       ENDIF()
     ENDIF()
 
-    ADD_VERSION_INFO(${target} MODULE SOURCES)
+    ADD_VERSION_INFO(${target} MODULE SOURCES "")
     ADD_LIBRARY(${target} MODULE ${SOURCES}) 
     IF(COMPRESS_DEBUG_SECTIONS)
       MY_TARGET_LINK_OPTIONS(${target}

router/cmake/Plugin.cmake

@@ -78,6 +78,10 @@ FUNCTION(add_harness_plugin NAME)
     SET(_option_LOG_DOMAIN "\"${NAME}\"")
   ENDIF()
 
+  IF(NOT _option_NO_INSTALL)
+    ADD_VERSION_INFO(${NAME} SHARED _option_SOURCES Router)
+  ENDIF()
+
   # Add the library and ensure that the name is good for the plugin
   # system (no "lib" before). We are using SHARED libraries since we
   # intend to link against it, which is something that MODULE does not
@@ -169,3 +173,115 @@ FUNCTION(add_harness_plugin NAME)
     ENDIF()
   ENDIF()
 ENDFUNCTION(add_harness_plugin)
+
+#
+# ROUTER_ADD_SHARED_LIBRARY(target sources [opts])
+#
+# @param target  targetname of the created shared library.
+# @param sources source files of the shared library target.
+# @param opts    extra options
+#
+# - creates a shared library "target"
+# - with OUTPUT_NAME (default target-name)
+# - installs into $ROUTER_INSTALL_LIBDIR (if SKIP_INSTALL is not specified)
+# - generates a export-header in bindir/../include/mysqlrouter/{target}_export.h
+#
+# Options
+# =======
+#
+# All options of ADD_SHARED_LIBRARY() are supported.
+#
+# Additionally,
+#
+# NO_EXPORT_HEADER
+# :  do not generate a export-headers for the shared library.
+#    default: generate a export-header
+#
+# PREFIX
+# :  PREFIX of the shared library name (cmake property)
+#
+# OUTPUT_NAME
+# :  OUTPUT_NAME of the shared library (cmake property)
+#    default: targetname
+#
+# SOVERSION
+# :  SOVERSION of the shared library (cmake property)
+#    default: 1
+#
+# DESTINATION
+# :  DESTINATION of the shared library (see MYSQL_INSTALL_TARGET)
+#    default: $ROUTER_INSTALL_BINDIR on windows, $ROUTER_INSTALL_LIBDIR otherwise
+
+
+FUNCTION(ROUTER_ADD_SHARED_LIBRARY TARGET)
+  SET(_options
+    NO_EXPORT_HEADER
+    )
+  SET(_single_value
+    COMPONENT
+    DESTINATION
+    PREFIX
+    SOVERSION
+    )
+  SET(_multi_value
+    INCLUDE_DIRECTORIES
+    )
+  CMAKE_PARSE_ARGUMENTS(_option
+    "${_options}" "${_single_value}" "${_multi_value}" ${ARGN})
+
+  SET(ARGS ${_option_UNPARSED_ARGUMENTS})
+  IF(NOT DEFINED _option_SOVERSION)
+    LIST(APPEND ARGS SOVERSION 1)
+  ELSE()
+    LIST(APPEND ARGS SOVERSION ${_option_SOVERSION})
+  ENDIF()
+  IF(NOT DEFINED _option_COMPONENT)
+    LIST(APPEND ARGS COMPONENT Router)
+  ELSE()
+    LIST(APPEND ARGS COMPONENT ${_option_COMPONENT})
+  ENDIF()
+  IF(NOT DEFINED _option_INCLUDE_DIRECTORIES)
+    LIST(APPEND ARGS INCLUDE_DIRECTORIES ${CMAKE_CURRENT_SOURCE_DIR})
+  ELSE()
+    LIST(APPEND ARGS INCLUDE_DIRECTORIES ${_option_INCLUDE_DIRECTORIES})
+  ENDIF()
+  IF(NOT DEFINED _option_DESTINATION)
+    # ADD_SHARED_LIBRARY calls MYSQL_INSTALL_TARGET which only knows
+    # about a single DESTINATIONS, but we want
+    # - .dll's in the BINDIR and
+    # - .so in the LIBDIR.
+    IF(WIN32)
+      LIST(APPEND ARGS DESTINATION ${ROUTER_INSTALL_BINDIR})
+    ELSE()
+      LIST(APPEND ARGS DESTINATION ${ROUTER_INSTALL_LIBDIR})
+    ENDIF()
+  ELSE()
+    LIST(APPEND ARGS DESTINATION ${_option_DESTINATION})
+  ENDIF()
+
+  ADD_SHARED_LIBRARY(${TARGET} ${ARGS}
+    NAMELINK_SKIP
+    )
+
+  ADD_INSTALL_RPATH_FOR_OPENSSL(${TARGET})
+  SET_PATH_TO_CUSTOM_SSL_FOR_APPLE(${TARGET})
+
+  IF(_option_PREFIX)
+    SET_TARGET_PROPERTIES(${TARGET} PROPERTIES
+      PREFIX "${_option_PREFIX}"
+    )
+  ENDIF()
+
+  IF(NOT _option_NO_EXPORT_HEADER)
+    TARGET_INCLUDE_DIRECTORIES(${TARGET}
+      PUBLIC
+      ${CMAKE_CURRENT_SOURCE_DIR}/../include/
+      ${CMAKE_CURRENT_BINARY_DIR}/../include/
+      )
+    GENERATE_EXPORT_HEADER(${TARGET}
+      EXPORT_FILE_NAME
+      ${CMAKE_CURRENT_BINARY_DIR}/../include/mysqlrouter/${TARGET}_export.h
+      )
+  ENDIF()
+
+ENDFUNCTION()

router/cmake/testing.cmake

@@ -119,6 +119,7 @@ FUNCTION(_ADD_TEST_FILE FILE)
   SET(test_name "${test_target}")
   MYSQL_ADD_EXECUTABLE(${test_target}
     ${FILE} ${TEST_EXTRA_SOURCES}
+    COMPONENT Router
     ADD_TEST ${test_name})
 
   ADD_DEPENDENCIES(mysqlrouter_all ${test_target})
@@ -261,7 +262,9 @@ FUNCTION(STATICLIB_FROM_TARGET TO FROM)
 
   SET(_LIB_SOURCES)
   FOREACH(F ${_SOURCES})
-    LIST(APPEND _LIB_SOURCES ${_SOURCE_DIR}/${F})
+    IF(NOT ${F} MATCHES ".*\\.rc")
+      LIST(APPEND _LIB_SOURCES ${_SOURCE_DIR}/${F})
+    ENDIF()
   ENDFOREACH()
 
   ADD_LIBRARY(${TO}

router/src/connection_pool/src/CMakeLists.txt

@@ -25,45 +25,22 @@ INCLUDE(GenerateExportHeader)
 
 # connection pool library
 
-ADD_LIBRARY(connection_pool SHARED
+ROUTER_ADD_SHARED_LIBRARY(connection_pool
   connection_pool.cc
   connection_pool_component.cc
-  )
-TARGET_LINK_LIBRARIES(connection_pool
+
+  OUTPUT_NAME "mysqlrouter_connection_pool"
+
+  LINK_LIBRARIES
   PUBLIC
   harness_stdx
   harness_net_ts
   mysql_protocol
   routing_connections
+
   PRIVATE
   OpenSSL::SSL OpenSSL::Crypto
   )
-TARGET_INCLUDE_DIRECTORIES(connection_pool PRIVATE
-  ${CMAKE_CURRENT_SOURCE_DIR}
-  PUBLIC
-  ${CMAKE_CURRENT_SOURCE_DIR}/../include/
-  ${CMAKE_CURRENT_BINARY_DIR}/../include/
-  )
-GENERATE_EXPORT_HEADER(connection_pool
-  EXPORT_FILE_NAME
-  ${CMAKE_CURRENT_BINARY_DIR}/../include/mysqlrouter/connection_pool_export.h
-  )
-
-SET_TARGET_PROPERTIES(connection_pool PROPERTIES
-  OUTPUT_NAME "mysqlrouter_connection_pool"
-  SOVERSION 1
-  RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/runtime_output_directory
-  LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/library_output_directory)
-
-ADD_INSTALL_RPATH_FOR_OPENSSL(connection_pool)
-SET_PATH_TO_CUSTOM_SSL_FOR_APPLE(connection_pool)
-
-INSTALL(TARGETS connection_pool
-  RUNTIME DESTINATION ${ROUTER_INSTALL_BINDIR} COMPONENT Router
-  ARCHIVE DESTINATION ${ROUTER_INSTALL_LIBDIR} COMPONENT Router
-  LIBRARY DESTINATION ${ROUTER_INSTALL_LIBDIR} COMPONENT Router
-  NAMELINK_SKIP
-  )
 
 # connection pool plugin
 

router/src/destination_status/src/CMakeLists.txt

@@ -25,41 +25,16 @@ INCLUDE(GenerateExportHeader)
 
 # destination status library
 
-ADD_LIBRARY(destination_status SHARED
+ROUTER_ADD_SHARED_LIBRARY(destination_status
   unreachable_destinations_quarantine.cc
   destination_status_component.cc
-  )
-TARGET_LINK_LIBRARIES(destination_status
+
+  LINK_LIBRARIES
   PUBLIC
   harness_stdx
   router_lib
-  )
 
-TARGET_INCLUDE_DIRECTORIES(destination_status PRIVATE
-  ${CMAKE_CURRENT_SOURCE_DIR}
-  PUBLIC
-  ${CMAKE_CURRENT_SOURCE_DIR}/../include/
-  ${CMAKE_CURRENT_BINARY_DIR}/../include/
-  )
-GENERATE_EXPORT_HEADER(destination_status
-  EXPORT_FILE_NAME
-  ${CMAKE_CURRENT_BINARY_DIR}/../include/mysqlrouter/destination_status_export.h
-  )
-
-SET_TARGET_PROPERTIES(destination_status PROPERTIES
   OUTPUT_NAME "mysqlrouter_destination_status"
-  SOVERSION 1
-  RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/runtime_output_directory
-  LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/library_output_directory)
-
-#ADD_INSTALL_RPATH_FOR_OPENSSL(destination_status)
-#SET_PATH_TO_CUSTOM_SSL_FOR_APPLE(destination_status)
-
-INSTALL(TARGETS destination_status
-  RUNTIME DESTINATION ${ROUTER_INSTALL_BINDIR} COMPONENT Router
-  ARCHIVE DESTINATION ${ROUTER_INSTALL_LIBDIR} COMPONENT Router
-  LIBRARY DESTINATION ${ROUTER_INSTALL_LIBDIR} COMPONENT Router
-  NAMELINK_SKIP
   )
 
 # destination status plugin