Skip to content

[ML] Generate windows resource files using CMake functionality #2321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 23, 2022
Merged

[ML] Generate windows resource files using CMake functionality #2321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4764513
[ML] Generate windows resource files in a portable way
edsavage Jun 22, 2022
757b24a
[ML] Add additional incremental_training files
edsavage Jun 22, 2022
452f28c
[ML] Generate windows resource files in a portable way
edsavage Jun 22, 2022
161299c
Merge branch 'cmake_generate_windows_resource_files' of github.com:ed…
edsavage Jun 22, 2022
65985c8
Fix syntax error
edsavage Jun 22, 2022
247322f
Attend to review comments
edsavage Jun 22, 2022
dd29063
Update mk/ml.rc.in
edsavage Jun 23, 2022
f38b0a7
Attend to review comments
edsavage Jun 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 59 additions & 17 deletions cmake/functions.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,55 @@ endif()
# that is linked into the Windows executables
#
function(ml_generate_resources _target)
if(NOT WIN32)
return()

set(ML_VERSION_STR "${ML_VERSION_NUM}")

if(ENV{VERSION_QUALIFIER})
set(ML_VERSION_STR "${ML_VERSION_STR}-$ENV{VERSION_QUALIFIER}")
endif()

if(NOT ENV{SNAPSHOT} STREQUAL no)
set(ML_VERSION_STR "${ML_VERSION_STR}-SNAPSHOT")
endif()

if(${ML_VERSION_STR} MATCHES "([0-9.]+)")
set(ML_VERSION ${CMAKE_MATCH_1})
endif()
string(REPLACE "." "," ML_VERSION "${ML_VERSION}")

set(ML_PATCH "0")

execute_process(COMMAND git -c core.fileMode=false update-index -q --refresh ERROR_FILE /dev/null OUTPUT_FILE /dev/null)
execute_process(COMMAND git -c core.fileMode=false diff-index --quiet HEAD -- RESULT_VARIABLE UNCOMMITTED_CHANGES)

if(UNCOMMITED_CHANGES EQUAL 0)
set(ML_FILEFLAGS "0")
else()
set(ML_FILEFLAGS "VS_FF_PRIVATEBUILD")
endif()
set( ${_target}_LINKFLAGS ${CMAKE_CURRENT_BINARY_DIR}/${_target}.res )
set_target_properties( ${_target} PROPERTIES LINK_FLAGS ${${_target}_LINKFLAGS} )
execute_process(COMMAND bash -c "${CMAKE_SOURCE_DIR}/mk/make_rc_defines.sh ${_target}.exe" OUTPUT_VARIABLE
RC_DEFINES OUTPUT_STRIP_TRAILING_WHITESPACE)
file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/tmp.sh "rc -nologo ${CPPFLAGS} ${RC_DEFINES} -Fo${_target}.res ${CMAKE_SOURCE_DIR}/mk/ml.rc")
add_custom_target(
${_target}.res
DEPENDS ${CMAKE_SOURCE_DIR}/mk/ml.rc ${CMAKE_SOURCE_DIR}/gradle.properties ${CMAKE_SOURCE_DIR}/mk/ml.ico ${CMAKE_SOURCE_DIR}/mk/make_rc_defines.sh ${CMAKE_CURRENT_BINARY_DIR}/tmp.sh
COMMAND bash -c ${CMAKE_CURRENT_BINARY_DIR}/tmp.sh
)
add_dependencies(${_target} ${_target}.res)

set_directory_properties(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES ${CMAKE_CURRENT_BINARY_DIR}/tmp.sh)
set_directory_properties(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES ${CMAKE_CURRENT_BINARY_DIR}/${_target}.res)
if("${_target}" MATCHES ".dll$")
set(ML_FILETYPE "VFT_DLL")
else()
set(ML_FILETYPE "VFT_APP")
endif()

set(ML_FILENAME ${_target})

if(${_target} MATCHES "([^.]+).")
set(ML_NAME ${CMAKE_MATCH_1})
endif()
set(ML_YEAR ${BUILD_YEAR})
set(ML_ICON ${CMAKE_SOURCE_DIR}/mk/ml.ico)

configure_file(
"${CMAKE_SOURCE_DIR}/mk/ml.rc.in"
"${CMAKE_CURRENT_BINARY_DIR}/${ML_NAME}.rc"
@ONLY
)

set(ML_FILEFLAGS ${ML_FILEFLAGS} PARENT_SCOPE)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is OK, but it does now mean that in addition to the resource file all our C++ code is getting compiled with this extra symbol defined. I'm sure it won't be a problem as none of our source will contain this string.

It might be nicer to substitute it only into the resource file using the @ML_FILEFLAGS@ syntax. Don't bother about doing this in this PR, because we want to get the overall feature branch merged soon. But maybe you could have a look at tidying this up next week in a separate PR against the main branch.


endfunction()

#
Expand Down Expand Up @@ -95,6 +127,12 @@ function(ml_add_library _target _type)

add_compile_definitions(BUILDING_lib${_target})

