New patch attached. Apologies for the delay. I had to work on something else
temporarily but am now free to hack on compilers once more - hooray!.
For the benefit of cfe-commits who I've just added, this patch adds a
VERSIONINFO resource to .exe and .dll files when we build LLVM with MSVC. The
most visible place that you can find Windows version information is by looking
at the file properties in Windows Explorer under the details tab. It's also
embedded into minidump .dmp files (a subsequent change that I plan to submit
will add the capability of automatically generating these files in the case of
crashes on Windows).
As suggested I separated the part that fixed an issue with the Ninja builder
into another patch which was committed at r232727.
I've split the CMake function from the original patch into 2 functions now.
The first just adds the resource script file to the current project if we're
building with MSVC. The second checks whether the resource script exists in
the current project and sets preprocessor macros for that file containing the
version information to embed if it does. There are a couple of reasons for
splitting it. Firstly, we need to add the resource script file to the project
sources before the target has been created, but in order to populate the
'OriginalFilename' field we need the target location which only exists once the
target has been created. Secondly, it means that we can call the
'set_windows_version_resource_properties' function from specific subproject
CMakelists files to override the default values if necessary.
By default we're setting the FILEVERSION field with the following values from
CMake:
LLVM_VERSION_MAJOR, LLVM_VERSION_MINOR, LLVM_VERSION_PATCH, 0
The "FileVersion" and "ProductVersion" fields which are strings get set to the
value of PACKAGE_VERSION.
The "OriginalFilename" field gets set with the name of the exe or DLL file that
the project creates. Note that this means that files such as clang++.exe or
clang-cl.exe will still get the string 'clang.exe' in this field as they are
just copies of clang.exe. "InternalName" as per the Microsoft documentation
suggestion gets set to the filename string without the extension (so 'clang' in
the above cases). I've set 'ProductName' to 'LLVM' by default.
I'll followup with a separate clang patch very shortly that overrides the LLVM
version numbers with the clang equivalent ones and sets 'ProductName' to
'clang' when building projects that come from tools/clang. I'm happy to
bikeshed on the strings that particular fields should get as long as the
general approach is considered acceptable.
Thanks,
Greg
http://reviews.llvm.org/D7828
Files:
cmake/modules/AddLLVM.cmake
resources/windows_version_resource.rc
EMAIL PREFERENCES
http://reviews.llvm.org/settings/panel/emailpreferences/
Index: cmake/modules/AddLLVM.cmake
===================================================================
--- cmake/modules/AddLLVM.cmake
+++ cmake/modules/AddLLVM.cmake
@@ -228,6 +228,76 @@
endif()
endfunction()
+# If on Windows and building with MSVC, add the resource script containing the
+# VERSIONINFO data to the project. This embeds version resource information
+# into the output .exe or .dll.
+function(add_windows_version_resource_file OUT_VAR)
+ set(sources ${ARGN})
+ if (MSVC)
+ set(resource_file ${LLVM_SOURCE_DIR}/resources/windows_version_resource.rc)
+ set(sources ${sources} ${resource_file})
+ source_group("Resource Files" ${resource_file})
+ set(windows_resource_file ${resource_file} PARENT_SCOPE)
+ endif(MSVC)
+
+ set(${OUT_VAR} ${sources} PARENT_SCOPE)
+endfunction(add_windows_version_resource_file)
+
+# set_windows_version_resource_properties(name resource_file...
+# VERSION_MAJOR int
+# Optional major version number (defaults to LLVM_VERSION_MAJOR)
+# VERSION_MINOR int
+# Optional minor version number (defaults to LLVM_VERSION_MINOR)
+# VERSION_PATCHLEVEL int
+# Optional patchlevel version number (defaults to LLVM_VERSION_PATCH)
+# VERSION_STRING
+# Optional version string (defaults to PACKAGE_VERSION)
+# PRODUCT_NAME
+# Optional product name string (defaults to "LLVM")
+# )
+function(set_windows_version_resource_properties name resource_file)
+ cmake_parse_arguments(ARG
+ ""
+ "VERSION_MAJOR;VERSION_MINOR;VERSION_PATCHLEVEL;VERSION_STRING;PRODUCT_NAME"
+ ""
+ ${ARGN})
+
+ if (NOT DEFINED ARG_VERSION_MAJOR)
+ set(ARG_VERSION_MAJOR ${LLVM_VERSION_MAJOR})
+ endif()
+
+ if (NOT DEFINED ARG_VERSION_MINOR)
+ set(ARG_VERSION_MINOR ${LLVM_VERSION_MINOR})
+ endif()
+
+ if (NOT DEFINED ARG_VERSION_PATCHLEVEL)
+ set(ARG_VERSION_PATCHLEVEL ${LLVM_VERSION_PATCH})
+ endif()
+
+ if (NOT DEFINED ARG_VERSION_STRING)
+ set(ARG_VERSION_STRING ${PACKAGE_VERSION})
+ endif()
+
+ if (NOT DEFINED ARG_PRODUCT_NAME)
+ set(ARG_PRODUCT_NAME "LLVM")
+ endif()
+
+ get_target_property(target_location ${name} LOCATION)
+ get_filename_component(target_filename ${target_location} NAME)
+
+ set_property(SOURCE ${resource_file}
+ PROPERTY COMPILE_DEFINITIONS
+ "RC_VERSION_FIELD_1=${ARG_VERSION_MAJOR}"
+ "RC_VERSION_FIELD_2=${ARG_VERSION_MINOR}"
+ "RC_VERSION_FIELD_3=${ARG_VERSION_PATCHLEVEL}"
+ "RC_VERSION_FIELD_4=0"
+ "RC_FILE_VERSION=\"${ARG_VERSION_STRING}\""
+ "RC_INTERNAL_NAME=\"${name}\""
+ "RC_ORIGINAL_FILENAME=\"${target_filename}\""
+ "RC_PRODUCT_NAME=\"${ARG_PRODUCT_NAME}\""
+ "RC_PRODUCT_VERSION=\"${ARG_VERSION_STRING}\"")
+endfunction(set_windows_version_resource_properties)
+
# llvm_add_library(name sources...
# SHARED;STATIC
# STATIC by default w/o BUILD_SHARED_LIBS.
@@ -316,10 +386,17 @@
if(ARG_MODULE)
add_library(${name} MODULE ${ALL_FILES})
elseif(ARG_SHARED)
+ add_windows_version_resource_file(ALL_FILES ${ALL_FILES})
add_library(${name} SHARED ${ALL_FILES})
else()
add_library(${name} STATIC ${ALL_FILES})
endif()
+
+ if(DEFINED windows_resource_file)
+ set_windows_version_resource_properties(${name} ${windows_resource_file})
+ set(windows_resource_file ${windows_resource_file} PARENT_SCOPE)
+ endif()
+
set_output_directory(${name} ${LLVM_RUNTIME_OUTPUT_INTDIR} ${LLVM_LIBRARY_OUTPUT_INTDIR})
llvm_update_compile_flags(${name})
add_link_opts( ${name} )
@@ -482,11 +559,18 @@
macro(add_llvm_executable name)
llvm_process_sources( ALL_FILES ${ARGN} )
+ add_windows_version_resource_file(ALL_FILES ${ALL_FILES})
+
if( EXCLUDE_FROM_ALL )
add_executable(${name} EXCLUDE_FROM_ALL ${ALL_FILES})
else()
add_executable(${name} ${ALL_FILES})
endif()
+
+ if(DEFINED windows_resource_file)
+ set_windows_version_resource_properties(${name} ${windows_resource_file})
+ endif()
+
llvm_update_compile_flags(${name})
add_link_opts( ${name} )
Index: resources/windows_version_resource.rc
===================================================================
--- /dev/null
+++ resources/windows_version_resource.rc
@@ -0,0 +1,178 @@
+// Microsoft Visual C++ resource script for embedding version information.
+// The format is described at:
+// http://msdn.microsoft.com/en-gb/library/windows/desktop/aa380599(v=vs.85).aspx
+// The VERSIONINFO resource is described at:
+// https://msdn.microsoft.com/en-gb/library/windows/desktop/aa381058(v=vs.85).aspx
+
+
+// Default values for required fields.
+
+#ifndef RC_VERSION_FIELD_1
+#define RC_VERSION_FIELD_1 0
+#endif
+
+#ifndef RC_VERSION_FIELD_2
+#define RC_VERSION_FIELD_2 0
+#endif
+
+#ifndef RC_VERSION_FIELD_3
+#define RC_VERSION_FIELD_3 0
+#endif
+
+#ifndef RC_VERSION_FIELD_4
+#define RC_VERSION_FIELD_4 0
+#endif
+
+#ifndef RC_COMPANY_NAME
+#define RC_COMPANY_NAME ""
+#endif
+
+#ifndef RC_FILE_DESCRIPTION
+#define RC_FILE_DESCRIPTION ""
+#endif
+
+#ifndef RC_FILE_VERSION
+#define RC_FILE_VERSION ""
+#endif
+
+#ifndef RC_INTERNAL_NAME
+#define RC_INTERNAL_NAME ""
+#endif
+
+#ifndef RC_ORIGINAL_FILENAME
+#define RC_ORIGINAL_FILENAME ""
+#endif
+
+#ifndef RC_PRODUCT_NAME
+#define RC_PRODUCT_NAME ""
+#endif
+
+#ifndef RC_PRODUCT_VERSION
+#define RC_PRODUCT_VERSION ""
+#endif
+
+
+1 VERSIONINFO
+FILEVERSION RC_VERSION_FIELD_1,RC_VERSION_FIELD_2,RC_VERSION_FIELD_3,RC_VERSION_FIELD_4
+BEGIN
+ BLOCK "StringFileInfo"
+ BEGIN
+ BLOCK "040904B0"
+ BEGIN
+ // Required strings
+ VALUE "CompanyName", RC_COMPANY_NAME
+ VALUE "FileDescription", RC_FILE_DESCRIPTION
+ VALUE "FileVersion", RC_FILE_VERSION
+ VALUE "InternalName", RC_INTERNAL_NAME
+ VALUE "OriginalFilename", RC_ORIGINAL_FILENAME
+ VALUE "ProductName", RC_PRODUCT_NAME
+ VALUE "ProductVersion", RC_PRODUCT_VERSION
+
+ // Optional strings
+#ifdef RC_COMMENTS
+ VALUE "Comments", RC_COMMENTS
+#endif
+
+#ifdef RC_COPYRIGHT
+ VALUE "LegalCopyright", RC_COPYRIGHT
+#endif
+ END
+ END
+
+ BLOCK "VarFileInfo"
+ BEGIN
+ // The translation must correspond to the above BLOCK inside StringFileInfo
+ // langID 0x0409 U.S. English
+ // charsetID 0x04B0 Unicode
+ VALUE "Translation", 0x0409, 0x04B0
+ END
+END
+// Microsoft Visual C++ resource script for embedding version information.
+// The format is described at:
+// http://msdn.microsoft.com/en-gb/library/windows/desktop/aa380599(v=vs.85).aspx
+// The VERSIONINFO resource is described at:
+// https://msdn.microsoft.com/en-gb/library/windows/desktop/aa381058(v=vs.85).aspx
+
+
+// Default values for required fields.
+
+#ifndef RC_VERSION_FIELD_1
+#define RC_VERSION_FIELD_1 0
+#endif
+
+#ifndef RC_VERSION_FIELD_2
+#define RC_VERSION_FIELD_2 0
+#endif
+
+#ifndef RC_VERSION_FIELD_3
+#define RC_VERSION_FIELD_3 0
+#endif
+
+#ifndef RC_VERSION_FIELD_4
+#define RC_VERSION_FIELD_4 0
+#endif
+
+#ifndef RC_COMPANY_NAME
+#define RC_COMPANY_NAME ""
+#endif
+
+#ifndef RC_FILE_DESCRIPTION
+#define RC_FILE_DESCRIPTION ""
+#endif
+
+#ifndef RC_FILE_VERSION
+#define RC_FILE_VERSION ""
+#endif
+
+#ifndef RC_INTERNAL_NAME
+#define RC_INTERNAL_NAME ""
+#endif
+
+#ifndef RC_ORIGINAL_FILENAME
+#define RC_ORIGINAL_FILENAME ""
+#endif
+
+#ifndef RC_PRODUCT_NAME
+#define RC_PRODUCT_NAME ""
+#endif
+
+#ifndef RC_PRODUCT_VERSION
+#define RC_PRODUCT_VERSION ""
+#endif
+
+
+1 VERSIONINFO
+FILEVERSION RC_VERSION_FIELD_1,RC_VERSION_FIELD_2,RC_VERSION_FIELD_3,RC_VERSION_FIELD_4
+BEGIN
+ BLOCK "StringFileInfo"
+ BEGIN
+ BLOCK "040904B0"
+ BEGIN
+ // Required strings
+ VALUE "CompanyName", RC_COMPANY_NAME
+ VALUE "FileDescription", RC_FILE_DESCRIPTION
+ VALUE "FileVersion", RC_FILE_VERSION
+ VALUE "InternalName", RC_INTERNAL_NAME
+ VALUE "OriginalFilename", RC_ORIGINAL_FILENAME
+ VALUE "ProductName", RC_PRODUCT_NAME
+ VALUE "ProductVersion", RC_PRODUCT_VERSION
+
+ // Optional strings
+#ifdef RC_COMMENTS
+ VALUE "Comments", RC_COMMENTS
+#endif
+
+#ifdef RC_COPYRIGHT
+ VALUE "LegalCopyright", RC_COPYRIGHT
+#endif
+ END
+ END
+
+ BLOCK "VarFileInfo"
+ BEGIN
+ // The translation must correspond to the above BLOCK inside StringFileInfo
+ // langID 0x0409 U.S. English
+ // charsetID 0x04B0 Unicode
+ VALUE "Translation", 0x0409, 0x04B0
+ END
+END
\ No newline at end of file
_______________________________________________
cfe-commits mailing list
[email protected]
http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits
