Add strings with UMF version and all UMF CMake variables

Add strings with UMF version and all CMake variables
that contain the "UMF" string in the name
and do not contain the '#' character in the value.
Preprocessor definitions containing '#' cannot be passed on
to the compiler command line because many compilers do not support it.

It can be grepped in the following way:

$ strings libumf.so | grep "@(#)"
@(#) Intel(R) UMF version: 0.11.0-dev.git66.g89e3831d
@(#) Intel(R) UMF CMake variables: "UMF_VERSION_REVISION:0,..."

Signed-off-by: Lukasz Dorau <[email protected]>

Author: ldorau

src/CMakeLists.txt

@@ -11,10 +11,25 @@ set(UMF_CUDA_INCLUDE_DIR
     ""
     CACHE PATH "Directory containing the CUDA headers")
 
+# Compose the UMF_ALL_CMAKE_VARIABLES variable containing all the CMake
+# variables that contain the "UMF" string in the name and do not contain the '#'
+# character in the value. Preprocessor definitions containing '#' cannot be
+# passed on the compiler command line because many compilers do not support it.
+get_cmake_property(_variableNames VARIABLES)
+foreach(_variableName ${_variableNames})
+    if(("${_variableName}" MATCHES "UMF") AND (NOT "${${_variableName}}" MATCHES
+                                               "#"))
+        set(UMF_ALL_CMAKE_VARIABLES
+            "${_variableName}:${${_variableName}},${UMF_ALL_CMAKE_VARIABLES}")
+    endif()
+endforeach()
+
 # Compile definitions for UMF library.
 #
 # TODO: Cleanup the compile definitions across all the CMake files
-set(UMF_COMMON_COMPILE_DEFINITIONS UMF_VERSION=${UMF_VERSION})
+set(UMF_COMMON_COMPILE_DEFINITIONS
+    UMF_VERSION=${UMF_VERSION}
+    UMF_ALL_CMAKE_VARIABLES="${UMF_ALL_CMAKE_VARIABLES}")
 
 add_subdirectory(utils)
 

src/utils/utils_log.c

@@ -32,6 +32,29 @@
 #include "utils_common.h"
 #include "utils_log.h"
 
+#define UMF_VERSION_MAGIC_STR "\x00@(#) "
+#define UMF_VERSION_PREF_STR "Intel(R) "
+#define UMF_VERSION_PREFIX UMF_VERSION_MAGIC_STR UMF_VERSION_PREF_STR
+
+// convert a define to a C string
+#define STR_(X) #X
+#define STR(X) STR_(X)
+
+#ifdef UMF_VERSION
+#define STR_UMF_VERSION "UMF version: " STR(UMF_VERSION)
+#define LOG_STR_UMF_VERSION STR_UMF_VERSION ", "
+char const __umf_str_2_version[] = UMF_VERSION_PREFIX STR_UMF_VERSION;
+#else /* !UMF_VERSION */
+#error "UMF_VERSION not defined!"
+#endif /* !UMF_VERSION */
+
+#ifdef UMF_ALL_CMAKE_VARIABLES
+char const __umf_str_1__all_cmake_vars[] =
+    UMF_VERSION_PREFIX "UMF CMake variables: " STR(UMF_ALL_CMAKE_VARIABLES);
+#else /* !UMF_ALL_CMAKE_VARIABLES */
+#error "UMF_ALL_CMAKE_VARIABLES not defined!"
+#endif /* !UMF_ALL_CMAKE_VARIABLES */
+
 #define LOG_MAX 8192
 #define LOG_HEADER 256
 #define MAX_FILE_PATH 256
@@ -305,17 +328,8 @@ void utils_log_init(void) {
         loggerConfig.flushLevel = LOG_FATAL;
     }
 
-#ifdef UMF_VERSION
-// convert a define to a C string
-#define STR_(X) #X
-#define STR(X) STR_(X)
-#define STR_UMF_VERSION "UMF version: " STR(UMF_VERSION) ", "
-#else /* !UMF_VERSION */
-#error "UMF_VERSION not defined!"
-#endif /* !UMF_VERSION */
-
     LOG_INFO(
-        "Logger enabled (" STR_UMF_VERSION
+        "Logger enabled (" LOG_STR_UMF_VERSION
         "level: %s, flush: %s, pid: %s, timestamp: %s)",
         level_to_str(loggerConfig.level), level_to_str(loggerConfig.flushLevel),
         bool_to_str(loggerConfig.pid), bool_to_str(loggerConfig.timestamp));

test/utils/utils_log.cpp

@@ -110,6 +110,9 @@ const char *env_variable = "";
 #ifndef UMF_VERSION
 #define UMF_VERSION "test version"
 #endif
+#ifndef UMF_ALL_CMAKE_VARIABLES
+#define UMF_ALL_CMAKE_VARIABLES "test UMF_ALL_CMAKE_VARIABLES"
+#endif
 #include "utils/utils_log.c"
 #undef utils_env_var
 #undef fopen