if (WIN32 AND _type STREQUAL "SHARED")
ml_generate_resources(lib${_target}.dll)
list(APPEND PLATFORM_SRCS ${CMAKE_CURRENT_BINARY_DIR}/lib${_target}.rc)
add_compile_definitions(ML_FILEFLAGS=${ML_FILEFLAGS})
endif()

add_library(${_target} ${_type} ${PLATFORM_SRCS})

if(ML_LINK_LIBRARIES)
Expand Down Expand Up @@ -140,6 +178,12 @@ function(ml_add_executable _target)
add_library(Ml${_target} OBJECT ${PLATFORM_SRCS})
endif()

if (WIN32)
ml_generate_resources(${_target}.exe)
list(APPEND PLATFORM_SRCS ${CMAKE_CURRENT_BINARY_DIR}/${_target}.rc)
add_compile_definitions(ML_FILEFLAGS=${ML_FILEFLAGS})
endif()

add_executable(${_target} Main.cc ${PLATFORM_SRCS})

if (ML_EXE_LINKER_FLAGS)
Expand All @@ -150,8 +194,6 @@ function(ml_add_executable _target)

ml_install(${_target})

ml_generate_resources(${_target})

if(CMAKE_SYSTEM_NAME STREQUAL "Darwin" OR CMAKE_SYSTEM_NAME STREQUAL "Linux")
target_link_libraries(${_target} PRIVATE "${COVERAGE}")
endif()
Expand Down
11 changes: 11 additions & 0 deletions cmake/variables.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,3 +195,14 @@ if(MSVC)
set(CMAKE_SHARED_LIBRARY_PREFIX "lib")
set(CMAKE_IMPORT_LIBRARY_PREFIX "lib")
endif()

string(TIMESTAMP BUILD_YEAR "%Y")

if(WIN32)
set(ML_USER $ENV{USERNAME})
else()
execute_process(COMMAND id COMMAND awk -F ")" "{ print $1 }" COMMAND awk -F "(" "{ print $2 }" OUTPUT_VARIABLE ML_USER
OUTPUT_STRIP_TRAILING_WHITESPACE)
endif()

execute_process(COMMAND git rev-parse --short=14 HEAD OUTPUT_VARIABLE ML_BUILD_STR OUTPUT_STRIP_TRAILING_WHITESPACE)
4 changes: 4 additions & 0 deletions lib/api/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ ml_add_library(MlApi SHARED
CDataFrameTrainBoostedTreeRegressionRunner.cc
CDataFrameTrainBoostedTreeRunner.cc
CDataProcessor.cc
CDataSummarizationJsonTags.cc
CDataSummarizationJsonWriter.cc
CDetectionRulesJsonParser.cc
CFieldDataCategorizer.cc
CForecastRunner.cc
Expand All @@ -66,6 +68,8 @@ ml_add_library(MlApi SHARED
CPerPartitionCategoryIdMapper.cc
CPersistenceManager.cc
CResultNormalizer.cc
CRetrainableModelJsonReader.cc
CSerializableToJson.cc
CSimpleOutputWriter.cc
CSingleFieldDataCategorizer.cc
CSingleStreamDataAdder.cc
Expand Down
6 changes: 4 additions & 2 deletions lib/api/unittest/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ project("ML Api unit tests")

set (SRCS
Main.cc
CAnnotationJsonWriterTest.cc
CAnomalyJobConfigTest.cc
CAnomalyJobLimitTest.cc
CAnomalyJobTest.cc
Expand All @@ -26,9 +27,10 @@ set (SRCS
CDataFrameAnalyzerFeatureImportanceTest.cc
CDataFrameAnalyzerOutlierTest.cc
CDataFrameAnalyzerTrainingTest.cc
CDataFrameMockAnalysisRunner.cc
CDataFrameTrainBoostedTreeClassifierRunnerTest.cc
CDataFrameTrainBoostedTreeRegressionRunnerTest.cc
CDataFrameMockAnalysisRunner.cc
CDataSummarizationJsonSerializerTest.cc
CDetectionRulesJsonParserTest.cc
CFieldDataCategorizerTest.cc
CForecastRunnerTest.cc
Expand All @@ -40,7 +42,6 @@ set (SRCS
CMemoryUsageEstimationResultJsonWriterTest.cc
CMockDataAdder.cc
CMockSearcher.cc
CAnnotationJsonWriterTest.cc
CModelPlotDataJsonWriterTest.cc
CModelSnapshotJsonWriterTest.cc
CMultiFileDataAdderTest.cc
Expand All @@ -51,6 +52,7 @@ set (SRCS
CPersistenceManagerTest.cc
CRestorePreviousStateTest.cc
CResultNormalizerTest.cc
CSerializableToJsonTest.cc
CSingleFieldDataCategorizerTest.cc
CSingleStreamDataAdderTest.cc
CStateRestoreStreamFilterTest.cc
Expand Down
2 changes: 2 additions & 0 deletions lib/maths/analytics/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ ml_add_library(MlMathsAnalytics SHARED
CBoostedTreeHyperparameters.cc
CBoostedTreeImpl.cc
CBoostedTreeLeafNodeStatistics.cc
CBoostedTreeLeafNodeStatisticsIncremental.cc
CBoostedTreeLeafNodeStatisticsScratch.cc
CBoostedTreeLeafNodeStatisticsThreading.cc
CBoostedTreeLoss.cc
CBoostedTreeUtils.cc
Expand Down
2 changes: 2 additions & 0 deletions lib/maths/analytics/unittest/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ project("ML Maths Analytics unit tests")

set (SRCS
Main.cc
BoostedTreeTestData.cc
CBoostedTreeLeafNodeStatisticsTest.cc
CBoostedTreeLossTest.cc
CBoostedTreeTest.cc
CBoostedTreeUtilsTest.cc
CDataFrameCategoryEncoderTest.cc
CDataFrameUtilsTest.cc
CMicTest.cc
Expand Down
15 changes: 3 additions & 12 deletions lib/ver/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,10 @@
project("ML Ver")

# Prepare values to substitute into the template
string(TIMESTAMP BUILD_YEAR "%Y")

if(WIN32)
set(USER_NAME $ENV{USERNAME})
else()
execute_process(COMMAND id COMMAND awk -F ")" "{ print $1 }" COMMAND awk -F "(" "{ print $2 }" OUTPUT_VARIABLE USER_NAME
OUTPUT_STRIP_TRAILING_WHITESPACE)
endif()
set(PRODUCT_VERSION "${ML_VERSION_NUM}")

message(STATUS "PRODUCT_VERSION ${PRODUCT_VERSION}")
message(STATUS "USER_NAME ${USER_NAME}")
message(STATUS "ML_USER_NAME ${ML_USER_NAME}")
message(STATUS "BUILD_YEAR ${BUILD_YEAR}")

if(DEFINED ENV{VERSION_QUALIFIER})
Expand All @@ -33,7 +25,6 @@ endif()
if("$ENV{SNAPSHOT}" STREQUAL "yes")
set(PRODUCT_VERSION "${PRODUCT_VERSION}-SNAPSHOT")
endif()
execute_process(COMMAND git rev-parse --short=14 HEAD OUTPUT_VARIABLE ML_BUILD_NUM OUTPUT_STRIP_TRAILING_WHITESPACE)

if (CMAKE_SYSTEM_NAME STREQUAL "Windows")
execute_process(COMMAND git -c core.fileMode=false update-index -q --refresh ERROR_FILE /dev/null OUTPUT_FILE /dev/null COMMAND git -c core.fileMode=false diff-index --quiet HEAD -- RESULT_VARIABLE UNCOMMITTED_CHANGES)
Expand All @@ -50,9 +41,9 @@ set(TEMPLATE "template")

set(warning.comment "DO NOT EDIT THIS FILE - instead edit the template")
set(build.year "${BUILD_YEAR}")
set(user.name "${USER_NAME}")
set(user.name "${ML_USER}")
set(version.number "${PRODUCT_VERSION}")
set(build.number "${ML_BUILD_NUM}")
set(build.number "${ML_BUILD_STR}")
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/CBuildInfo.cc.${TEMPLATE}
${CMAKE_CURRENT_SOURCE_DIR}/CBuildInfo.cc
)
Expand Down
43 changes: 43 additions & 0 deletions mk/ml.rc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
#include <Windows.h>

1 VERSIONINFO
FILEVERSION @ML_VERSION@,@ML_PATCH@
PRODUCTVERSION @ML_VERSION@,@ML_PATCH@
FILEFLAGSMASK VS_FFI_FILEFLAGSMASK
FILEFLAGS (0 | @ML_FILEFLAGS@)
FILEOS VOS_NT_WINDOWS32
FILETYPE @ML_FILETYPE@
BEGIN
BLOCK "StringFileInfo"
BEGIN
BLOCK "080904E4"
BEGIN
#if ML_FILEFLAGS
VALUE "Comments", "Build @ML_BUILD_STR@ by @ML_USER@"
#else
VALUE "Comments", "Build @ML_BUILD_STR@"
#endif
VALUE "CompanyName", "Elasticsearch BV"
VALUE "FileDescription", "@ML_FILENAME@ (part of Elasticsearch machine learning)"
VALUE "FileVersion", "@ML_VERSION_STR@"
VALUE "InternalName", "@ML_NAME@"
VALUE "LegalCopyright", "Copyright (c) @ML_YEAR@ Elasticsearch BV"
#if 0
VALUE "LegalTrademarks", "TODO"
#endif
VALUE "OriginalFilename", "@ML_FILENAME@"
#if ML_FILEFLAGS
VALUE "PrivateBuild", "Built by @ML_USER@"
#endif
VALUE "ProductName", "Elasticsearch machine learning"
VALUE "ProductVersion", "@ML_VERSION_STR@"
END
END
BLOCK "VarFileInfo"
BEGIN
VALUE "Translation", 0x0809, 1252
END
END

2 ICON "@ML_ICON@"